qiskit.providers.basicaer.BasicAerJob

class BasicAerJob(backend, job_id, result)

BasicAerJob class.

Initializes the asynchronous job.

Parameters

• backend – the backend used to run the job.

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

• kwargs – Any key value metadata to associate with this job.

__init__(backend, job_id, result)

Initializes the asynchronous job.

Parameters

• backend – the backend used to run the job.

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

• kwargs – Any key value metadata to associate with this job.

Methods

__init__(backend, job_id, result)	Initializes the asynchronous job.
backend()	Return the instance of the backend used for this job.
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 such as DONE or ERROR.
job_id()	Return a unique id identifying the job.
result([timeout])	Get job result .
running()	Return whether the job is actively running.
status()	Gets the status of the job by querying the Python’s future
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.

Attributes

version

backend()

Return the instance of the backend used for this job.

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(timeout=None)

Get job result .

Returns

Result object

Return type

qiskit.Result

running()

Return whether the job is actively running.

Return type

bool

status()

Gets the status of the job by querying the Python’s future

Returns

The current JobStatus

Return type

qiskit.providers.JobStatus

submit()

Submit the job to the backend for execution.

Raises

JobError – if trying to re-submit the job.

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