qiskit.providers.ibmq.managed.ManagedJob

class ManagedJob(start_index, experiments_count, job=None)

Job managed by the Job Manager.

ManagedJob constructor.

Parameters

• start_index (int) – Starting index of the experiment set.

• experiments_count (int) – Number of experiments.

• job (Optional[IBMQJob]) – Job to be managed, or None if not already known.

__init__(start_index, experiments_count, job=None)

ManagedJob constructor.

Parameters

• start_index (int) – Starting index of the experiment set.

• experiments_count (int) – Number of experiments.

• job (Optional[IBMQJob]) – Job to be managed, or None if not already known.

Methods

__init__(start_index, experiments_count[, job])	ManagedJob constructor.
cancel()	Attempt to cancel the job.
error_message()	Provide details about the reason of failure.
qobj()	Return the Qobj for this job.
result([timeout, partial, refresh])	Return the result of the job.
status()	Query the server for job status.
submit(qobj, job_name, backend, executor, …)	Submit the job.

cancel()

Attempt to cancel the job.

Return type

None

error_message()

Provide details about the reason of failure.

Return type

Optional[str]

Returns

An error report if the job failed or None otherwise.

qobj()

Return the Qobj for this job.

Return type

Union[QasmQobj, PulseQobj, None]

Returns

The Qobj for this job or None if the Qobj could not be retrieved.

result(timeout=None, partial=False, refresh=False)

Return the result of the job.

Parameters

• timeout (Optional[float]) – Number of seconds to wait for job.

• partial (bool) – If True, attempt to retrieve partial job results.

• refresh (bool) – If True, re-query the server for the result. Otherwise return the cached value.

Return type

Optional[Result]

Returns

Job result or None if result could not be retrieved.

Raises

IBMQJobTimeoutError – If the job does not return results before a specified timeout.

status()

Query the server for job status.

Return type

Optional[JobStatus]

Returns

Current job status, or None if an error occurred.

submit(qobj, job_name, backend, executor, submit_lock, job_share_level, job_tags=None)

Submit the job.

Parameters

• qobj (Union[QasmQobj, PulseQobj]) – Qobj to run.

• job_name (str) – Name of the job.

• backend (IBMQBackend) – Backend to execute the experiments on.

• executor (ThreadPoolExecutor) – The thread pool used to submit the job.

• submit_lock (allocate_lock) – Lock used to synchronize job submission.

• job_share_level (ApiJobShareLevel) – Job share level.

• job_tags (Optional[List[str]]) – Tags to be assigned to the job.

Return type

None