14.8. Pipelines List RPC

Requests a listing of all pipelines known by the service.

rpc List (PipelinesListRequest) returns (stream PipelinesListResponse)

14.8.1. Messages

  • PipelinesListRequest

  • PipelinesListResponse

  • PipelineDetails


14.9. PipelinesListRequest

message PipelinesListRequest {
  RequestHeader header = 1;
}

14.9.1. Properties


14.10. 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.

14.10.1. Properties

14.10.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.

14.10.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.


14.11. PipelineDetails

message PipelineDetails {
  Identifier pipeline_id = 1;
  string name = 2;
}

14.11.1. Properties

14.11.1.1. pipeline_id

type: message

Unique identifier of the pipeline.

See Identifier for details.

14.11.1.2. name

type: string

Human readable name of the pipeline.