citrine.jobs.job module
- class citrine.jobs.job.JobStatusResponse
Bases:
Resource[JobStatusResponse]A response to a job status check.
The JobStatusResponse summarizes the status for the entire job.
- access_control_dict() dict
Return an access control entity representation of this resource. Internal use only.
- classmethod build(data: dict) Self
Build an instance of this object from given data.
- dump() dict
Dump this instance.
- job_type = None
the type of job for this status report
- Type:
str
- output = None
job output properties and results
- Type:
Optional[dict[str, str]]
- status = None
The status of the job. One of “Running”, “Success”, or “Failure”.
- Type:
str
- class citrine.jobs.job.JobSubmissionResponse
Bases:
Resource[JobSubmissionResponse]A response to a submit-job request for the job submission framework.
This is returned as a successful response from the remote service.
- access_control_dict() dict
Return an access control entity representation of this resource. Internal use only.
- classmethod build(data: dict) Self
Build an instance of this object from given data.
- dump() dict
Dump this instance.
- job_id = None
job id of the job submission request
- Type:
UUID
- class citrine.jobs.job.TaskNode
Bases:
Resource[TaskNode]Individual task status.
The TaskNode describes a component of an overall job.
- access_control_dict() dict
Return an access control entity representation of this resource. Internal use only.
- classmethod build(data: dict) Self
Build an instance of this object from given data.
- dump() dict
Dump this instance.
- dependencies = None
all the tasks that this task is dependent on
- Type:
Set[str]
- failure_reason = None
if a task has failed, the failure reason will be in this parameter
- Type:
str
- id = None
unique identification number for the job task
- Type:
str
- status = None
The last reported status of this particular task. One of “Submitted”, “Pending”, “Running”, “Success”, or “Failure”.
- Type:
str
- task_type = None
the type of task running
- Type:
str