prefect.client.schemas.responses

Classes

SetStateStatus ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L31" 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/client/schemas/responses.py#L40" 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/client/schemas/responses.py#L52" 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/client/schemas/responses.py#L67" 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/client/schemas/responses.py#L82" 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/client/schemas/responses.py#L104" 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/client/schemas/responses.py#L126" 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.

OrchestrationResult ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L145" 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/client/schemas/responses.py#L155" 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/client/schemas/responses.py#L163" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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

Methods:

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

as_related_resource(self, role: str = 'deployment') -> 'RelatedResource'

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

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

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

A response object for global concurrency limits.

FlowRunSlotSummary ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L516" 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/client/schemas/responses.py#L533" 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/client/schemas/responses.py#L544" 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/client/schemas/responses.py#L556" 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.