qiskit.providers.JobV1¶

class JobV1(backend, job_id, **kwargs)[source]¶

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.

__init__(backend, job_id, **kwargs)[source]¶

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

`__init__`(backend, job_id, **kwargs)	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 such as `DONE` or `ERROR`.
`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`.

Attributes

version

backend()[source]¶

Return the backend where this job was executed.

Return type: Backend

cancel()[source]¶: Attempt to cancel the job.

cancelled()[source]¶

Return whether the job has been cancelled.

Return type: bool

done()[source]¶

Return whether the job has successfully run.

Return type: bool

in_final_state()[source]¶

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

Return type: bool

job_id()[source]¶

Return a unique id identifying the job.

Return type: str

abstract result()[source]¶: Return the results of the job.

running()[source]¶

Return whether the job is actively running.

Return type: bool

abstract status()[source]¶: Return the status of the job, among the values of JobStatus.

abstract submit()[source]¶: Submit the job to the backend for execution.

wait_for_final_state(timeout=None, wait=5, callback=None)[source]¶

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