14.39. Payloads Details RPC

Requests the details (file listing) of a known payload by its identifier.

rpc Details (PayloadsDetailsRequest) returns (stream PayloadsDetailsResponse)

14.39.1. Messages

  • PayloadsDetailsRequest

  • PayloadsDetailsRequest


14.40. PayloadsDetailsRequest

message PayloadsDetailsRequest {
  RequestHeader header = 1;
  Identifier payload_id = 2;
}

14.40.1. Properties

14.40.1.2. payload_id

type: message

Unique identifier of the payload to query.

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.


14.41. PayloadsDetailsResponse

message PipelineDetailsResponse {
  ResponseHeader header = 1;
  Identifier payload_id = 2;
  PayloadFileDetails file = 3;
}

Clara Deploy SDK Payloads service will respond to any details request with a PayloadsDetailsResponse message. Requestors can use the response message to determine the result of their request.

14.41.1. Properties

14.41.1.1. header

type: message

Standard RPC response header.

See ResponseHeader for details.

14.41.1.2. payload_id

type: message

Unique identifier of the payload.

See Identifier for details.

14.41.1.3. file

type: message

Details of a file contained in the payload.

Note that this response is streamed. The response will contain one chunk for each file in the payload.

See PayloadFileDetails for details.