17.46. Jobs Status RPC¶
Requests the status of a known job by its identifier.
rpc Status (JobsStatusRequest) returns (JobsStatusResponse);
17.46.1. Messages¶
- JobsStatusRequest
- JobsStatusResponse
17.47. JobsStatusRequest¶
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.
17.47.1. Properties¶
17.47.1.2. job_id¶
type: message
Unique identifier of the job status is requested for.
See Identifier for details.
17.48. JobsStatusResponse¶
message JobsStatusResponse { ResponseHeader header = 1; Identifier job_id = 2; Identifier pipeline_id = 3; Identifier payload_id = 4; JobState state = 5; JobStatus status = 6; string name = 7; JobPriority priority = 9; Timestamp created = 13; Timestamp started = 14; Timestamp stopped = 15; repeated JobOperatorDetails operator_details = 16; map<string, string> metadata = 17; 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.
17.48.1. Properties¶
17.48.1.1. header¶
type: message
Standard RPC response header.
See ResponseHeader for details.
17.48.1.1.1. job_id¶
type: message
Unique identifier of the job status is being reported on.
See Identifier for details.
17.48.1.2. pipeline_id¶
type: message
Unique identifier of the pipeline the job is an instance of.
See Identifier for details.
17.48.1.3. payload_id¶
type: message
Unique identifier of the payload the job is assigned to.
See Identifier for details.
17.48.1.8. created¶
type: message
Timestamp describing when the job was created.
See Timestamp for details.
17.48.1.9. started¶
type: message
Timestamp describing when the job was started.
See Timestamp for details.
17.48.1.10. stopped¶
type: message
Timestamp describing when the job was stopped.
See Timestamp for details.
17.48.1.11. operator_details¶
type: list
List of operators with associated status details associated with the job.
See JobOperatorStatus for details.
17.48.1.12. metadata¶
type: map
Metadata (set of key/value pairs) associated with the job.
Key and Value are string types.