Skip to content

status_legacy

LegacyStatusReadV2

Bases: BaseModel

Response type for the /project/{project_id}/status/ endpoint

Source code in fractal_server/app/schemas/v2/status_legacy.py 
26
27
28
29
30
31
32
33
34
35
class LegacyStatusReadV2(BaseModel):
    """
    Response type for the
    `/project/{project_id}/status/` endpoint
    """

    status: dict[
        str,
        WorkflowTaskStatusTypeV2,
    ] = Field(default_factory=dict)

WorkflowTaskStatusTypeV2

Bases: StrEnum

Define the available values for the status of a WorkflowTask.

This model is used within the Dataset.history attribute, which is constructed in the runner and then used in the API (e.g. in the api/v2/project/{project_id}/dataset/{dataset_id}/status endpoint).

Attributes:

Name Type Description
SUBMITTED

The WorkflowTask is part of a running job.
DONE

The most-recent execution of this WorkflowTask was successful.
FAILED

The most-recent execution of this WorkflowTask failed.
Source code in fractal_server/app/schemas/v2/status_legacy.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
class WorkflowTaskStatusTypeV2(StrEnum):
    """
    Define the available values for the status of a `WorkflowTask`.

    This model is used within the `Dataset.history` attribute, which is
    constructed in the runner and then used in the API (e.g. in the
    `api/v2/project/{project_id}/dataset/{dataset_id}/status` endpoint).

    Attributes:
        SUBMITTED: The `WorkflowTask` is part of a running job.
        DONE: The most-recent execution of this `WorkflowTask` was successful.
        FAILED: The most-recent execution of this `WorkflowTask` failed.
    """

    SUBMITTED = "submitted"
    DONE = "done"
    FAILED = "failed"