Payloads AddMetadata RPC
Requests the addition of metadata to a payload.
rpc AddMetadata (PayloadsAddMetadataRequest) returns (PayloadsAddMetadataResponse)
Messages
- PayloadsAddMetadataRequest
- PayloadsAddMetadataResponse
message PayloadsAddMetadataRequest {
ResponseHeader header = 1;
Identifier payload_id = 2;
map<string, string> metadata = 3;
}
Properties
header
type: message
Standard RPC request header.
See RequestHeader for details.
payload_id
type: message
Unique identifier of the payload whose metadata is to be appended.
Required. If the identifier value is omitted from the request or does not match any known payload identifier, Clara Deploy SDK will be unable to fulfill the request.
See Identifier for details.
metadata
type: map
Set of key/value pairs to be appended to the payload metadata.
Key and value are string types.
If a metadata key in the request already exists in the payload record, or if duplicate keys are passed in the request, the payload will not be updated 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 payload is 4 Megabytes.
Metadata is only supported for reusable payloads. Metadata is not supported for pipeline payloads.
message PayloadAddMetadataResponse {
ResponseHeader header = 1;
Identifier payload_id = 2;
map<string, string> metadata = 3;
}
Clara Deploy SDK Payloads service will respond to any add metadata request with a PayloadsAddMetadataResponse message. Requestors can use the response message to determine the result of their request.
Properties
header
type: message
Standard RPC response header.
See ResponseHeader for details.
payload_id
type: message
Unique identifier of the payload whose metadata is to be appended.
See Identifier for details.
metadata
type: map
Metadata (set of all key/value pairs) of the payload after adding the metadata in the payload record.