Skip to main content
IBM Quantum Platform

BackendStatus

class qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)

GitHub

Bases: object

Class representing Backend Status.

Initialize a BackendStatus object

Deprecated since version 1.4

The class qiskit.providers.models.backendstatus.BackendStatus is deprecated as of qiskit 1.4. It will be removed in the 2.0 release. The models in qiskit.providers.models and related objects are part of the deprecated BackendV1 workflow, and no longer necessary for BackendV2. If a user workflow requires these representations it likely relies on deprecated functionality and should be updated to use BackendV2.

Parameters

  • backend_name (str) – The backend’s name
  • backend_version (str) – The backend’s version of the form X.Y.Z
  • operational (bool) – True if the backend is operational
  • pending_jobs (int) – The number of pending jobs on the backend
  • status_msg (str) – The status msg for the backend

Raises

QiskitError – If the backend version is in an invalid format


Methods

from_dict

classmethod from_dict(data)

GitHub

Create a new BackendStatus object from a dictionary.

Parameters

data (dict) – A dictionary representing the BaseBakend to create. It will be in the same format as output by to_dict().

Returns

The BackendStatus from the input dictionary.

Return type

BackendStatus

to_dict

to_dict()

GitHub

Return a dictionary format representation of the BackendStatus.

Returns

The dictionary form of the QobjHeader.

Return type

dict

Was this page helpful?
Report a bug or request content on GitHub.