JobV1

class qiskit.providers.JobV1(backend, job_id, **kwargs)

Bases: Job, 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 (Optional[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.

Attributes

version

Default value: 1

Methods

backend

backend()

GitHub

Return the backend where this job was executed.

Return type

Backend

cancel

cancel()

GitHub

Attempt to cancel the job.

cancelled

cancelled()

GitHub

Return whether the job has been cancelled.

Return type

bool

done

done()

GitHub

Return whether the job has successfully run.

Return type

bool

in_final_state

in_final_state()

GitHub

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

Return type

bool

job_id

job_id()

GitHub

Return a unique id identifying the job.

Return type

str

result

abstract result()

GitHub

Return the results of the job.

Return type

Result

running

running()

GitHub

Return whether the job is actively running.

Return type

bool

status

abstract status()

GitHub

Return the status of the job, among the values of JobStatus.

Return type

JobStatus

submit

abstract submit()

GitHub

Submit the job to the backend for execution.

wait_for_final_state

wait_for_final_state(timeout=None, wait=5, callback=None)

GitHub

Poll the job status until it progresses to a final state such as DONE or ERROR.

Parameters

timeout (float | None) – Seconds to wait for the job. If None, wait indefinitely.
wait (float) – Seconds between queries.
callback (Callable | None) –

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.

Was this page helpful?

Report a bug or request content on GitHub.