47 lines
3.4 KiB
Plaintext
47 lines
3.4 KiB
Plaintext
---
|
||
title: job
|
||
description: API reference for qiskit_ibm_provider.job
|
||
in_page_toc_min_heading_level: 2
|
||
python_api_type: module
|
||
python_api_name: qiskit_ibm_provider.job
|
||
---
|
||
|
||
<span id="job-qiskit-ibm-provider-job" />
|
||
|
||
<span id="module-qiskit_ibm_provider.job" />
|
||
|
||
<span id="qiskit-ibm-provider-job" />
|
||
|
||
# Job
|
||
|
||
<span id="module-qiskit_ibm_provider.job" />
|
||
|
||
`qiskit_ibm_provider.job`
|
||
|
||
Modules representing IBM Quantum jobs.
|
||
|
||
## Classes
|
||
|
||
| | |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||
| [`IBMCircuitJob`](qiskit_ibm_provider.job.IBMCircuitJob "qiskit_ibm_provider.job.IBMCircuitJob")(backend, api\_client, job\_id\[, ...]) | Representation of a job that executes on an IBM Quantum backend. |
|
||
| [`IBMCompositeJob`](qiskit_ibm_provider.job.IBMCompositeJob "qiskit_ibm_provider.job.IBMCompositeJob")(backend, api\_client\[, ...]) | Representation of a set of jobs that execute on an IBM Quantum backend. |
|
||
| [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.QueueInfo")(\[position\_in\_queue, status, ...]) | Queue information for a job. |
|
||
|
||
## Functions
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
|
||
| [`job_monitor`](qiskit_ibm_provider.job.job_monitor "qiskit_ibm_provider.job.job_monitor")(job\[, interval, output]) | Monitor the status of an `IBMJob` instance. |
|
||
|
||
## Exception
|
||
|
||
| | |
|
||
| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||
| [`IBMJobError`](qiskit_ibm_provider.job.IBMJobError "qiskit_ibm_provider.job.IBMJobError")(\*message) | Base class for errors raised by the job modules. |
|
||
| [`IBMJobApiError`](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError")(\*message) | Errors that occur unexpectedly when querying the server. |
|
||
| [`IBMJobFailureError`](qiskit_ibm_provider.job.IBMJobFailureError "qiskit_ibm_provider.job.IBMJobFailureError")(\*message) | Errors raised when a job failed. |
|
||
| [`IBMJobInvalidStateError`](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError")(\*message) | Errors raised when a job is not in a valid state for the operation. |
|
||
| [`IBMJobTimeoutError`](qiskit_ibm_provider.job.IBMJobTimeoutError "qiskit_ibm_provider.job.IBMJobTimeoutError")(\*message) | Errors raised when a job operation times out. |
|
||
|