prefect.client.schemas.objects

Functions

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

data_discriminator(x: Any) -> str

Classes

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

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

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

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

Enumeration of work pool statuses.

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

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

display_name(self) -> str

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

Enumeration of worker statuses.

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

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

Enumeration of deployment statuses.

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

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

Enumeration of work queue statuses.

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

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

Enumeration of concurrency limit strategies.

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

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

Class for storing the concurrency config in database.

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.

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

Class for storing the concurrency limit config in database.

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.

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

Model for validating concurrency lease holder information.

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.

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

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

to_run_result(self, run_type: RunType) -> Optional[Union[FlowRunResult, TaskRunResult]]

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

The state of a run.

Methods:

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

aresult(self: 'State[R]', raise_on_failure: Literal[True] = ..., retry_result_failure: bool = ...) -> R

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

aresult(self: 'State[R]', raise_on_failure: Literal[False] = False, retry_result_failure: bool = ...) -> Union[R, Exception]

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

aresult(self: 'State[R]', raise_on_failure: bool = ..., retry_result_failure: bool = ...) -> Union[R, Exception]

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

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

is_cancelled ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L443" 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/client/schemas/objects.py#L446" 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/client/schemas/objects.py#L434" 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/client/schemas/objects.py#L440" 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/client/schemas/objects.py#L437" 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/client/schemas/objects.py#L449" 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/client/schemas/objects.py#L452" 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/client/schemas/objects.py#L428" 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/client/schemas/objects.py#L431" 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/client/schemas/objects.py#L425" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

is_scheduled(self) -> bool

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

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

result(self: 'State[R]', raise_on_failure: Literal[True] = ..., retry_result_failure: bool = ...) -> R

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

result(self: 'State[R]', raise_on_failure: Literal[False] = False, retry_result_failure: bool = ...) -> Union[R, Exception]

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

result(self: 'State[R]', raise_on_failure: bool = ..., retry_result_failure: bool = ...) -> Union[R, Exception]

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

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

@flow
def my_flow():
    return "hello"
my_flow(return_state=True).result()
# hello

Get the result from a failed state

@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

@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

@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

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

set_unpersisted_results_to_none(self) -> Self

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

Defines of how a flow run should be orchestrated.

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]

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

populate_deprecated_fields(cls, values: Any) -> Any

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.

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

Methods:

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

set_default_name(cls, name: Optional[str]) -> str

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

Defines of how a task run should retry.

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]

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

populate_deprecated_fields(self)

If deprecated fields are provided, populate the corresponding new fields to preserve orchestration behavior.

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.

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

validate_configured_retry_delays(cls, v: Optional[int | float | list[int] | list[float]]) -> Optional[int | float | list[int] | list[float]]

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

validate_jitter_factor(cls, v: Optional[float]) -> Optional[float]

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

Base class for classes that represent inputs to task runs, which could include, constants, parameters, or other task runs.

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.

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

Represents a task run result input to another task run.

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

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

Represents a parameter input to a task run.

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

Represents constant input value to a task run.

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

Methods:

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

set_default_name(cls, name: Optional[str]) -> Name

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

A Prefect Cloud workspace.

Expected payload for each workspace returned by the me/workspaces route.

Methods:

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

api_url(self) -> str

Generate the API URL for accessing this workspace

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

handle(self) -> str

The full handle of the workspace as account_handle / workspace_handle

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.

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

ui_url(self) -> str

Generate the UI URL for accessing this workspace

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

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

A Prefect Cloud IP allowlist.

Expected payload for an IP allowlist from the Prefect Cloud API.

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.

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

Expected payload for an IP allowlist access response from the Prefect Cloud API.

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.

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

An ORM representation of a block type

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

A representation of a block schema.

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

An ORM representation of a block document.

Methods:

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

serialize_data(self, handler: SerializerFunctionWrapHandler, info: SerializationInfo) -> Any

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

validate_name_is_present_if_not_anonymous(cls, values: dict[str, Any]) -> dict[str, Any]

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

An ORM representation of flow data.

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

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

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

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

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

An ORM representation of deployment data.

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

An ORM representation of a concurrency limit.

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

An ORM representation of a block schema reference.

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

An ORM representation of a block document reference.

Methods:

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

validate_parent_and_ref_are_different(cls, values: Any) -> Any

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

An ORM representation of account info.

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

A filter for a saved search model. Intended for use by the Prefect UI.

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.

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

An ORM representation of saved search data. Represents a set of filter criteria.

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

An ORM representation of log data.

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

Filter criteria definition for a work queue.

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.

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

An ORM representation of a work queue

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

Methods:

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

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 ^{<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.

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

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

An ORM representation of an agent

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

A work pool storage configuration

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.

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

An ORM representation of a work pool

Methods:

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

helpful_error_for_missing_default_queue_id(cls, v: Optional[UUID]) -> UUID

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

is_managed_pool(self) -> bool

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

is_push_pool(self) -> bool

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

An ORM representation of a worker

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

Methods:

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

validate_metadata_length(cls, v: Optional[dict[str, str]]) -> Optional[dict[str, str]]

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

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

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

Methods:

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

decoded_value(self) -> Any

Decode the value of the input.

Returns:

• the decoded value

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

An ORM representation of a global concurrency limit

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

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

A representation of an installed Prefect integration.

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.

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

Worker metadata.

We depend on the structure of integrations, but otherwise, worker classes should support flexible metadata.

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.