flip_api.domain.schemas.status
==============================

.. py:module:: flip_api.domain.schemas.status


Classes
-------

.. autoapisummary::

   flip_api.domain.schemas.status.BucketStatus
   flip_api.domain.schemas.status.BucketAction
   flip_api.domain.schemas.status.ClientDeployResponse
   flip_api.domain.schemas.status.ClientStatus
   flip_api.domain.schemas.status.JobStatus
   flip_api.domain.schemas.status.ModelStatus
   flip_api.domain.schemas.status.NetStatus
   flip_api.domain.schemas.status.FLTargets
   flip_api.domain.schemas.status.FileUploadStatus
   flip_api.domain.schemas.status.FileUploadTag
   flip_api.domain.schemas.status.FLStatus
   flip_api.domain.schemas.status.ProjectStatus
   flip_api.domain.schemas.status.ServerEngineStatus
   flip_api.domain.schemas.status.TrustIntersectStatus
   flip_api.domain.schemas.status.TaskStatus
   flip_api.domain.schemas.status.TaskType
   flip_api.domain.schemas.status.XNATImageStatus
   flip_api.domain.schemas.status.FLJobStatus


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

.. py:class:: BucketStatus(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Status of the bucket.


   .. py:attribute:: CLEAN
      :value: 'clean'



   .. py:attribute:: INFECTED
      :value: 'infected'



   .. py:attribute:: NO
      :value: 'no'



.. py:class:: BucketAction(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Action to be taken on the bucket.


   .. py:attribute:: DELETE
      :value: 'delete'



   .. py:attribute:: TAG
      :value: 'tag'



   .. py:attribute:: NO
      :value: 'no'



.. py:class:: ClientDeployResponse

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Response for client deployment.


   .. py:attribute:: OK
      :value: 'OK'



.. py:class:: ClientStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Status of the client.


   .. py:attribute:: NO_REPLY
      :value: 'no_reply'



   .. py:attribute:: NO_JOBS
      :value: 'no_jobs'



   .. py:attribute:: CONNECTED
      :value: 'CONNECTED'



   .. py:attribute:: DISCONNECTED
      :value: 'DISCONNECTED'



.. py:class:: JobStatus(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Status of the job.


   .. py:attribute:: QUEUED
      :value: 'QUEUED'



   .. py:attribute:: IN_PROGRESS
      :value: 'IN_PROGRESS'



   .. py:attribute:: COMPLETED
      :value: 'COMPLETED'



   .. py:attribute:: DELETED
      :value: 'DELETED'



.. py:class:: ModelStatus(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Status of the model.


   .. py:attribute:: ERROR
      :value: 'ERROR'



   .. py:attribute:: STOPPED
      :value: 'STOPPED'



   .. py:attribute:: PENDING
      :value: 'PENDING'



   .. py:attribute:: INITIATED
      :value: 'INITIATED'



   .. py:attribute:: PREPARED
      :value: 'PREPARED'



   .. py:attribute:: TRAINING_STARTED
      :value: 'TRAINING_STARTED'



   .. py:attribute:: RESULTS_UPLOADED
      :value: 'RESULTS_UPLOADED'



.. py:class:: NetStatus(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Status of the net.


   .. py:attribute:: AVAILABLE
      :value: 'AVAILABLE'



   .. py:attribute:: BUSY
      :value: 'BUSY'



.. py:class:: FLTargets

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Targets for FL backend.


   .. py:attribute:: SERVER
      :value: 'server'



   .. py:attribute:: CLIENT
      :value: 'client'



   .. py:attribute:: ALL
      :value: 'all'



.. py:class:: FileUploadStatus(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Status of the file upload.


   .. py:attribute:: SCANNING
      :value: 'SCANNING'



   .. py:attribute:: COMPLETED
      :value: 'COMPLETED'



   .. py:attribute:: ERROR
      :value: 'ERROR'



.. py:class:: FileUploadTag(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Tag for the file upload.


   .. py:attribute:: MODEL
      :value: 'MODEL'



   .. py:attribute:: DATA_OPENER
      :value: 'DATA_OPENER'



   .. py:attribute:: OBJECTIVE_TARGET
      :value: 'OBJECTIVE_TARGET'



.. py:class:: FLStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Status of the FL.


   .. py:attribute:: SUCCESS
      :value: 'SUCCESS'



   .. py:attribute:: PARTIAL_SUCCESS
      :value: 'PARTIAL_SUCCESS'



   .. py:attribute:: ERROR_RUNTIME
      :value: 'ERROR_RUNTIME'



   .. py:attribute:: ERROR_SYNTAX
      :value: 'ERROR_SYNTAX'



   .. py:attribute:: ERROR_AUTHENTICATION
      :value: 'ERROR_AUTHENTICATION'



.. py:class:: ProjectStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Status of the project.


   .. py:attribute:: UNSTAGED
      :value: 'UNSTAGED'



   .. py:attribute:: STAGED
      :value: 'STAGED'



   .. py:attribute:: APPROVED
      :value: 'APPROVED'



.. py:class:: ServerEngineStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Status of the server engine.


   .. py:attribute:: STARTED
      :value: 'started'



   .. py:attribute:: STOPPED
      :value: 'stopped'



   .. py:attribute:: STARTING
      :value: 'starting'



   .. py:attribute:: NOT_STARTED
      :value: 'not started'



   .. py:attribute:: SHUTDOWN
      :value: 'shutdown'



.. py:class:: TrustIntersectStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Status of the trust intersect.


   .. py:attribute:: PENDING
      :value: 'PENDING'



   .. py:attribute:: REQUEST_SENT
      :value: 'REQUEST_SENT'



   .. py:attribute:: INITIALISED
      :value: 'INITIALISED'



.. py:class:: TaskStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Status of a trust task in the task queue.


   .. py:attribute:: PENDING
      :value: 'PENDING'



   .. py:attribute:: IN_PROGRESS
      :value: 'IN_PROGRESS'



   .. py:attribute:: COMPLETED
      :value: 'COMPLETED'



   .. py:attribute:: FAILED
      :value: 'FAILED'



.. py:class:: TaskType

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Type of task dispatched to a trust.


   .. py:attribute:: COHORT_QUERY
      :value: 'cohort_query'



   .. py:attribute:: CREATE_IMAGING
      :value: 'create_imaging'



   .. py:attribute:: DELETE_IMAGING
      :value: 'delete_imaging'



   .. py:attribute:: GET_IMAGING_STATUS
      :value: 'get_imaging_status'



   .. py:attribute:: REIMPORT_STUDIES
      :value: 'reimport_studies'



   .. py:attribute:: UPDATE_USER_PROFILE
      :value: 'update_user_profile'



.. py:class:: XNATImageStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Status of the XNAT imaging project.


   .. py:attribute:: RETRIEVE_STARTED
      :value: 'RETRIEVE_STARTED'



   .. py:attribute:: RETRIEVE_COMPLETED
      :value: 'RETRIEVE_COMPLETED'



   .. py:attribute:: RETRIEVE_IN_PROGRESS
      :value: 'RETRIEVE_IN_PROGRESS'



   .. py:attribute:: RETRIEVE_ERROR
      :value: 'RETRIEVE_ERROR'



   .. py:attribute:: CREATED
      :value: 'CREATED'



   .. py:attribute:: DELETED
      :value: 'DELETED'



.. py:class:: FLJobStatus

   Bases: :py:obj:`enum.StrEnum`


   Normalized FL-backend job lifecycle status.

   The shared job-metadata contract (GitHub issue #490): every FL-API adapter
   (fl-api-flower, fl-api-base) maps its native runtime status into one of these
   values, and flip-api consumes only these. Distinct from ``JobStatus`` above,
   which tracks the FL scheduler queue state.


   .. py:attribute:: PENDING
      :value: 'PENDING'



   .. py:attribute:: RUNNING
      :value: 'RUNNING'



   .. py:attribute:: FINISHED
      :value: 'FINISHED'



   .. py:attribute:: FAILED
      :value: 'FAILED'



   .. py:attribute:: STOPPED
      :value: 'STOPPED'