Payloads Delete RPC
Requests the deletion of a known payload by its identifier.
rpc Delete (PayloadsDeleteRequest) returns (PayloadsDeleteResponse);
Messages
- PayloadsDeleteRequest
- PayloadsDeleteResponse
message PayloadsDeleteRequest {
RequestHeader header = 1;
Identifier payload_id = 2;
}
Properties
header
type: message
Standard RPC request header.
See RequestHeader for details.
payload_id
type: message
Unique identifier of the payload to delete.
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.
PayloadsDeleteResponse
message PipelineDeleteResponse {
ResponseHeader header = 1;
}
Clara Deploy SDK Payloads service will respond to any delete request with a PayloadsDeleteResponse 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.