:py:mod:`ska_src_api_global_execution.models`
=============================================

.. py:module:: ska_src_api_global_execution.models

.. autoapi-nested-parse::

   Response models import.



Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   config/index.rst
   constants/index.rst
   execution_model/index.rst
   response/index.rst
   workstep/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   ska_src_api_global_execution.models.GenericErrorResponse
   ska_src_api_global_execution.models.GenericOperationResponse
   ska_src_api_global_execution.models.HealthResponse
   ska_src_api_global_execution.models.PingResponse




.. py:class:: GenericErrorResponse(/, **data)


   Bases: :py:obj:`Response`

   .. autoapi-inheritance-diagram:: ska_src_api_global_execution.models.GenericErrorResponse
      :parts: 1
      :private-bases:

   The generic error response model.

   .. py:attribute:: detail
      :type: str

      


.. py:class:: GenericOperationResponse(/, **data)


   Bases: :py:obj:`Response`

   .. autoapi-inheritance-diagram:: ska_src_api_global_execution.models.GenericOperationResponse
      :parts: 1
      :private-bases:

   The generic operation error response model.

   .. py:attribute:: successful
      :type: bool

      


.. py:class:: HealthResponse(/, **data)


   Bases: :py:obj:`Response`

   .. autoapi-inheritance-diagram:: ska_src_api_global_execution.models.HealthResponse
      :parts: 1
      :private-bases:

   The health endpoint response model.

   .. py:class:: DependentServices(/, **data)


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

      .. autoapi-inheritance-diagram:: ska_src_api_global_execution.models.HealthResponse.DependentServices
         :parts: 1
         :private-bases:

      The dependent services response model.

      .. py:class:: DependentServiceStatus(/, **data)


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

         .. autoapi-inheritance-diagram:: ska_src_api_global_execution.models.HealthResponse.DependentServices.DependentServiceStatus
            :parts: 1
            :private-bases:

         The dependent services state response model.

         .. py:attribute:: status
            :type: Literal[UP, DOWN]

            


      .. py:attribute:: permissions_api
         :type: HealthResponse.DependentServices.DependentServiceStatus

         


   .. py:attribute:: dependent_services
      :type: HealthResponse.DependentServices

      

   .. py:attribute:: number_of_managed_requests
      :type: Annotated[int, Field(ge=0, json_schema_extra={'examples': [50]})]

      

   .. py:attribute:: uptime
      :type: Annotated[int, Field(ge=0, json_schema_extra={'examples': [1000]})]

      


.. py:class:: PingResponse(/, **data)


   Bases: :py:obj:`Response`

   .. autoapi-inheritance-diagram:: ska_src_api_global_execution.models.PingResponse
      :parts: 1
      :private-bases:

   The ping endpoint response model.

   .. py:attribute:: status
      :type: Literal[UP, DOWN]

      

   .. py:attribute:: version
      :type: str