AlgorithmJob#

class qiskit.algorithms.AlgorithmJob(function, *args, **kwargs)[ソース]#

ベースクラス: PrimitiveJob

This empty class is introduced for typing purposes.

パラメータ:

function – a callable function to execute the job.

Attributes

version = 1#

Methods

backend()#

Return the backend where this job was executed.

戻り値の型:

Backend

cancel()#

Attempt to cancel the job.

cancelled()#

Return whether the job has been cancelled.

戻り値の型:

bool

done()#

Return whether the job has successfully run.

戻り値の型:

bool

in_final_state()#

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

戻り値の型:

bool

job_id()#

Return a unique id identifying the job.

戻り値の型:

str

result()#

Return the results of the job.

戻り値の型:

T

running()#

Return whether the job is actively running.

戻り値の型:

bool

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(timeout=None, wait=5, callback=None)#

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

パラメータ:

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

例外:

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