Skip to main content

​
prefect.server.schemas.states

State schemas.

​
Functions

​
Scheduled 

Scheduled(scheduled_time: Optional[DateTime] = None, cls: type[_State] = State, **kwargs: Any) -> _State
Convenience function for creating Scheduled states. Returns:
  • a Scheduled state

​
Completed 

Completed(cls: type[_State] = State, **kwargs: Any) -> _State
Convenience function for creating Completed states. Returns:
  • a Completed state

​
Running 

Running(cls: type[_State] = State, **kwargs: Any) -> _State
Convenience function for creating Running states. Returns:
  • a Running state

​
Failed 

Failed(cls: type[_State] = State, **kwargs: Any) -> _State
Convenience function for creating Failed states. Returns:
  • a Failed state

​
Crashed 

Crashed(cls: type[_State] = State, **kwargs: Any) -> _State
Convenience function for creating Crashed states. Returns:
  • a Crashed state

​
Cancelling 

Cancelling(cls: type[_State] = State, **kwargs: Any) -> _State
Convenience function for creating Cancelling states. Returns:
  • a Cancelling state

​
Cancelled 

Cancelled(cls: type[_State] = State, **kwargs: Any) -> _State
Convenience function for creating Cancelled states. Returns:
  • a Cancelled state

​
Pending 

Pending(cls: type[_State] = State, **kwargs: Any) -> _State
Convenience function for creating Pending states. Returns:
  • a Pending state

​
Paused 

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 

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 

AwaitingRetry(cls: type[_State] = State, scheduled_time: Optional[DateTime] = None, **kwargs: Any) -> _State
Convenience function for creating AwaitingRetry states. Returns:
  • an AwaitingRetry state

​
AwaitingConcurrencySlot 

AwaitingConcurrencySlot(cls: type[_State] = State, scheduled_time: Optional[DateTime] = None, **kwargs: Any) -> _State
Convenience function for creating AwaitingConcurrencySlot states. Returns:
  • an AwaitingConcurrencySlot state

​
Retrying 

Retrying(cls: type[_State] = State, **kwargs: Any) -> _State
Convenience function for creating Retrying states. Returns:
  • a Retrying state

​
Late 

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

Enumeration of state types. Methods:

​
auto 

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

​
CountByState

Methods:

​
check_key 

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

​
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.

​
StateDetails

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.

​
StateBaseModel

Methods:

​
orm_dict 

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

Represents the state of a run. Methods:

​
default_name_from_type 

default_name_from_type(self) -> Self
If a name is not provided, use the type

​
default_scheduled_start_time 

default_scheduled_start_time(self) -> Self

​
fresh_copy 

fresh_copy(self, **kwargs: Any) -> Self
Return a fresh copy of the state with a new ID.

​
from_orm_without_result 

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 

is_cancelled(self) -> bool

​
is_cancelling 

is_cancelling(self) -> bool

​
is_completed 

is_completed(self) -> bool

​
is_crashed 

is_crashed(self) -> bool

​
is_failed 

is_failed(self) -> bool

​
is_final 

is_final(self) -> bool

​
is_paused 

is_paused(self) -> bool

​
is_pending 

is_pending(self) -> bool

​
is_running 

is_running(self) -> bool

​
is_scheduled 

is_scheduled(self) -> bool

​
orm_dict 

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 

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

​
result 

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

​
result 

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

​
result 

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

​
to_state_create 

to_state_create(self) -> 'StateCreate'
⌘I