166 lines
7.2 KiB
Plaintext
166 lines
7.2 KiB
Plaintext
---
|
||
title: BaseJob (v0.26)
|
||
description: API reference for qiskit.providers.BaseJob in qiskit v0.26
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.BaseJob
|
||
---
|
||
|
||
<span id="qiskit-providers-basejob" />
|
||
|
||
# qiskit.providers.BaseJob
|
||
|
||
<Class id="qiskit.providers.BaseJob" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/basejob.py" signature="BaseJob(backend, job_id)" modifiers="class">
|
||
Legacy Class to handle asynchronous jobs
|
||
|
||
Initializes the asynchronous job.
|
||
|
||
**Parameters**
|
||
|
||
* **backend** (`BaseBackend`) – the backend used to run the job.
|
||
* **job\_id** (`str`) – a unique id in the context of the backend used to run the job.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.providers.BaseJob.__init__" signature="__init__(backend, job_id)">
|
||
Initializes the asynchronous job.
|
||
|
||
**Parameters**
|
||
|
||
* **backend** (`BaseBackend`) – the backend used to run the job.
|
||
* **job\_id** (`str`) – a unique id in the context of the backend used to run the job.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.providers.BaseJob.__init__ "qiskit.providers.BaseJob.__init__")(backend, job\_id) | Initializes the asynchronous job. |
|
||
| [`backend`](#qiskit.providers.BaseJob.backend "qiskit.providers.BaseJob.backend")() | Return the backend where this job was executed. |
|
||
| [`cancel`](#qiskit.providers.BaseJob.cancel "qiskit.providers.BaseJob.cancel")() | Attempt to cancel the job. |
|
||
| [`cancelled`](#qiskit.providers.BaseJob.cancelled "qiskit.providers.BaseJob.cancelled")() | Return whether the job has been cancelled. |
|
||
| [`done`](#qiskit.providers.BaseJob.done "qiskit.providers.BaseJob.done")() | Return whether the job has successfully run. |
|
||
| [`in_final_state`](#qiskit.providers.BaseJob.in_final_state "qiskit.providers.BaseJob.in_final_state")() | Return whether the job is in a final job state. |
|
||
| [`job_id`](#qiskit.providers.BaseJob.job_id "qiskit.providers.BaseJob.job_id")() | Return a unique id identifying the job. |
|
||
| [`result`](#qiskit.providers.BaseJob.result "qiskit.providers.BaseJob.result")() | Return the results of the job. |
|
||
| [`running`](#qiskit.providers.BaseJob.running "qiskit.providers.BaseJob.running")() | Return whether the job is actively running. |
|
||
| [`status`](#qiskit.providers.BaseJob.status "qiskit.providers.BaseJob.status")() | Return the status of the job, among the values of `JobStatus`. |
|
||
| [`submit`](#qiskit.providers.BaseJob.submit "qiskit.providers.BaseJob.submit")() | Submit the job to the backend for execution. |
|
||
| [`wait_for_final_state`](#qiskit.providers.BaseJob.wait_for_final_state "qiskit.providers.BaseJob.wait_for_final_state")(\[timeout, wait, callback]) | Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. |
|
||
|
||
### backend
|
||
|
||
<Function id="qiskit.providers.BaseJob.backend" signature="backend()">
|
||
Return the backend where this job was executed.
|
||
|
||
**Return type**
|
||
|
||
`BaseBackend`
|
||
</Function>
|
||
|
||
### cancel
|
||
|
||
<Function id="qiskit.providers.BaseJob.cancel" signature="cancel()" modifiers="abstract">
|
||
Attempt to cancel the job.
|
||
</Function>
|
||
|
||
### cancelled
|
||
|
||
<Function id="qiskit.providers.BaseJob.cancelled" signature="cancelled()">
|
||
Return whether the job has been cancelled.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
### done
|
||
|
||
<Function id="qiskit.providers.BaseJob.done" signature="done()">
|
||
Return whether the job has successfully run.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
### in\_final\_state
|
||
|
||
<Function id="qiskit.providers.BaseJob.in_final_state" signature="in_final_state()">
|
||
Return whether the job is in a final job state.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
### job\_id
|
||
|
||
<Function id="qiskit.providers.BaseJob.job_id" signature="job_id()">
|
||
Return a unique id identifying the job.
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Function>
|
||
|
||
### result
|
||
|
||
<Function id="qiskit.providers.BaseJob.result" signature="result()" modifiers="abstract">
|
||
Return the results of the job.
|
||
</Function>
|
||
|
||
### running
|
||
|
||
<Function id="qiskit.providers.BaseJob.running" signature="running()">
|
||
Return whether the job is actively running.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
### status
|
||
|
||
<Function id="qiskit.providers.BaseJob.status" signature="status()" modifiers="abstract">
|
||
Return the status of the job, among the values of `JobStatus`.
|
||
</Function>
|
||
|
||
### submit
|
||
|
||
<Function id="qiskit.providers.BaseJob.submit" signature="submit()" modifiers="abstract">
|
||
Submit the job to the backend for execution.
|
||
</Function>
|
||
|
||
### wait\_for\_final\_state
|
||
|
||
<Function id="qiskit.providers.BaseJob.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>
|
||
|