general_superstaq.typing
========================

.. py:module:: general_superstaq.typing


Attributes
----------

.. autoapisummary::

   general_superstaq.typing.TQuboKey


Classes
-------

.. autoapisummary::

   general_superstaq.typing.Job
   general_superstaq.typing.Target


Module Contents
---------------

.. py:class:: Job

   Bases: :py:obj:`TypedDict`


   A class to store data for a Superstaq job.


   .. py:attribute:: circuit_type
      :type:  str


   .. py:attribute:: compiled_circuit
      :type:  str


   .. py:attribute:: data
      :type:  dict[str, Any] | None


   .. py:attribute:: input_circuit
      :type:  str | None


   .. py:attribute:: num_qubits
      :type:  int


   .. py:attribute:: provider_id
      :type:  str


   .. py:attribute:: pulse_gate_circuits
      :type:  str | None


   .. py:attribute:: samples
      :type:  dict[str, int] | None


   .. py:attribute:: shots
      :type:  int | None


   .. py:attribute:: state_vector
      :type:  str | None


   .. py:attribute:: status
      :type:  str


   .. py:attribute:: target
      :type:  str


.. py:class:: Target(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   A data class to store data returned from a `/get_targets` request.


   .. py:attribute:: accessible
      :type:  bool
      :value: False



   .. py:attribute:: available
      :type:  bool
      :value: False



   .. py:attribute:: retired
      :type:  bool
      :value: False



   .. py:attribute:: supports_compile
      :type:  bool
      :value: False



   .. py:attribute:: supports_submit
      :type:  bool
      :value: False



   .. py:attribute:: supports_submit_qubo
      :type:  bool
      :value: False



   .. py:attribute:: target
      :type:  str


.. py:data:: TQuboKey