BasicAerJob
class qiskit.providers.basicaer.BasicAerJob(backend, job_id, result)
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
done
in_final_state
in_final_state()
Return whether the job is in a final job state such as DONE or ERROR.
Return type
job_id
result
running
status
status()
Gets the status of the job by querying the Python’s future
Returns
The current JobStatus
Return type
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(opens in a new tab) | None) – Seconds to wait for the job. If
None, wait indefinitely. -
wait (float(opens in a new tab)) – Seconds between queries.
-
callback (Callable(opens in a new tab) | 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.