BaseJob.wait_for_final_state

BaseJob.wait_for_final_state(timeout=None, wait=5, callback=None)[source]

Poll the job status until it progresses to a final state such as DONE or ERROR.

Parameters

  • timeout (Optional[float]) – Seconds to wait for the job. If None, wait indefinitely.

  • wait (float) – Seconds between queries.

  • callback (Optional[Callable]) –

    Callback function invoked after each query. The following positional arguments are provided to the callback function:

    • job_id: Job ID

    • job_status: Status of the job from the last query

    • job: This BaseJob instance

    Note: different subclass might provide different arguments to the callback function.

Raises

JobTimeoutError – If the job does not reach a final state before the specified timeout.

Return type

None