PrimitiveJob

class qiskit.primitives.PrimitiveJob(function, *args, **kwargs)

Bases: BasePrimitiveJob [ResultT, JobStatus]

Primitive job class for the reference implementations of Primitives.

Parameters

function - A callable function to execute the job.

Methods

cancel

cancel()

Attempt to cancel the job.

cancelled

cancelled()

Return whether the job has been cancelled.

Return type

bool

done

done()

Return whether the job has successfully run.

Return type

bool

in_final_state

in_final_state()

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

Return type

bool

job_id

job_id()

Return a unique id identifying the job.

Return type

str

result

result()

Return the results of the job.

Return type

ResultT

running

running()

Return whether the job is actively running.

Return type

bool

status

status()

Return the status of the job.

Return type

JobStatus

Was this page helpful?

Report a bug or request content on GitHub.