Skip to content

History

CLASS DESCRIPTION
HistoryRunReadAggregated

Note: version can be None, because HistoryRun.task_id is a nullable

HistoryUnitStatus

Available status for images

HistoryUnitStatusWithUnset

Available status for history queries

Classes

HistoryRunReadAggregated pydantic-model

Bases: BaseModel

Note: version can be None, because HistoryRun.task_id is a nullable foreign key.

Fields:

  • id (int)
  • timestamp_started (AwareDatetime)
  • workflowtask_dump (dict[str, Any])
  • num_submitted_units (int)
  • num_done_units (int)
  • num_failed_units (int)
  • num_units_with_warnings (int)
  • args_schema_parallel (dict[str, Any] | None)
  • args_schema_non_parallel (dict[str, Any] | None)
  • version (str | None)
Source code in fractal_server/app/schemas/v2/history.py
class HistoryRunReadAggregated(BaseModel):
    """
    Note: version can be `None`, because `HistoryRun.task_id` is a nullable
    foreign key.
    """

    id: int
    timestamp_started: AwareDatetime
    workflowtask_dump: dict[str, Any]
    num_submitted_units: int
    num_done_units: int
    num_failed_units: int
    num_units_with_warnings: int
    args_schema_parallel: dict[str, Any] | None = None
    args_schema_non_parallel: dict[str, Any] | None = None
    version: str | None = None

    @field_serializer("timestamp_started")
    def serialize_datetime(v: datetime) -> str:
        return v.isoformat()

HistoryUnitStatus

Bases: StrEnum

Available status for images

ATTRIBUTE DESCRIPTION
SUBMITTED

DONE

FAILED

Source code in fractal_server/app/schemas/v2/history.py
class HistoryUnitStatus(StrEnum):
    """
    Available status for images

    Attributes:
        SUBMITTED:
        DONE:
        FAILED:
    """

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

HistoryUnitStatusWithUnset

Bases: StrEnum

Available status for history queries

ATTRIBUTE DESCRIPTION
SUBMITTED

DONE

FAILED

Source code in fractal_server/app/schemas/v2/history.py
class HistoryUnitStatusWithUnset(StrEnum):
    """
    Available status for history queries

    Attributes:
        SUBMITTED:
        DONE:
        FAILED:
    """

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