JobV1

class JobV1(backend, job_id, **kwargs)[source]

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.

Attributes

JobV1.version

Methods

JobV1.backend()

Return the backend where this job was executed.

JobV1.cancel()

Attempt to cancel the job.

JobV1.cancelled()

Return whether the job has been cancelled.

JobV1.done()

Return whether the job has successfully run.

JobV1.in_final_state()

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

JobV1.job_id()

Return a unique id identifying the job.

JobV1.result()

Return the results of the job.

JobV1.running()

Return whether the job is actively running.

JobV1.status()

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

JobV1.submit()

Submit the job to the backend for execution.

JobV1.wait_for_final_state([timeout, wait, …])

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