flip_api.domain.schemas.status

Classes

BucketStatus	Status of the bucket.
BucketAction	Action to be taken on the bucket.
ClientDeployResponse	Response for client deployment.
ClientStatus	Status of the client.
JobStatus	Status of the job.
ModelStatus	Status of the model.
NetStatus	Status of the net.
FLTargets	Targets for FL backend.
FileUploadStatus	Status of the file upload.
FileUploadTag	Tag for the file upload.
FLStatus	Status of the FL.
ProjectStatus	Status of the project.
ServerEngineStatus	Status of the server engine.
TrustIntersectStatus	Status of the trust intersect.
TaskStatus	Status of a trust task in the task queue.
TaskType	Type of task dispatched to a trust.
XNATImageStatus	Status of the XNAT imaging project.
FLJobStatus	Normalized FL-backend job lifecycle status.

Module Contents

class flip_api.domain.schemas.status.BucketStatus(*args, **kwds)

Bases: enum.Enum

Status of the bucket.

CLEAN = 'clean'

INFECTED = 'infected'

NO = 'no'

class flip_api.domain.schemas.status.BucketAction(*args, **kwds)

Bases: enum.Enum

Action to be taken on the bucket.

DELETE = 'delete'

TAG = 'tag'

NO = 'no'

class flip_api.domain.schemas.status.ClientDeployResponse

Bases: str, enum.Enum

Response for client deployment.

OK = 'OK'

class flip_api.domain.schemas.status.ClientStatus

Bases: str, enum.Enum

Status of the client.

NO_REPLY = 'no_reply'

NO_JOBS = 'no_jobs'

CONNECTED = 'CONNECTED'

DISCONNECTED = 'DISCONNECTED'

class flip_api.domain.schemas.status.JobStatus(*args, **kwds)

Bases: enum.Enum

Status of the job.

QUEUED = 'QUEUED'

IN_PROGRESS = 'IN_PROGRESS'

COMPLETED = 'COMPLETED'

DELETED = 'DELETED'

class flip_api.domain.schemas.status.ModelStatus(*args, **kwds)

Bases: enum.Enum

Status of the model.

ERROR = 'ERROR'

STOPPED = 'STOPPED'

PENDING = 'PENDING'

INITIATED = 'INITIATED'

PREPARED = 'PREPARED'

TRAINING_STARTED = 'TRAINING_STARTED'

RESULTS_UPLOADED = 'RESULTS_UPLOADED'

class flip_api.domain.schemas.status.NetStatus(*args, **kwds)

Bases: enum.Enum

Status of the net.

AVAILABLE = 'AVAILABLE'

BUSY = 'BUSY'

class flip_api.domain.schemas.status.FLTargets

Bases: str, enum.Enum

Targets for FL backend.

SERVER = 'server'

CLIENT = 'client'

ALL = 'all'

class flip_api.domain.schemas.status.FileUploadStatus(*args, **kwds)

Bases: enum.Enum

Status of the file upload.

SCANNING = 'SCANNING'

COMPLETED = 'COMPLETED'

ERROR = 'ERROR'

class flip_api.domain.schemas.status.FileUploadTag(*args, **kwds)

Bases: enum.Enum

Tag for the file upload.

MODEL = 'MODEL'

DATA_OPENER = 'DATA_OPENER'

OBJECTIVE_TARGET = 'OBJECTIVE_TARGET'

class flip_api.domain.schemas.status.FLStatus

Bases: str, enum.Enum

Status of the FL.

SUCCESS = 'SUCCESS'

PARTIAL_SUCCESS = 'PARTIAL_SUCCESS'

ERROR_RUNTIME = 'ERROR_RUNTIME'

ERROR_SYNTAX = 'ERROR_SYNTAX'

ERROR_AUTHENTICATION = 'ERROR_AUTHENTICATION'

class flip_api.domain.schemas.status.ProjectStatus

Bases: str, enum.Enum

Status of the project.

UNSTAGED = 'UNSTAGED'

STAGED = 'STAGED'

APPROVED = 'APPROVED'

class flip_api.domain.schemas.status.ServerEngineStatus

Bases: str, enum.Enum

Status of the server engine.

STARTED = 'started'

STOPPED = 'stopped'

STARTING = 'starting'

NOT_STARTED = 'not started'

SHUTDOWN = 'shutdown'

class flip_api.domain.schemas.status.TrustIntersectStatus

Bases: str, enum.Enum

Status of the trust intersect.

PENDING = 'PENDING'

REQUEST_SENT = 'REQUEST_SENT'

INITIALISED = 'INITIALISED'

class flip_api.domain.schemas.status.TaskStatus

Bases: str, enum.Enum

Status of a trust task in the task queue.

PENDING = 'PENDING'

IN_PROGRESS = 'IN_PROGRESS'

COMPLETED = 'COMPLETED'

FAILED = 'FAILED'

class flip_api.domain.schemas.status.TaskType

Bases: str, enum.Enum

Type of task dispatched to a trust.

COHORT_QUERY = 'cohort_query'

CREATE_IMAGING = 'create_imaging'

DELETE_IMAGING = 'delete_imaging'

GET_IMAGING_STATUS = 'get_imaging_status'

REIMPORT_STUDIES = 'reimport_studies'

UPDATE_USER_PROFILE = 'update_user_profile'

class flip_api.domain.schemas.status.XNATImageStatus

Bases: str, enum.Enum

Status of the XNAT imaging project.

RETRIEVE_STARTED = 'RETRIEVE_STARTED'

RETRIEVE_COMPLETED = 'RETRIEVE_COMPLETED'

RETRIEVE_IN_PROGRESS = 'RETRIEVE_IN_PROGRESS'

RETRIEVE_ERROR = 'RETRIEVE_ERROR'

CREATED = 'CREATED'

DELETED = 'DELETED'

class flip_api.domain.schemas.status.FLJobStatus

Bases: 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.

PENDING = 'PENDING'

RUNNING = 'RUNNING'

FINISHED = 'FINISHED'

FAILED = 'FAILED'

STOPPED = 'STOPPED'