IBMCompositeJob.status#

IBMCompositeJob.status()[source]#

Query the server for the latest job status.

Note

This method is not designed to be invoked repeatedly in a loop for an extended period of time. Doing so may cause the server to reject your request. Use wait_for_final_state() if you want to wait for the job to finish.

Note

If the job failed, you can use error_message() to get more information.

Note

Since this job contains multiple sub-jobs, the returned status is mapped in the following order:

  • INITIALIZING - if any sub-job is being initialized.

  • VALIDATING - if any sub-job is being validated.

  • QUEUED - if any sub-job is queued.

  • RUNNING - if any sub-job is still running.

  • ERROR - if any sub-job incurred an error.

  • CANCELLED - if any sub-job is cancelled.

  • DONE - if all sub-jobs finished.

Return type:

JobStatus

Returns:

The status of the job.

Raises:

IBMJobApiError – If an unexpected error occurred when communicating with the server.