19.19. Pipelines List RPC

Requests a listing of all pipelines known by the service.

rpc List (PipelinesListRequest) returns (stream PipelinesListResponse);

19.19.1. Messages

  • PipelinesListRequest
  • PipelinesListResponse
  • PipelineDetails
Copy
Copied!
            

message PipelinesListRequest { RequestHeader header = 1; }


19.20.1. Properties

type: message

Standard RPC request header.

See RequestHeader for details.

Copy
Copied!
            

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.

19.21.1. Properties

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

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

Copy
Copied!
            

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


19.22.1. Properties

19.22.1.1. pipeline_id

type: message

Unique identifier of the pipeline.

See Identifier for details.

19.22.1.2. name

type: string

Human readable name of the pipeline.

© Copyright 2018-2020, NVIDIA Corporation. All rights reserved. Last updated on Jun 28, 2023.