> ## 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. # objects # `prefect.client.schemas.objects` ## Functions ### `data_discriminator` ```python theme={null} data_discriminator(x: Any) -> str ``` ## Classes ### `RunType` **Methods:** #### `auto` ```python theme={null} auto() -> str ``` Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum` ### `StateType` Enumeration of state types. **Methods:** #### `auto` ```python theme={null} auto() -> str ``` Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum` ### `WorkPoolStatus` Enumeration of work pool statuses. **Methods:** #### `auto` ```python theme={null} auto() -> str ``` Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum` #### `display_name` ```python theme={null} display_name(self) -> str ``` ### `WorkerStatus` Enumeration of worker statuses. **Methods:** #### `auto` ```python theme={null} auto() -> str ``` Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum` ### `DeploymentStatus` Enumeration of deployment statuses. **Methods:** #### `auto` ```python theme={null} auto() -> str ``` Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum` ### `WorkQueueStatus` Enumeration of work queue statuses. **Methods:** #### `auto` ```python theme={null} auto() -> str ``` Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum` ### `ConcurrencyLimitStrategy` Enumeration of concurrency limit strategies. **Methods:** #### `auto` ```python theme={null} auto() -> str ``` Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum` ### `ConcurrencyOptions` Class for storing the concurrency config in database. **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. ### `ConcurrencyLimitConfig` Class for storing the concurrency limit config in database. **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. ### `ConcurrencyLeaseHolder` Model for validating concurrency lease holder information. **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. ### `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. #### `to_run_result` ```python theme={null} to_run_result(self, run_type: RunType) -> Optional[Union[FlowRunResult, TaskRunResult]] ``` ### `State` The state of a run. **Methods:** #### `aresult` ```python theme={null} aresult(self: 'State[R]', raise_on_failure: Literal[True] = ..., retry_result_failure: bool = ...) -> R ``` #### `aresult` ```python theme={null} aresult(self: 'State[R]', raise_on_failure: Literal[False] = False, retry_result_failure: bool = ...) -> Union[R, Exception] ``` #### `aresult` ```python theme={null} aresult(self: 'State[R]', raise_on_failure: bool = ..., retry_result_failure: bool = ...) -> Union[R, Exception] ``` #### `aresult` ```python theme={null} aresult(self, raise_on_failure: bool = True, retry_result_failure: bool = True) -> Union[R, Exception] ``` Retrieve the result attached to this state. #### `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. #### `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 ``` #### `model_copy` ```python theme={null} model_copy(self) -> Self ``` Copying API models should return an object that could be inserted into the database again. The 'timestamp' is reset using the default factory. #### `result` ```python theme={null} result(self: 'State[R]', raise_on_failure: Literal[True] = ..., retry_result_failure: bool = ...) -> R ``` #### `result` ```python theme={null} result(self: 'State[R]', raise_on_failure: Literal[False] = False, retry_result_failure: bool = ...) -> Union[R, Exception] ``` #### `result` ```python theme={null} result(self: 'State[R]', raise_on_failure: bool = ..., retry_result_failure: bool = ...) -> Union[R, Exception] ``` #### `result` ```python theme={null} result(self, raise_on_failure: bool = True, retry_result_failure: bool = True) -> Union[R, Exception] ``` Retrieve the result attached to this state. **Args:** * `raise_on_failure`: a boolean specifying whether to raise an exception if the state is of type `FAILED` and the underlying data is an exception. When flow was run in a different memory space (using `run_deployment`), this will only raise if `fetch` is `True`. * `retry_result_failure`: a boolean specifying whether to retry on failures to load the result from result storage **Raises:** * `TypeError`: If the state is failed but the result is not an exception. **Returns:** * The result of the run **Examples:** Get the result from a flow state ```python theme={null} @flow def my_flow(): return "hello" my_flow(return_state=True).result() # hello ``` Get the result from a failed state ```python theme={null} @flow def my_flow(): raise ValueError("oh no!") state = my_flow(return_state=True) # Error is wrapped in FAILED state state.result() # Raises `ValueError` ``` Get the result from a failed state without erroring ```python theme={null} @flow def my_flow(): raise ValueError("oh no!") state = my_flow(return_state=True) result = state.result(raise_on_failure=False) print(result) # ValueError("oh no!") ``` Get the result from a flow state in an async context ```python theme={null} @flow async def my_flow(): return "hello" state = await my_flow(return_state=True) await state.result() # hello ``` Get the result with `raise_on_failure` from a flow run in a different memory space ```python theme={null} @flow async def my_flow(): raise ValueError("oh no!") my_flow.deploy("my_deployment/my_flow") flow_run = run_deployment("my_deployment/my_flow") await flow_run.state.result(raise_on_failure=True) # Raises `ValueError("oh no!")` ``` #### `set_unpersisted_results_to_none` ```python theme={null} set_unpersisted_results_to_none(self) -> Self ``` ### `FlowRunPolicy` Defines of how a flow run should be orchestrated. **Methods:** #### `model_validate_list` ```python theme={null} model_validate_list(cls, obj: Any) -> list[Self] ``` #### `populate_deprecated_fields` ```python theme={null} populate_deprecated_fields(cls, values: Any) -> Any ``` #### `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. ### `FlowRun` **Methods:** #### `set_default_name` ```python theme={null} set_default_name(cls, name: Optional[str]) -> str ``` ### `TaskRunPolicy` Defines of how a task run should retry. **Methods:** #### `model_validate_list` ```python theme={null} model_validate_list(cls, obj: Any) -> list[Self] ``` #### `populate_deprecated_fields` ```python theme={null} populate_deprecated_fields(self) ``` If deprecated fields are provided, populate the corresponding new fields to preserve orchestration behavior. #### `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. #### `validate_configured_retry_delays` ```python theme={null} validate_configured_retry_delays(cls, v: Optional[int | float | list[int] | list[float]]) -> Optional[int | float | list[int] | list[float]] ``` #### `validate_jitter_factor` ```python theme={null} validate_jitter_factor(cls, v: Optional[float]) -> Optional[float] ``` ### `RunInput` Base class for classes that represent inputs to task runs, which could include, constants, parameters, or other task runs. **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. ### `TaskRunResult` Represents a task run result input to another task run. ### `FlowRunResult` ### `Parameter` Represents a parameter input to a task run. ### `Constant` Represents constant input value to a task run. ### `TaskRun` **Methods:** #### `set_default_name` ```python theme={null} set_default_name(cls, name: Optional[str]) -> Name ``` ### `Workspace` A Prefect Cloud workspace. Expected payload for each workspace returned by the `me/workspaces` route. **Methods:** #### `api_url` ```python theme={null} api_url(self) -> str ``` Generate the API URL for accessing this workspace #### `handle` ```python theme={null} handle(self) -> str ``` The full handle of the workspace as `account_handle` / `workspace_handle` #### `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. #### `ui_url` ```python theme={null} ui_url(self) -> str ``` Generate the UI URL for accessing this workspace ### `IPAllowlistEntry` **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. ### `IPAllowlist` A Prefect Cloud IP allowlist. Expected payload for an IP allowlist from the Prefect Cloud API. **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. ### `IPAllowlistMyAccessResponse` Expected payload for an IP allowlist access response from the Prefect Cloud API. **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. ### `BlockType` An ORM representation of a block type ### `BlockSchema` A representation of a block schema. ### `BlockDocument` An ORM representation of a block document. **Methods:** #### `serialize_data` ```python theme={null} serialize_data(self, handler: SerializerFunctionWrapHandler, info: SerializationInfo) -> Any ``` #### `validate_name_is_present_if_not_anonymous` ```python theme={null} validate_name_is_present_if_not_anonymous(cls, values: dict[str, Any]) -> dict[str, Any] ``` ### `Flow` An ORM representation of flow data. ### `DeploymentSchedule` ### `VersionInfo` **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. ### `BranchingScheduleHandling` ### `DeploymentBranchingOptions` ### `Deployment` An ORM representation of deployment data. ### `ConcurrencyLimit` An ORM representation of a concurrency limit. ### `BlockSchemaReference` An ORM representation of a block schema reference. ### `BlockDocumentReference` An ORM representation of a block document reference. **Methods:** #### `validate_parent_and_ref_are_different` ```python theme={null} validate_parent_and_ref_are_different(cls, values: Any) -> Any ``` ### `Configuration` An ORM representation of account info. ### `SavedSearchFilter` A filter for a saved search model. Intended for use by the Prefect UI. **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. ### `SavedSearch` An ORM representation of saved search data. Represents a set of filter criteria. ### `Log` An ORM representation of log data. ### `QueueFilter` Filter criteria definition for a work queue. **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. ### `WorkQueue` An ORM representation of a work queue ### `WorkQueueHealthPolicy` **Methods:** #### `evaluate_health_status` ```python theme={null} evaluate_health_status(self, late_runs_count: int, last_polled: datetime.datetime | None = None) -> bool ``` Given empirical information about the state of the work queue, evaluate its health status. **Args:** * `late_runs`: the count of late runs for the work queue. * `last_polled`: the last time the work queue was polled, if available. **Returns:** * whether or not the work queue is healthy. #### `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. ### `WorkQueueStatusDetail` **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. ### `Agent` An ORM representation of an agent ### `WorkPoolStorageConfiguration` A work pool storage configuration **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. ### `WorkPool` An ORM representation of a work pool **Methods:** #### `helpful_error_for_missing_default_queue_id` ```python theme={null} helpful_error_for_missing_default_queue_id(cls, v: Optional[UUID]) -> UUID ``` #### `is_managed_pool` ```python theme={null} is_managed_pool(self) -> bool ``` #### `is_push_pool` ```python theme={null} is_push_pool(self) -> bool ``` ### `Worker` An ORM representation of a worker ### `Artifact` **Methods:** #### `validate_metadata_length` ```python theme={null} validate_metadata_length(cls, v: Optional[dict[str, str]]) -> Optional[dict[str, str]] ``` ### `ArtifactCollection` ### `Variable` ### `FlowRunInput` **Methods:** #### `decoded_value` ```python theme={null} decoded_value(self) -> Any ``` Decode the value of the input. **Returns:** * the decoded value ### `GlobalConcurrencyLimit` An ORM representation of a global concurrency limit ### `CsrfToken` ### `Integration` A representation of an installed Prefect integration. **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. ### `WorkerMetadata` Worker metadata. We depend on the structure of `integrations`, but otherwise, worker classes should support flexible metadata. **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. Built with [Mintlify](https://mintlify.com).