qiskit.providers.BaseJob

class BaseJob(backend, job_id)

DEPRECATED Legacy Class to handle asynchronous jobs

Initializes the asynchronous job.

Parameters

• backend (BaseBackend) – the backend used to run the job.

• job_id (str) – a unique id in the context of the backend used to run the job.

__init__(backend, job_id)

Initializes the asynchronous job.

Parameters

• backend (BaseBackend) – the backend used to run the job.

• job_id (str) – a unique id in the context of the backend used to run the job.

Methods

__init__(backend, job_id)	Initializes the asynchronous job.
backend()	Return the backend where this job was executed.
cancel()	Attempt to cancel the job.
cancelled()	Return whether the job has been cancelled.
done()	Return whether the job has successfully run.
in_final_state()	Return whether the job is in a final job state.
job_id()	Return a unique id identifying the job.
result()	Return the results of the job.
running()	Return whether the job is actively running.
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, wait, callback])	Poll the job status until it progresses to a final state such as DONE or ERROR.

backend()

Return the backend where this job was executed.

Return type

BaseBackend

abstract 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.

Return type

bool

job_id()

Return a unique id identifying the job.

Return type

str

abstract result()

Return the results of the job.

running()

Return whether the job is actively running.

Return type

bool

abstract status()

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

abstract 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 (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