IQMJob

Module: iqm.qiskit_iqm.iqm_job

class iqm.qiskit_iqm.iqm_job.IQMJob(backend: IQMBackend, job: CircuitJob, **kwargs)

Bases: JobV1

Implementation of Qiskit’s job interface to handle circuit execution on an IQM Server.

Parameters:

• backend (IQMBackend) – Backend instance initiating this job.

• job (CircuitJob) – Circuit execution job generated by IQM Server.

• kwargs – Arguments to be passed to the initializer of the parent class.

Attributes

Methods

cancel	Attempt to cancel the job.
error_message	Returns the error message if job has failed, otherwise returns None.
queue_position	Return the position of the job in the server queue.
result	Retrieve job result within defined timeout.
status	Get the current job status.
submit	Not implemented.

submit() → None

Not implemented.

Return type:

None

cancel() → bool

Attempt to cancel the job.

Returns:

True if the job was cancelled successfully, False otherwise

Return type:

bool

result(*, timeout: float = 10800.0, cancel_after_timeout: bool = False) → Result

Retrieve job result within defined timeout.

Parameters:

• timeout (float) – Time limit for the job to finish, in seconds.

• cancel_after_timeout (bool) – Whether client will try to cancel the job if timeout exceeded.

Returns:

Result if job finished within timeout.

Raises:

APITimeoutError – Waiting for results exceeded timeout.

Return type:

Result

status() → JobStatus

Get the current job status.

Return type:

JobStatus

queue_position(refresh: bool = False) → int | None

Return the position of the job in the server queue.

Note

The position is not yet implemented and this function will always return None. The refresh argument is ignored.

Parameters:

refresh (bool) – If True, re-query the server to get the latest value. Otherwise return the cached value.

Returns:

Position in the queue or None if position is unknown or not applicable.

Return type:

int | None

error_message() → str | None

Returns the error message if job has failed, otherwise returns None.

Return type:

str | None

Inheritance