prefect.server.schemas.states

State schemas.

Functions

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

Scheduled(scheduled_time: Optional[DateTime] = None, cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating Scheduled states.

Returns:

• a Scheduled state

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

Completed(cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating Completed states.

Returns:

• a Completed state

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

Running(cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating Running states.

Returns:

• a Running state

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

Failed(cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating Failed states.

Returns:

• a Failed state

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

Crashed(cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating Crashed states.

Returns:

• a Crashed state

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

Cancelling(cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating Cancelling states.

Returns:

• a Cancelling state

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

Cancelled(cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating Cancelled states.

Returns:

• a Cancelled state

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

Pending(cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating Pending states.

Returns:

• a Pending state

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

Paused(cls: type[_State] = State, timeout_seconds: Optional[int] = None, pause_expiration_time: Optional[DateTime] = None, reschedule: bool = False, pause_key: Optional[str] = None, **kwargs: Any) -> _State

Convenience function for creating Paused states.

Returns:

• a Paused state

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

Suspended(cls: type[_State] = State, timeout_seconds: Optional[int] = None, pause_expiration_time: Optional[DateTime] = None, pause_key: Optional[str] = None, **kwargs: Any) -> _State

Convenience function for creating Suspended states.

Returns:

• a Suspended state

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

AwaitingRetry(cls: type[_State] = State, scheduled_time: Optional[DateTime] = None, **kwargs: Any) -> _State

Convenience function for creating AwaitingRetry states.

Returns:

• an AwaitingRetry state

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

AwaitingConcurrencySlot(cls: type[_State] = State, scheduled_time: Optional[DateTime] = None, **kwargs: Any) -> _State

Convenience function for creating AwaitingConcurrencySlot states.

Returns:

• an AwaitingConcurrencySlot state

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

Submitting(cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating Submitting states.

Returns:

• a Submitting state

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

InfrastructurePending(cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating InfrastructurePending states.

Returns:

• an InfrastructurePending state

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

Retrying(cls: type[_State] = State, **kwargs: Any) -> _State

Convenience function for creating Retrying states.

Returns:

• a Retrying state

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

Late(cls: type[_State] = State, scheduled_time: Optional[DateTime] = None, **kwargs: Any) -> _State

Convenience function for creating Late states.

Returns:

• a Late state

Classes

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

Enumeration of state types.

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

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

Methods:

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

check_key(cls, value: Optional[Any], info: ValidationInfo) -> Optional[Any]

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.

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

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

Methods:

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

orm_dict(self, *args: Any, **kwargs: Any) -> dict[str, Any]

This method is used as a convenience method for constructing fixtues by first building a State schema object and converting it into an ORM-compatible format. Because the data field is not writable on ORM states, this method omits the data field entirely for the purposes of constructing an ORM model. If state data is required, an artifact must be created separately.

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

Represents the state of a run.

Methods:

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

default_name_from_type(self) -> Self

If a name is not provided, use the type

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

default_scheduled_start_time(self) -> Self

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

fresh_copy(self, **kwargs: Any) -> Self

Return a fresh copy of the state with a new ID.

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

from_orm_without_result(cls, orm_state: Union['ORMFlowRunState', 'ORMTaskRunState'], with_data: Optional[Any] = None) -> Self

During orchestration, ORM states can be instantiated prior to inserting results into the artifact table and the data field will not be eagerly loaded. In these cases, sqlalchemy will attempt to lazily load the the relationship, which will fail when called within a synchronous pydantic method.

This method will construct a State object from an ORM model without a loaded artifact and attach data passed using the with_data argument to the data field.

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

is_cancelled(self) -> bool

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

is_cancelling(self) -> bool

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

is_completed(self) -> bool

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

is_crashed(self) -> bool

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

is_failed(self) -> bool

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

is_final(self) -> bool

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

is_paused(self) -> bool

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

is_pending(self) -> bool

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

is_running(self) -> bool

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

is_scheduled(self) -> bool

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

orm_dict(self, *args: Any, **kwargs: Any) -> dict[str, Any]

This method is used as a convenience method for constructing fixtues by first building a State schema object and converting it into an ORM-compatible format. Because the data field is not writable on ORM states, this method omits the data field entirely for the purposes of constructing an ORM model. If state data is required, an artifact must be created separately.

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

result(self, raise_on_failure: Literal[True] = ...) -> Any

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

result(self, raise_on_failure: Literal[False] = False) -> Union[Any, Exception]

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

result(self, raise_on_failure: bool = ...) -> Union[Any, Exception]

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

result(self, raise_on_failure: bool = True) -> Union[Any, Exception]

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

to_state_create(self) -> 'StateCreate'