prefect.server.schemas.core

Full schemas of Prefect REST API objects.

Classes

Flow ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L83" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of flow data.

FlowRunPolicy ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L101" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines of how a flow run should retry.

Methods:

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

populate_deprecated_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L135" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

populate_deprecated_fields(cls, values: dict[str, Any]) -> dict[str, Any]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

CreatedBy ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L139" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

UpdatedBy ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L151" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

ConcurrencyLimitStrategy ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L163" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Enumeration of concurrency collision strategies.

Methods:

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

ConcurrencyOptions ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L172" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Class for storing the concurrency config in database.

FlowRun ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L186" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of flow run data.

Methods:

set_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L328" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_name(cls, name: str) -> str

TaskRunPolicy ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L346" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines of how a task run should retry.

Methods:

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

populate_deprecated_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L375" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

populate_deprecated_fields(cls, values: dict[str, Any]) -> dict[str, Any]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

validate_configured_retry_delays ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L380" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_configured_retry_delays(cls, v: int | float | list[int] | list[float] | None) -> int | float | list[int] | list[float] | None

validate_jitter_factor ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L387" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_jitter_factor(cls, v: float | None) -> float | None

RunInput ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L391" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Base class for classes that represent inputs to runs, which could include, constants, parameters, task runs or flow runs.

Methods:

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

TaskRunResult ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L402" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Represents a task run result input to another task run.

FlowRunResult ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L409" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Parameter ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L414" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Represents a parameter input to a task run.

Constant ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L421" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Represents constant input value to a task run.

TaskRun ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L428" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of task run data.

Methods:

set_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L543" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_name(cls, name: str) -> str

validate_cache_key ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L548" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_cache_key(cls, cache_key: str) -> str

DeploymentSchedule ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L552" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

validate_max_scheduled_runs ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L577" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_max_scheduled_runs(cls, v: int) -> int

VersionInfo ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L583" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

Deployment ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L588" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of deployment data.

ConcurrencyLimit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L700" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of a concurrency limit.

ConcurrencyLimitV2 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L713" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of a v2 concurrency limit.

BlockType ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L732" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of a block type

BlockSchema ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L756" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of a block schema.

BlockSchemaReference ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L779" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of a block schema reference.

BlockDocument ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L799" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of a block document.

Methods:

from_orm_model ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L840" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

from_orm_model(cls: type[Self], session: AsyncSession, orm_block_document: 'orm_models.ORMBlockDocument', include_secrets: bool = False) -> Self

validate_name_is_present_if_not_anonymous ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L834" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_name_is_present_if_not_anonymous(cls, values: dict[str, Any]) -> dict[str, Any]

BlockDocumentReference ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L887" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of a block document reference.

Methods:

validate_parent_and_ref_are_different ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L907" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_parent_and_ref_are_different(cls, values: dict[str, Any]) -> dict[str, Any]

Configuration ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L913" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of account info.

SavedSearchFilter ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L920" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A filter for a saved search model. Intended for use by the Prefect UI.

Methods:

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

SavedSearch ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L937" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of saved search data. Represents a set of filter criteria.

Log ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L947" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of log data.

QueueFilter ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L962" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Filter criteria definition for a work queue.

Methods:

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

WorkQueue ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L975" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of a work queue

WorkQueueHealthPolicy ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1008" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

evaluate_health_status ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1024" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

evaluate_health_status(self, late_runs_count: int, last_polled: Optional[DateTime] = None) -> bool

Given empirical information about the state of the work queue, evaluate its health status.

Args:

• late_runs: the count of late runs for the work queue.
• last_polled: the last time the work queue was polled, if available.

Returns:

• whether or not the work queue is healthy.

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

WorkQueueStatusDetail ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1055" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

Agent ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1071" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of an agent

WorkPoolStorageConfiguration ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1089" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A representation of a work pool's storage configuration

Methods:

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

WorkPool ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1108" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of a work pool

Methods:

helpful_error_for_missing_default_queue_id ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1144" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

helpful_error_for_missing_default_queue_id(cls, v: UUID | None) -> UUID

model_validate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1148" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate(cls: Type[Self], obj: Any) -> Self

Worker ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1165" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An ORM representation of a worker

Artifact ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1187" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

from_result ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1224" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

from_result(cls, data: Any | dict[str, Any]) -> 'Artifact'

validate_metadata_length ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1243" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_metadata_length(cls, v: dict[str, str]) -> dict[str, str]

ArtifactCollection ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1247" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Variable ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1284" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

FlowRunInput ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1303" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

CsrfToken ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/core.py#L1312" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}