workflow

WorkflowCreateV1

Bases: _WorkflowBaseV1

Task for Workflow creation.

Source code in fractal_server/app/schemas/v1/workflow.py

class WorkflowCreateV1(_WorkflowBaseV1):
    """
    Task for `Workflow` creation.
    """

    # Validators
    _name = validator("name", allow_reuse=True)(valstr("name"))

WorkflowExportV1

Bases: _WorkflowBaseV1

Class for Workflow export.

Attributes:

Name	Type	Description
task_list	list[WorkflowTaskExportV1]

Source code in fractal_server/app/schemas/v1/workflow.py

class WorkflowExportV1(_WorkflowBaseV1):
    """
    Class for `Workflow` export.

    Attributes:
        task_list:
    """

    task_list: list[WorkflowTaskExportV1]

WorkflowImportV1

Bases: _WorkflowBaseV1

Class for Workflow import.

Attributes:

Name	Type	Description
task_list	list[WorkflowTaskImportV1]

Source code in fractal_server/app/schemas/v1/workflow.py

class WorkflowImportV1(_WorkflowBaseV1):
    """
    Class for `Workflow` import.

    Attributes:
        task_list:
    """

    task_list: list[WorkflowTaskImportV1]

    # Validators
    _name = validator("name", allow_reuse=True)(valstr("name"))

WorkflowReadV1

Bases: _WorkflowBaseV1

Task for Workflow read from database.

Attributes:

Name	Type	Description
id	int
project_id	int
task_list	list[WorkflowTaskReadV1]
project	ProjectReadV1

Source code in fractal_server/app/schemas/v1/workflow.py

class WorkflowReadV1(_WorkflowBaseV1):
    """
    Task for `Workflow` read from database.

    Attributes:
        id:
        project_id:
        task_list:
        project:
    """

    id: int
    project_id: int
    task_list: list[WorkflowTaskReadV1]
    project: ProjectReadV1
    timestamp_created: datetime

WorkflowTaskCreateV1

Bases: _WorkflowTaskBaseV1

Class for WorkflowTask creation.

Attributes:

Name	Type	Description
order	Optional[int]

Source code in fractal_server/app/schemas/v1/workflow.py

class WorkflowTaskCreateV1(_WorkflowTaskBaseV1):
    """
    Class for `WorkflowTask` creation.

    Attributes:
        order:
    """

    order: Optional[int]
    # Validators
    _order = validator("order", allow_reuse=True)(valint("order", min_val=0))

WorkflowTaskExportV1

Bases: _WorkflowTaskBaseV1

Class for WorkflowTask export.

Attributes:

Name	Type	Description
task	TaskExportV1

Source code in fractal_server/app/schemas/v1/workflow.py

class WorkflowTaskExportV1(_WorkflowTaskBaseV1):
    """
    Class for `WorkflowTask` export.

    Attributes:
        task:
    """

    task: TaskExportV1

WorkflowTaskImportV1

Bases: _WorkflowTaskBaseV1

Class for WorkflowTask import.

Attributes:

Name	Type	Description
task	TaskImportV1

Source code in fractal_server/app/schemas/v1/workflow.py

class WorkflowTaskImportV1(_WorkflowTaskBaseV1):
    """
    Class for `WorkflowTask` import.

    Attributes:
        task:
    """

    task: TaskImportV1

WorkflowTaskReadV1

Bases: _WorkflowTaskBaseV1

Class for WorkflowTask read from database.

Attributes:

Name	Type	Description
id	int
order	Optional[int]
workflow_id	int
task_id	int
task	TaskReadV1

Source code in fractal_server/app/schemas/v1/workflow.py

class WorkflowTaskReadV1(_WorkflowTaskBaseV1):
    """
    Class for `WorkflowTask` read from database.

    Attributes:
        id:
        order:
        workflow_id:
        task_id:
        task:
    """

    id: int
    order: Optional[int]
    workflow_id: int
    task_id: int
    task: TaskReadV1

WorkflowTaskStatusTypeV1

Bases: str, Enum

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/v1/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/v1/workflow.py

class WorkflowTaskStatusTypeV1(str, Enum):
    """
    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/v1/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"

WorkflowTaskUpdateV1

Bases: _WorkflowTaskBaseV1

Class for WorkflowTask update.

Source code in fractal_server/app/schemas/v1/workflow.py

class WorkflowTaskUpdateV1(_WorkflowTaskBaseV1):
    """
    Class for `WorkflowTask` update.
    """

    # Validators
    @validator("meta")
    def check_no_parallelisation_level(cls, m):
        if "parallelization_level" in m:
            raise ValueError(
                "Overriding task parallelization level currently not allowed"
            )
        return m

WorkflowUpdateV1

Bases: _WorkflowBaseV1

Task for Workflow update.

Attributes:

Name	Type	Description
name	Optional[str]
reordered_workflowtask_ids	Optional[list[int]]

Source code in fractal_server/app/schemas/v1/workflow.py

class WorkflowUpdateV1(_WorkflowBaseV1):
    """
    Task for `Workflow` update.

    Attributes:
        name:
        reordered_workflowtask_ids:
    """

    name: Optional[str]
    reordered_workflowtask_ids: Optional[list[int]]

    # Validators
    _name = validator("name", allow_reuse=True)(valstr("name"))

    @validator("reordered_workflowtask_ids")
    def check_positive_and_unique(cls, value):
        if any(i < 0 for i in value):
            raise ValueError("Negative `id` in `reordered_workflowtask_ids`")
        if len(value) != len(set(value)):
            raise ValueError("`reordered_workflowtask_ids` has repetitions")
        return value

_WorkflowBaseV1

Bases: BaseModel

Base class for Workflow.

Attributes:

Name	Type	Description
name	str	Workflow name.

Source code in fractal_server/app/schemas/v1/workflow.py

class _WorkflowBaseV1(BaseModel):
    """
    Base class for `Workflow`.

    Attributes:
        name: Workflow name.
    """

    name: str

_WorkflowTaskBaseV1

Bases: BaseModel

Base class for WorkflowTask.

Source code in fractal_server/app/schemas/v1/workflow.py

class _WorkflowTaskBaseV1(BaseModel):
    """
    Base class for `WorkflowTask`.
    """

    meta: Optional[dict[str, Any]] = None
    args: Optional[dict[str, Any]] = None