18.56. Payloads Create RPC

Requests the creation of a new payload of PAYLOAD_TYPE_REUSABLE.

See PayloadType for additional details.

rpc Create(PayloadsCreateRequest) returns (PayloadsCreateResponse);

18.56.1. Messages

  • PayloadsCreateRequest

  • PayloadsCreateResponse


18.57. PayloadsCreateRequest

message PayloadsCreateRequest {
  RequestHeader header = 1;
  map<string, string> metadata = 2;
}

18.57.1. Properties

18.57.2. metadata

type: map

Metadata (set of key/value pairs) associated with the job.

Key and value are string types.

If duplicate keys are passed in the request, the job will not be created and and an error will be returned.

Keys are compared using case insensitive comparator functions.

The maximum allowed size of a metadata key is 128 bytes, while the maximum allowed size of a metadata value is 256 bytes.

The maximum allowed size for the overall metadata of an individual job is 4 Megabytes.

Metadata is only supported for reusable payloads. Metadata is not supported for pipeline payloads.


18.57.2.1. PayloadsCreateResponse

message PayloadsCreateResponse {
  ResponseHeader header = 1;
  Identifier payload_id = 2;
  PayloadType type = 5;
}

Clara Deploy SDK Models service will respond to any delete request with a ModelsListModelsResponse message. Requestors can use the response header to determine the result of their request.

18.57.3. Properties

18.57.3.1. header

type: message

Standard RPC response header.

See ResponseHeader for details.

18.57.3.2. payload_id

type: message

Unique identifier of the new payload.

See Identifier for additional details.

18.57.3.3. type

type: enum

Type of the payload.

See PayloadType for additional details.