NVIDIA Clara Deploy SDK User Guide
1.0

19.39. Jobs ReadLogs RPC

Requests that logs for a job operator be downloaded.

rpc ReadLogs(JobsReadLogsRequest) returns (stream JobsReadLogsResponse);

19.39.1. Messages

  • JobsReadLogsRequest
  • JobsReadLogsResponse
Copy
Copied!
            

message JobsReadLogsRequest { RequestHeader header = 1; Identifier job_id = 2; string operator_name = 3; }


19.40.1. Properties

type: message

A standard RPC request header

See RequestHeader for details.

19.40.1.2. job_id

type: message

A unique identifier of the job for which the operator logs are requested

Required value: 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.

19.40.1.3. operator_name

type: string

A unqiue name (within the job) for the operator whose logs are requested. For Clara orchestrated jobs, Pod Manager logs can also be requested by using “clara-pod-manager” as the operator_name.

Required value: If the operator name is omitted from the request or does not match any known operator name in the job, Clara Deploy SDK will be unable to fulfill the request.

Copy
Copied!
            

message JobsReadLogsResponse { ResponseHeader header = 1; Identifier job_id = 2; string operator_name = 3; repeated string logs = 4; }


The Clara Deploy SDK Jobs service will respond to any read-logs request with a JobsReadLogsResponse message. Requestors can use the response message to determine the result of their request.

19.41.1. Properties

19.41.1.1. header

type: message

A standard RPC request header

See RequestHeader for details.

19.41.1.2. job_id

type: message

A unique identifier for the job whose operator logs are requested

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.

19.41.1.3. operator_name

type: string

A unqiue name (within the job) of the operator whose logs are requested

Required. If the operator name is omitted from the request or does not match any known operator name in the job, Clara Deploy SDK will be unable to fulfill the request.

19.41.1.4. logs

type: repeated string

The logs of the operator in the job

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