`prefect.server.schemas.core`

Full schemas of Prefect REST API objects.

Classes

`Flow`

An ORM representation of flow data.

`FlowRunPolicy`

Defines of how a flow run should retry. Methods:

`model_validate_list`

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

`populate_deprecated_fields`

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

`reset_fields`

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`

`UpdatedBy`

`ConcurrencyLimitStrategy`

Enumeration of concurrency collision strategies. Methods:

`auto`

auto() -> str

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

`ConcurrencyOptions`

Class for storing the concurrency config in database.

`FlowRun`

An ORM representation of flow run data. Methods:

`set_name`

set_name(cls, name: str) -> str

`TaskRunPolicy`

Defines of how a task run should retry. Methods:

`model_validate_list`

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

`populate_deprecated_fields`

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

`reset_fields`

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`

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

`validate_jitter_factor`

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

`RunInput`

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

`model_validate_list`

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

`reset_fields`

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`

Represents a task run result input to another task run.

`FlowRunResult`

`Parameter`

Represents a parameter input to a task run.

`Constant`

Represents constant input value to a task run.

`TaskRun`

An ORM representation of task run data. Methods:

`set_name`

set_name(cls, name: str) -> str

`validate_cache_key`

validate_cache_key(cls, cache_key: str) -> str

`DeploymentSchedule`

Methods:

`validate_max_scheduled_runs`

validate_max_scheduled_runs(cls, v: int) -> int

`VersionInfo`

Methods:

`model_validate_list`

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

`reset_fields`

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`

An ORM representation of deployment data.

`ConcurrencyLimit`

An ORM representation of a concurrency limit.

`ConcurrencyLimitV2`

An ORM representation of a v2 concurrency limit.

`BlockType`

An ORM representation of a block type

`BlockSchema`

An ORM representation of a block schema.

`BlockSchemaReference`

An ORM representation of a block schema reference.

`BlockDocument`

An ORM representation of a block document. Methods:

`from_orm_model`

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`

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

`BlockDocumentReference`

An ORM representation of a block document reference. Methods:

`validate_parent_and_ref_are_different`

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

`Configuration`

An ORM representation of account info.

`ServerDefaultResultStorage`

Server-side default result storage configuration. Methods:

`model_validate_list`

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

`reset_fields`

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.

`ServerDefaultResultStorageUpdate`

Request payload for setting the server default result storage block. Methods:

`model_validate_list`

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

`reset_fields`

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.

`SavedSearchFilter`

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

`model_validate_list`

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

`reset_fields`

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`

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

`Log`

An ORM representation of log data.

`QueueFilter`

Filter criteria definition for a work queue. Methods:

`model_validate_list`

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

`reset_fields`

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`

An ORM representation of a work queue

`WorkQueueHealthPolicy`

Methods:

`evaluate_health_status`

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`

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

`reset_fields`

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`

Methods:

`model_validate_list`

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

`reset_fields`

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`

An ORM representation of an agent

`WorkPoolStorageConfiguration`

A representation of a work pool’s storage configuration Methods:

`model_validate_list`

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

`reset_fields`

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`

An ORM representation of a work pool Methods:

`helpful_error_for_missing_default_queue_id`

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

`model_validate`

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

`Worker`

An ORM representation of a worker

`Artifact`

Methods:

`from_result`

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

`validate_metadata_length`

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

API Reference

Documentation Index

​prefect.server.schemas.core

​Classes

​Flow

​FlowRunPolicy

​model_validate_list

​populate_deprecated_fields

​reset_fields

​CreatedBy

​UpdatedBy

​ConcurrencyLimitStrategy

​auto

​ConcurrencyOptions

​FlowRun

​set_name

​TaskRunPolicy

​model_validate_list

​populate_deprecated_fields

​reset_fields

​validate_configured_retry_delays

​validate_jitter_factor

​RunInput

​model_validate_list

​reset_fields

​TaskRunResult

​FlowRunResult

​Parameter

​Constant

​TaskRun

​set_name

​validate_cache_key

​DeploymentSchedule

​validate_max_scheduled_runs

​VersionInfo

​model_validate_list

​reset_fields

​Deployment

​ConcurrencyLimit

​ConcurrencyLimitV2

​BlockType

​BlockSchema

​BlockSchemaReference

​BlockDocument

​from_orm_model

​validate_name_is_present_if_not_anonymous

​BlockDocumentReference

​validate_parent_and_ref_are_different

​Configuration

​ServerDefaultResultStorage

​model_validate_list

​reset_fields

​ServerDefaultResultStorageUpdate

​model_validate_list

​reset_fields

​SavedSearchFilter

​model_validate_list

​reset_fields

​SavedSearch

​Log

​QueueFilter

​model_validate_list

​reset_fields

​WorkQueue

​WorkQueueHealthPolicy

​evaluate_health_status

​model_validate_list

​reset_fields

​WorkQueueStatusDetail

​model_validate_list

​reset_fields

​Agent

​WorkPoolStorageConfiguration

​model_validate_list

​reset_fields

​WorkPool

​helpful_error_for_missing_default_queue_id

​model_validate

​Worker

​Artifact

`prefect.server.schemas.core`

Classes

`Flow`

`FlowRunPolicy`

`model_validate_list`

`populate_deprecated_fields`

`reset_fields`

`CreatedBy`

`UpdatedBy`

`ConcurrencyLimitStrategy`

`auto`

`ConcurrencyOptions`

`FlowRun`

`set_name`

`TaskRunPolicy`

`model_validate_list`

`populate_deprecated_fields`

`reset_fields`

`validate_configured_retry_delays`

`validate_jitter_factor`

`RunInput`

`model_validate_list`

`reset_fields`

`TaskRunResult`

`FlowRunResult`

`Parameter`

`Constant`

`TaskRun`

`set_name`

`validate_cache_key`

`DeploymentSchedule`

`validate_max_scheduled_runs`

`VersionInfo`

`model_validate_list`

`reset_fields`

`Deployment`

`ConcurrencyLimit`

`ConcurrencyLimitV2`

`BlockType`

`BlockSchema`

`BlockSchemaReference`

`BlockDocument`

`from_orm_model`

`validate_name_is_present_if_not_anonymous`

`BlockDocumentReference`

`validate_parent_and_ref_are_different`

`Configuration`

`ServerDefaultResultStorage`

`model_validate_list`

`reset_fields`

`ServerDefaultResultStorageUpdate`

`model_validate_list`

`reset_fields`

`SavedSearchFilter`

`model_validate_list`

`reset_fields`

`SavedSearch`

`Log`

`QueueFilter`

`model_validate_list`

`reset_fields`

`WorkQueue`

`WorkQueueHealthPolicy`

`evaluate_health_status`

`model_validate_list`

`reset_fields`

`WorkQueueStatusDetail`

`model_validate_list`

`reset_fields`

`Agent`

`WorkPoolStorageConfiguration`

`model_validate_list`

`reset_fields`

`WorkPool`

`helpful_error_for_missing_default_queue_id`

`model_validate`

`Worker`

`Artifact`

`from_result`

`validate_metadata_length`