AlgorithmJob

Default value: 1

backend()

Return the backend where this job was executed.

Return type

Backend

cancel()

Attempt to cancel the job.

cancelled()

Return whether the job has been cancelled.

Return type

bool

done()

Return whether the job has successfully run.

Return type

bool

in_final_state()

Return whether the job is in a final job state such as DONE or ERROR.

Return type

bool

job_id()

Return a unique id identifying the job.

Return type

str

result()

Return the results of the job.

Return type

T

running()

Return whether the job is actively running.

Return type

bool

status()

Return the status of the job, among the values of JobStatus.

submit()

Submit the job to the backend for execution.

wait_for_final_state(timeout=None, wait=5, callback=None)

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

Parameters

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

• wait (float) – Seconds between queries.

• callback (Callable | None) –

  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.