Jobs Status RPC

0.7.4

Requests the status of a known job by its identifier.

rpc Status (JobsStatusRequest) returns (JobsStatusResponse)

Messages

  • JobsStatusRequest
  • JobsStatusResponse
Copy
Copied!
            

message JobsStatusRequest { RequestHeader header = 1; Identifier job_id = 2; }


The timestamps reported by the status of pipelines that rely on Argo workflow orchestration are invalid. Clara Platform does not track times related to pipelines that rely on Argo workflow orchestration.

Properties

type: message

Standard RPC request header.

See RequestHeader for details.

job_id

type: message

Unique identifier of the job status is requested for.

See Identifier for details.

Copy
Copied!
            

message JobsStatusResponse{ RequestHeader header = 1; Identifier job_id = 2; Identifier pipeline_id = 3; Identifier payload_id = 4; JobState state = 5; JobStatus status = 6; string name = 7; repeated string messages = 8; JobPriority priority = 9; string timestamp_created = 10; string timestamp_started = 11; string timestamp_stopped = 12; }


Clara Deploy SDK Jobs service will respond to any status request with a JobsStatusResponse message. Requestors can use the response message to determine the result of their request.

Properties

header

type: message

Standard RPC response header.

See ResponseHeader for details.

job_id

type: message

Unique identifier of the job status is being reported on.

See Identifier for details.

pipeline_id

type: message

Unique identifier of the pipeline the job is an instance of.

See Identifier for details.

payload_id

type: message

Unique identifier of the payload the job is assigned to.

See Identifier for details.

state

type: enum

Current state of the job.

See JobState for details.

status

type: enum

Current status of the job.

See JobStatus for details.

name

type: string

Human readable name of the job.

messages

type: repeated string

List of messages reported by the job.

priority

type: enum

Priority of the job.

timestamp_created

type: string

Timestamp describing when the job was created.

UTC formatted string; UTC+00:00 time zone.

timestamp_started

type: string

Timestamp describing when the job was started.

UTC formatted string; UTC+00:00 time zone.

timestamp_stopped

type: string

Timestamp describing when the job was stopped.

UTC formatted string; UTC+00:00 time zone.

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