JobV1#

class qiskit.providers.JobV1(backend, job_id, **kwargs)[código fonte]#

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.

Parâmetros:

  • backend (Backend | None) – 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 = 1#

Methods

backend()[código fonte]#

Return the backend where this job was executed.

Tipo de retorno:

Backend

cancel()[código fonte]#

Attempt to cancel the job.

cancelled()[código fonte]#

Return whether the job has been cancelled.

Tipo de retorno:

bool

done()[código fonte]#

Return whether the job has successfully run.

Tipo de retorno:

bool

in_final_state()[código fonte]#

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

Tipo de retorno:

bool

job_id()[código fonte]#

Return a unique id identifying the job.

Tipo de retorno:

str

abstract result()[código fonte]#

Return the results of the job.

running()[código fonte]#

Return whether the job is actively running.

Tipo de retorno:

bool

abstract status()[código fonte]#

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

abstract submit()[código fonte]#

Submit the job to the backend for execution.

wait_for_final_state(timeout=None, wait=5, callback=None)[código fonte]#

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

Parâmetros:

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

Levanta:

JobTimeoutError – If the job does not reach a final state before the specified timeout.