17.16. Pipelines Details RPC

Requests details of a pipeline.

rpc Details (PipelinesDetailsRequest) returns (stream PipelinesDetailsResponse);

17.16.1. Messages

  • PipelinesDetailsRequest
  • PipelinesDetailsResponse

17.17. PipelinesDetailsRequest

message PipelinesDetailsRequest {
  RequestHeader header = 1;
  Identifier pipeline_id = 2;
}

17.17.1. Properties

17.17.1.2. pipeline_id

type: message

Unique identifier of the pipeline.

Required. If the identifier value is omitted from the request or does not match any known pipeline identifier, Clara Deploy SDK will be unable to fulfill the request.

See Identifier for details.


17.18. PipelinesDetailsResponse

message PipelineDetailsResponse {
  ResponseHeader header = 1;
  Identifier pipeline_id = 2;
  string name = 3;
  PipelineDefinitionFile definition = 4;
  repeated PipelineDagNode dag = 5;
  map<string, string> metadata = 6;
}

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

17.18.1. Properties

17.18.1.1. header

type: message

Standard RPC response header.

See ResponseHeader for details.

17.18.1.2. pipeline_id

type: message

Unique identifier of the pipeline.

See Identifier for details.

17.18.1.3. name

type: string

Human readable name of the pipeline.

17.18.1.4. definition

type: message

A file in the definition of the pipeline.

Note that this request is streamed to allow large pipeline definitions beyond the limits of a single GRPC message size. In the case of large pipelines, parts of the pipeline definition may be chunked into multiple parts such that the server will concatenate all parts having the same name into a single file server-side.

See PipelineDefinitionFile for details.

17.18.1.5. dag

type: repeated message

A directed acyclic graph [DAG] representing the execution of the pipeline. Repeated element because pipeline DAG can start or end with as many nodes as necessary.

See PipelineDagNode for details.

17.18.1.6. metadata

type: map

Metadata (set of key/value pairs) associated with the pipeline.

Key and Value are string types.