JobV1
class JobV1(backend, job_id, **kwargs)
Bases: qiskit.providers.job.Job, abc.ABC
Class to handle jobs
This first version of the Backend abstract class is written to be mostly backwards compatible with the legacy providers interface. This was done to ease the transition for users and provider maintainers to the new versioned providers. Expect, future versions of this abstract class to change the data model and interface.
Initializes the asynchronous job.
Parameters
- backend (
Backend) – the backend used to run the job. - job_id (
str) – 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
backend
JobV1.backend()
Return the backend where this job was executed.
Return type
Backend
cancel
JobV1.cancel()
Attempt to cancel the job.
cancelled
JobV1.cancelled()
Return whether the job has been cancelled.
Return type
bool
done
JobV1.done()
Return whether the job has successfully run.
Return type
bool
in_final_state
JobV1.in_final_state()
Return whether the job is in a final job state such as DONE or ERROR.
Return type
bool
job_id
JobV1.job_id()
Return a unique id identifying the job.
Return type
str
result
abstract JobV1.result()
Return the results of the job.
running
JobV1.running()
Return whether the job is actively running.
Return type
bool
status
abstract JobV1.status()
Return the status of the job, among the values of JobStatus.
submit
abstract JobV1.submit()
Submit the job to the backend for execution.
wait_for_final_state
JobV1.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. IfNone, 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
Attributes
version
Default value: 1