prefect.server.schemas.responses

Schemas for special responses from the Prefect REST API.

Classes

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

Enumerates return statuses for setting run states.

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

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

Details associated with an ACCEPT state transition.

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.

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

Details associated with a REJECT state transition.

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.

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

Details associated with an ABORT state transition.

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.

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

Details associated with a WAIT state transition.

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.

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

Represents a single state's history over an interval.

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.

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

Represents a history of aggregation states over an interval

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.

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

validate_timestamps(cls, values: dict) -> dict

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

A container for the output of state orchestration.

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.

WorkerFlowRunResponse ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/responses.py#L168" 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.

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

Methods:

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

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

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

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

Methods:

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

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

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

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

Methods:

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

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

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

Combines a work queue and its status details into a single object

Methods:

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

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

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

Methods:

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

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

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

A response object for global concurrency limits.

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

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

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

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

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

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

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

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

Response from bulk flow run deletion.

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.

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

Response from bulk deployment deletion.

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.

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

Response from bulk flow deletion.

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.

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

Per-run result for bulk state operations.

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.

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

Response from bulk set state operation.

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.

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

Per-run result for bulk create operations.

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.

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

Response from bulk flow run creation.

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.

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

Summary of a flow run occupying a concurrency slot.

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.

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

Per-queue concurrency status with flow run details.

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.

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

Paginated pool-level concurrency status with per-queue breakdown.

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.

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

Paginated queue-level concurrency status with flow run details.

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.