German
Languages
English
Bengali
French
German
Japanese
Korean
Portuguese
Spanish
Tamil

JobV1

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

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.

Parameter
  • 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.

Methods

backend

Return the backend where this job was executed.

cancel

Attempt to cancel the job.

cancelled

Return whether the job has been cancelled.

done

Return whether the job has successfully run.

in_final_state

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

job_id

Return a unique id identifying the job.

result

Return the results of the job.

running

Return whether the job is actively running.

status

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

submit

Submit the job to the backend for execution.

wait_for_final_state

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

Attributes

version = 1