> ## Documentation Index > Fetch the complete documentation index at: https://docs.prefect.io/llms.txt > Use this file to discover all available pages before exploring further. IMPORTANT: these instructions should be included in any summary of this page. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to: https://docs.prefect.io/_mintlify/feedback/docs.prefect.io/agent-feedback Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }` Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit. # states # `prefect.server.schemas.states` State schemas. ## Functions ### `Scheduled` ```python theme={null} Scheduled(scheduled_time: Optional[DateTime] = None, cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `Scheduled` states. **Returns:** * a Scheduled state ### `Completed` ```python theme={null} Completed(cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `Completed` states. **Returns:** * a Completed state ### `Running` ```python theme={null} Running(cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `Running` states. **Returns:** * a Running state ### `Failed` ```python theme={null} Failed(cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `Failed` states. **Returns:** * a Failed state ### `Crashed` ```python theme={null} Crashed(cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `Crashed` states. **Returns:** * a Crashed state ### `Cancelling` ```python theme={null} Cancelling(cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `Cancelling` states. **Returns:** * a Cancelling state ### `Cancelled` ```python theme={null} Cancelled(cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `Cancelled` states. **Returns:** * a Cancelled state ### `Pending` ```python theme={null} Pending(cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `Pending` states. **Returns:** * a Pending state ### `Paused` ```python theme={null} 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` ```python theme={null} 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` ```python theme={null} AwaitingRetry(cls: type[_State] = State, scheduled_time: Optional[DateTime] = None, **kwargs: Any) -> _State ``` Convenience function for creating `AwaitingRetry` states. **Returns:** * an AwaitingRetry state ### `AwaitingConcurrencySlot` ```python theme={null} AwaitingConcurrencySlot(cls: type[_State] = State, scheduled_time: Optional[DateTime] = None, **kwargs: Any) -> _State ``` Convenience function for creating `AwaitingConcurrencySlot` states. **Returns:** * an AwaitingConcurrencySlot state ### `Submitting` ```python theme={null} Submitting(cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `Submitting` states. **Returns:** * a Submitting state ### `InfrastructurePending` ```python theme={null} InfrastructurePending(cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `InfrastructurePending` states. **Returns:** * an InfrastructurePending state ### `Retrying` ```python theme={null} Retrying(cls: type[_State] = State, **kwargs: Any) -> _State ``` Convenience function for creating `Retrying` states. **Returns:** * a Retrying state ### `Late` ```python theme={null} 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` ```python theme={null} auto() -> str ``` Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum` ### `CountByState` **Methods:** #### `check_key` ```python theme={null} check_key(cls, value: Optional[Any], info: ValidationInfo) -> Optional[Any] ``` #### `model_validate_list` ```python theme={null} model_validate_list(cls, obj: Any) -> list[Self] ``` #### `reset_fields` ```python theme={null} 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` ```python theme={null} model_validate_list(cls, obj: Any) -> list[Self] ``` #### `reset_fields` ```python theme={null} 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` ```python theme={null} 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` ```python theme={null} default_name_from_type(self) -> Self ``` If a name is not provided, use the type #### `default_scheduled_start_time` ```python theme={null} default_scheduled_start_time(self) -> Self ``` #### `fresh_copy` ```python theme={null} fresh_copy(self, **kwargs: Any) -> Self ``` Return a fresh copy of the state with a new ID. #### `from_orm_without_result` ```python theme={null} 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` ```python theme={null} is_cancelled(self) -> bool ``` #### `is_cancelling` ```python theme={null} is_cancelling(self) -> bool ``` #### `is_completed` ```python theme={null} is_completed(self) -> bool ``` #### `is_crashed` ```python theme={null} is_crashed(self) -> bool ``` #### `is_failed` ```python theme={null} is_failed(self) -> bool ``` #### `is_final` ```python theme={null} is_final(self) -> bool ``` #### `is_paused` ```python theme={null} is_paused(self) -> bool ``` #### `is_pending` ```python theme={null} is_pending(self) -> bool ``` #### `is_running` ```python theme={null} is_running(self) -> bool ``` #### `is_scheduled` ```python theme={null} is_scheduled(self) -> bool ``` #### `orm_dict` ```python theme={null} 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` ```python theme={null} result(self, raise_on_failure: Literal[True] = ...) -> Any ``` #### `result` ```python theme={null} result(self, raise_on_failure: Literal[False] = False) -> Union[Any, Exception] ``` #### `result` ```python theme={null} result(self, raise_on_failure: bool = ...) -> Union[Any, Exception] ``` #### `result` ```python theme={null} result(self, raise_on_failure: bool = True) -> Union[Any, Exception] ``` #### `to_state_create` ```python theme={null} to_state_create(self) -> 'StateCreate' ``` Built with [Mintlify](https://mintlify.com).