174 lines
7.6 KiB
Plaintext
174 lines
7.6 KiB
Plaintext
---
|
||
title: JobV1
|
||
description: API reference for qiskit.providers.JobV1
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.JobV1
|
||
---
|
||
|
||
# qiskit.providers.JobV1
|
||
|
||
<Class id="qiskit.providers.JobV1" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/job.py" signature="JobV1(backend, job_id, **kwargs)" modifiers="class">
|
||
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\_\_
|
||
|
||
<Function id="qiskit.providers.JobV1.__init__" signature="__init__(backend, job_id, **kwargs)">
|
||
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.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.providers.JobV1.__init__ "qiskit.providers.JobV1.__init__")(backend, job\_id, \*\*kwargs) | Initializes the asynchronous job. |
|
||
| [`backend`](#qiskit.providers.JobV1.backend "qiskit.providers.JobV1.backend")() | Return the backend where this job was executed. |
|
||
| [`cancel`](#qiskit.providers.JobV1.cancel "qiskit.providers.JobV1.cancel")() | Attempt to cancel the job. |
|
||
| [`cancelled`](#qiskit.providers.JobV1.cancelled "qiskit.providers.JobV1.cancelled")() | Return whether the job has been cancelled. |
|
||
| [`done`](#qiskit.providers.JobV1.done "qiskit.providers.JobV1.done")() | Return whether the job has successfully run. |
|
||
| [`in_final_state`](#qiskit.providers.JobV1.in_final_state "qiskit.providers.JobV1.in_final_state")() | Return whether the job is in a final job state such as `DONE` or `ERROR`. |
|
||
| [`job_id`](#qiskit.providers.JobV1.job_id "qiskit.providers.JobV1.job_id")() | Return a unique id identifying the job. |
|
||
| [`result`](#qiskit.providers.JobV1.result "qiskit.providers.JobV1.result")() | Return the results of the job. |
|
||
| [`running`](#qiskit.providers.JobV1.running "qiskit.providers.JobV1.running")() | Return whether the job is actively running. |
|
||
| [`status`](#qiskit.providers.JobV1.status "qiskit.providers.JobV1.status")() | Return the status of the job, among the values of `JobStatus`. |
|
||
| [`submit`](#qiskit.providers.JobV1.submit "qiskit.providers.JobV1.submit")() | Submit the job to the backend for execution. |
|
||
| [`wait_for_final_state`](#qiskit.providers.JobV1.wait_for_final_state "qiskit.providers.JobV1.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
|
||
|
||
<Function id="qiskit.providers.JobV1.backend" signature="backend()">
|
||
Return the backend where this job was executed.
|
||
|
||
**Return type**
|
||
|
||
`Backend`
|
||
</Function>
|
||
|
||
### cancel
|
||
|
||
<Function id="qiskit.providers.JobV1.cancel" signature="cancel()">
|
||
Attempt to cancel the job.
|
||
</Function>
|
||
|
||
### cancelled
|
||
|
||
<Function id="qiskit.providers.JobV1.cancelled" signature="cancelled()">
|
||
Return whether the job has been cancelled.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
### done
|
||
|
||
<Function id="qiskit.providers.JobV1.done" signature="done()">
|
||
Return whether the job has successfully run.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
### in\_final\_state
|
||
|
||
<Function id="qiskit.providers.JobV1.in_final_state" signature="in_final_state()">
|
||
Return whether the job is in a final job state such as `DONE` or `ERROR`.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
### job\_id
|
||
|
||
<Function id="qiskit.providers.JobV1.job_id" signature="job_id()">
|
||
Return a unique id identifying the job.
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Function>
|
||
|
||
### result
|
||
|
||
<Function id="qiskit.providers.JobV1.result" signature="result()" modifiers="abstract">
|
||
Return the results of the job.
|
||
</Function>
|
||
|
||
### running
|
||
|
||
<Function id="qiskit.providers.JobV1.running" signature="running()">
|
||
Return whether the job is actively running.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
### status
|
||
|
||
<Function id="qiskit.providers.JobV1.status" signature="status()" modifiers="abstract">
|
||
Return the status of the job, among the values of `JobStatus`.
|
||
</Function>
|
||
|
||
### submit
|
||
|
||
<Function id="qiskit.providers.JobV1.submit" signature="submit()" modifiers="abstract">
|
||
Submit the job to the backend for execution.
|
||
</Function>
|
||
|
||
### wait\_for\_final\_state
|
||
|
||
<Function id="qiskit.providers.JobV1.wait_for_final_state" signature="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**](qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout.
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
</Class>
|
||
|