`prefect.server.schemas.responses`

Schemas for special responses from the Prefect REST API.

Classes

`SetStateStatus`

Enumerates return statuses for setting run states. Methods:

`auto`

auto() -> str

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

`StateAcceptDetails`

Details associated with an ACCEPT state transition. 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.

`StateRejectDetails`

Details associated with a REJECT state transition. 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.

`StateAbortDetails`

Details associated with an ABORT state transition. 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.

`StateWaitDetails`

Details associated with a WAIT state transition. 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.

`HistoryResponseState`

Represents a single state’s history over an interval. 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.

`HistoryResponse`

Represents a history of aggregation states over an interval 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.

`validate_timestamps`

validate_timestamps(cls, values: dict) -> dict

`OrchestrationResult`

A container for the output of state orchestration. 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.

`WorkerFlowRunResponse`

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.

`FlowRunResponse`

Methods:

`model_validate`

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

`TaskRunResponse`

`DeploymentResponse`

Methods:

`model_validate`

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

`WorkPoolResponse`

`WorkQueueResponse`

Methods:

`model_validate`

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

`WorkQueueWithStatus`

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

`model_validate`

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

`WorkerResponse`

Methods:

`model_validate`

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

`GlobalConcurrencyLimitResponse`

A response object for global concurrency limits.

`FlowPaginationResponse`

`FlowRunPaginationResponse`

`TaskRunPaginationResponse`

`DeploymentPaginationResponse`

`SchemaValuePropertyError`

`SchemaValueIndexError`

`SchemaValuesValidationResponse`

`FlowRunBulkDeleteResponse`

Response from bulk flow run deletion. 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.

`DeploymentBulkDeleteResponse`

Response from bulk deployment deletion. 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.

`FlowBulkDeleteResponse`

Response from bulk flow deletion. 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.

`FlowRunOrchestrationResult`

Per-run result for bulk state operations. 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.

`FlowRunBulkSetStateResponse`

Response from bulk set state operation. 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.

`FlowRunCreateResult`

Per-run result for bulk create operations. 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.

`FlowRunBulkCreateResponse`

Response from bulk flow run creation. 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.

`FlowRunSlotSummary`

Summary of a flow run occupying a concurrency slot. 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.

`WorkQueueConcurrencyStatusDetail`

Per-queue concurrency status with flow run details. 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.

`WorkPoolConcurrencyStatus`

Paginated pool-level concurrency status with per-queue breakdown. 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.

`WorkQueueConcurrencyStatus`

Paginated queue-level concurrency status with flow run details. 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.

API Reference

Documentation Index

​prefect.server.schemas.responses

​Classes

​SetStateStatus

​auto

​StateAcceptDetails

​model_validate_list

​reset_fields

​StateRejectDetails

​model_validate_list

​reset_fields

​StateAbortDetails

​model_validate_list

​reset_fields

​StateWaitDetails

​model_validate_list

​reset_fields

​HistoryResponseState

​model_validate_list

​reset_fields

​HistoryResponse

​model_validate_list

​reset_fields

​validate_timestamps

​OrchestrationResult

​model_validate_list

​reset_fields

​WorkerFlowRunResponse

​model_validate_list

​reset_fields

​FlowRunResponse

​model_validate

​TaskRunResponse

​DeploymentResponse

​model_validate

​WorkPoolResponse

​WorkQueueResponse

​model_validate

​WorkQueueWithStatus

​model_validate

​WorkerResponse

​model_validate

​GlobalConcurrencyLimitResponse

​FlowPaginationResponse

​FlowRunPaginationResponse

​TaskRunPaginationResponse

​DeploymentPaginationResponse

​SchemaValuePropertyError

​SchemaValueIndexError

​SchemaValuesValidationResponse

​FlowRunBulkDeleteResponse

​model_validate_list

​reset_fields

​DeploymentBulkDeleteResponse

​model_validate_list

​reset_fields

​FlowBulkDeleteResponse

​model_validate_list

​reset_fields

​FlowRunOrchestrationResult

​model_validate_list

​reset_fields

​FlowRunBulkSetStateResponse

​model_validate_list

​reset_fields

​FlowRunCreateResult

​model_validate_list

​reset_fields

​FlowRunBulkCreateResponse

​model_validate_list

​reset_fields

​FlowRunSlotSummary

​model_validate_list

​reset_fields

​WorkQueueConcurrencyStatusDetail

​model_validate_list

​reset_fields

​WorkPoolConcurrencyStatus

​model_validate_list

`prefect.server.schemas.responses`

Classes

`SetStateStatus`

`auto`

`StateAcceptDetails`

`model_validate_list`

`reset_fields`

`StateRejectDetails`

`model_validate_list`

`reset_fields`

`StateAbortDetails`

`model_validate_list`

`reset_fields`

`StateWaitDetails`

`model_validate_list`

`reset_fields`

`HistoryResponseState`

`model_validate_list`

`reset_fields`

`HistoryResponse`

`model_validate_list`

`reset_fields`

`validate_timestamps`

`OrchestrationResult`

`model_validate_list`

`reset_fields`

`WorkerFlowRunResponse`

`model_validate_list`

`reset_fields`

`FlowRunResponse`

`model_validate`

`TaskRunResponse`

`DeploymentResponse`

`model_validate`

`WorkPoolResponse`

`WorkQueueResponse`

`model_validate`

`WorkQueueWithStatus`

`model_validate`

`WorkerResponse`

`model_validate`

`GlobalConcurrencyLimitResponse`

`FlowPaginationResponse`

`FlowRunPaginationResponse`

`TaskRunPaginationResponse`

`DeploymentPaginationResponse`

`SchemaValuePropertyError`

`SchemaValueIndexError`

`SchemaValuesValidationResponse`

`FlowRunBulkDeleteResponse`

`model_validate_list`

`reset_fields`

`DeploymentBulkDeleteResponse`

`model_validate_list`

`reset_fields`

`FlowBulkDeleteResponse`

`model_validate_list`

`reset_fields`

`FlowRunOrchestrationResult`

`model_validate_list`

`reset_fields`

`FlowRunBulkSetStateResponse`

`model_validate_list`

`reset_fields`

`FlowRunCreateResult`

`model_validate_list`

`reset_fields`

`FlowRunBulkCreateResponse`

`model_validate_list`

`reset_fields`

`FlowRunSlotSummary`

`model_validate_list`

`reset_fields`

`WorkQueueConcurrencyStatusDetail`

`model_validate_list`

`reset_fields`

`WorkPoolConcurrencyStatus`

`model_validate_list`

`reset_fields`

`WorkQueueConcurrencyStatus`