Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

JobV1

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

GitHub(opens in a new tab)

Bases: Job, ABC(opens in a new tab)

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 | None) – the backend used to run the job.
  • job_id (str(opens in a new tab)) – 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

= 1


Methods

backend

backend()

Return the backend where this job was executed.

Return type

Backend

cancel

cancel()

Attempt to cancel the job.

cancelled

cancelled()

Return whether the job has been cancelled.

Return type

bool(opens in a new tab)

done

done()

Return whether the job has successfully run.

Return type

bool(opens in a new tab)

in_final_state

in_final_state()

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

Return type

bool(opens in a new tab)

job_id

job_id()

Return a unique id identifying the job.

Return type

str(opens in a new tab)

result

abstract result()

Return the results of the job.

running

running()

Return whether the job is actively running.

Return type

bool(opens in a new tab)

status

abstract status()

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

submit

abstract submit()

Submit the job to the backend for execution.

wait_for_final_state

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 (float(opens in a new tab) | None) – Seconds to wait for the job. If None, wait indefinitely.

  • wait (float(opens in a new tab)) – Seconds between queries.

  • callback (Callable(opens in a new tab) | 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.