17.14. Pipelines List RPC¶
Requests a listing of all pipelines known by the service.
rpc List (PipelinesListRequest) returns (stream PipelinesListResponse);
17.14.1. Messages¶
PipelinesListRequest
PipelinesListResponse
PipelineDetails
17.15. PipelinesListRequest¶
message PipelinesListRequest { RequestHeader header = 1; }
17.15.1. Properties¶
17.16. PipelinesListResponse¶
message PipelinesListResponse { message PipelineDetails { Identifier pipeline_id = 1; string name = 2; } ResponseHeader header = 1; PipelineDetails details = 2; }
Clara Deploy SDK Pipelines service will respond to any list request with a PipelinesListResponse message. Requestors can use the response message to determine the result of their request.
17.16.1. Properties¶
17.16.1.1. header¶
type: message
Standard RPC response header.
Note that this response is streamed. Only the first chunk recieved is guaranteed to contain a header value.
See ResponseHeader for details.
17.16.1.2. details¶
type: message
A pipeline in the list known by the server.
Note that this response is streamed, with a separate response chunk per pipeline being listed.
See PipelineDetails for details.
17.17. PipelineDetails¶
message PipelineDetails { Identifier pipeline_id = 1; string name = 2; }
17.17.1. Properties¶
17.17.1.1. pipeline_id¶
type: message
Unique identifier of the pipeline.
See Identifier for details.