Payloads RemoveMetadata RPC

Requests the removal of metadata from a payload.

Messages

• PayloadsRemoveMetadataRequest

• PayloadsRemoveMetadataResponse

            

            
message PayloadsRemoveMetadataRequest {
  ResponseHeader header = 1;
  Identifier payload_id = 2;
  repeated string keys = 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 updated.

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.

keys

type: repeated string

List of keys to be removed from the payload metadata.

Key is a string type.

            

            
message PayloadRemoveMetadataResponse {
  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 PayloadsRemoveMetadataResponse 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 updated.

See Identifier for details.

metadata

type: map

Metadata (set of all key/value pairs) of the payload after removing the specified keys from the payload record.