171 lines
4.6 KiB
Plaintext
171 lines
4.6 KiB
Plaintext
---
|
||
title: JobV1 (v0.29)
|
||
description: API reference for qiskit.providers.JobV1 in qiskit v0.29
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.JobV1
|
||
---
|
||
|
||
# JobV1
|
||
|
||
<Class id="qiskit.providers.JobV1" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py" signature="JobV1(backend, job_id, **kwargs)" modifiers="class">
|
||
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
|
||
|
||
<span id="qiskit-providers-jobv1-backend" />
|
||
|
||
### backend
|
||
|
||
<Function id="qiskit.providers.JobV1.backend" signature="JobV1.backend()">
|
||
Return the backend where this job was executed.
|
||
|
||
**Return type**
|
||
|
||
`Backend`
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-jobv1-cancel" />
|
||
|
||
### cancel
|
||
|
||
<Function id="qiskit.providers.JobV1.cancel" signature="JobV1.cancel()">
|
||
Attempt to cancel the job.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-jobv1-cancelled" />
|
||
|
||
### cancelled
|
||
|
||
<Function id="qiskit.providers.JobV1.cancelled" signature="JobV1.cancelled()">
|
||
Return whether the job has been cancelled.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-jobv1-done" />
|
||
|
||
### done
|
||
|
||
<Function id="qiskit.providers.JobV1.done" signature="JobV1.done()">
|
||
Return whether the job has successfully run.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-jobv1-in-final-state" />
|
||
|
||
### in\_final\_state
|
||
|
||
<Function id="qiskit.providers.JobV1.in_final_state" signature="JobV1.in_final_state()">
|
||
Return whether the job is in a final job state such as `DONE` or `ERROR`.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-jobv1-job-id" />
|
||
|
||
### job\_id
|
||
|
||
<Function id="qiskit.providers.JobV1.job_id" signature="JobV1.job_id()">
|
||
Return a unique id identifying the job.
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-jobv1-result" />
|
||
|
||
### result
|
||
|
||
<Function id="qiskit.providers.JobV1.result" signature="JobV1.result()" modifiers="abstract">
|
||
Return the results of the job.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-jobv1-running" />
|
||
|
||
### running
|
||
|
||
<Function id="qiskit.providers.JobV1.running" signature="JobV1.running()">
|
||
Return whether the job is actively running.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-jobv1-status" />
|
||
|
||
### status
|
||
|
||
<Function id="qiskit.providers.JobV1.status" signature="JobV1.status()" modifiers="abstract">
|
||
Return the status of the job, among the values of `JobStatus`.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-jobv1-submit" />
|
||
|
||
### submit
|
||
|
||
<Function id="qiskit.providers.JobV1.submit" signature="JobV1.submit()" modifiers="abstract">
|
||
Submit the job to the backend for execution.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-jobv1-wait-for-final-state" />
|
||
|
||
### wait\_for\_final\_state
|
||
|
||
<Function id="qiskit.providers.JobV1.wait_for_final_state" signature="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. 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>
|
||
|
||
## Attributes
|
||
|
||
### version
|
||
|
||
<Attribute id="qiskit.providers.JobV1.version" attributeValue="1" />
|
||
</Class>
|
||
|