AlgorithmJob
qiskit.algorithms.AlgorithmJob(function, *args, **kwargs)
Bases: PrimitiveJob
This empty class is introduced for typing purposes.
Parameters
function – a callable function to execute the job.
Attributes
version
= 1
Methods
backend
backend()
Return the backend where this job was executed.
Return type
cancel
cancel()
Attempt to cancel the job.
cancelled
cancelled()
Return whether the job has been cancelled.
Return type
done
done()
Return whether the job has successfully run.
Return type
in_final_state
in_final_state()
Return whether the job is in a final job state such as DONE or ERROR.
Return type
job_id
job_id()
Return a unique id identifying the job.
Return type
result
result()
Return the results of the job.
Return type
T
running
running()
Return whether the job is actively running.
Return type
status
status()
Return the status of the job, among the values of JobStatus.
submit
submit()
Submit the job to the backend for execution.
wait_for_final_state
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.
Parameters
-
timeout (float (opens in a new tab) | None) – Seconds to wait for the job. If
None, wait indefinitely. -
wait (float (opens in a new tab)) – Seconds between queries.
-
callback (Callable (opens in a new tab) | 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.
Raises
JobTimeoutError – If the job does not reach a final state before the specified timeout.