BasePrimitiveJob

class qiskit.primitives.BasePrimitiveJob(job_id, **kwargs)

Bases: ABC, Generic [ResultT, StatusT]

Primitive job abstract base class.

Initializes the primitive job.

Parameters

job_id (str) – A unique id in the context of the primitive used to run the job.
kwargs – Any key value metadata to associate with this job.

Methods

abstract cancel()

Attempt to cancel the job.

abstract cancelled()

Return whether the job has been cancelled.

Return type

bool

abstract done()

Return whether the job has successfully run.

Return type

bool

abstract in_final_state()

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

Return type

bool

job_id()

Return a unique id identifying the job.

Return type

str

abstract result()

Return the results of the job.

Return type

ResultT

abstract running()

Return whether the job is actively running.

Return type

bool

abstract status()

Return the status of the job.

Return type

StatusT

Was this page helpful?

Report a bug or request content on GitHub.