14.32. Jobs Status RPC

Requests the status of a known job by its identifier.

rpc Cancel (JobsStatusRequest) returns (JobsStatusResponse)

14.32.1. Messages

  • JobsStatusRequest

  • JobsStatusResponse


14.33. JobsStatusRequest

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

14.33.1. Properties

14.33.1.2. job_id

type: message

Unique identifier of the job status is requested for.

See Identifier for details.


14.34. JobsStatusResponse

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;
}

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.

14.34.1. Properties

14.34.1.1. header

type: message

Standard RPC response header.

See ResponseHeader for details.

14.34.1.1.1. job_id

type: message

Unique identifier of the job status is being reported on.

See Identifier for details.

14.34.1.2. pipeline_id

type: message

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

See Identifier for details.

14.34.1.3. payload_id

type: message

Unique identifier of the payload the job is assigned to.

See Identifier for details.

14.34.1.4. state

type: enum

Current state of the job.

See JobState for details.

14.34.1.5. status

type: enum

Current status of the job.

See JobStatus for details.

14.34.1.6. name

type: string

Human readable name of the job.

14.34.1.7. messages

type: repeated string

List of messages reported by the job.