Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

BasicAerJob

class qiskit.providers.basicaer.BasicAerJob(backend, job_id, result)

GitHub

Bases: JobV1

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.

Attributes

version

Default value: 1


Methods

backend

backend()

Return the instance of the backend used for this job.

cancel

cancel()

Attempt to cancel the job.

cancelled

cancelled()

Return whether the job has been cancelled.

Return type

bool

done

done()

Return whether the job has successfully run.

Return type

bool

in_final_state

in_final_state()

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

Return type

bool

job_id

job_id()

Return a unique id identifying the job.

Return type

str

result

result(timeout=None)

Get job result .

Returns

Result object

Return type

qiskit.result.Result

running

running()

Return whether the job is actively running.

Return type

bool

status

status()

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

Returns

The current JobStatus

Return type

qiskit.providers.JobStatus

submit

submit()

Submit the job to the backend for execution.

Raises

JobError – if trying to re-submit the job.

wait_for_final_state

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.

Was this page helpful?
Report a bug or request content on GitHub.