> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# objects

# `prefect.client.schemas.objects`

## Functions

### `data_discriminator` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L231](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L231)</sup>

```python theme={null}
data_discriminator(x: Any) -> str
```

## Classes

### `RunType` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L84](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L84)</sup>

**Methods:**

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</sup>

```python theme={null}
auto() -> str
```

Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum`

### `StateType` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L89](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L89)</sup>

Enumeration of state types.

**Methods:**

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</sup>

```python theme={null}
auto() -> str
```

Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum`

### `WorkPoolStatus` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L111](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L111)</sup>

Enumeration of work pool statuses.

**Methods:**

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</sup>

```python theme={null}
auto() -> str
```

Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum`

#### `display_name` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L119](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L119)</sup>

```python theme={null}
display_name(self) -> str
```

### `WorkerStatus` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L123](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L123)</sup>

Enumeration of worker statuses.

**Methods:**

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</sup>

```python theme={null}
auto() -> str
```

Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum`

### `DeploymentStatus` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L130](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L130)</sup>

Enumeration of deployment statuses.

**Methods:**

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</sup>

```python theme={null}
auto() -> str
```

Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum`

### `WorkQueueStatus` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L138](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L138)</sup>

Enumeration of work queue statuses.

**Methods:**

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</sup>

```python theme={null}
auto() -> str
```

Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum`

### `ConcurrencyLimitStrategy` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L146](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L146)</sup>

Enumeration of concurrency limit strategies.

**Methods:**

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</sup>

```python theme={null}
auto() -> str
```

Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum`

### `ConcurrencyOptions` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L153](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L153)</sup>

Class for storing the concurrency config in database.

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L167](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L167)</sup>

Class for storing the concurrency limit config in database.

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L182](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L182)</sup>

Model for validating concurrency lease holder information.

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L191](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L191)</sup>

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L214](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L214)</sup>

```python theme={null}
to_run_result(self, run_type: RunType) -> Optional[Union[FlowRunResult, TaskRunResult]]
```

### `State` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L237](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L237)</sup>

The state of a run.

**Methods:**

#### `aresult` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L256](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L256)</sup>

```python theme={null}
aresult(self: 'State[R]', raise_on_failure: Literal[True] = ..., retry_result_failure: bool = ...) -> R
```

#### `aresult` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L263](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L263)</sup>

```python theme={null}
aresult(self: 'State[R]', raise_on_failure: Literal[False] = False, retry_result_failure: bool = ...) -> Union[R, Exception]
```

#### `aresult` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L270](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L270)</sup>

```python theme={null}
aresult(self: 'State[R]', raise_on_failure: bool = ..., retry_result_failure: bool = ...) -> Union[R, Exception]
```

#### `aresult` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L276](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L276)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L403](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L403)</sup>

```python theme={null}
default_name_from_type(self) -> Self
```

If a name is not provided, use the type

#### `default_scheduled_start_time` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L413](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L413)</sup>

```python theme={null}
default_scheduled_start_time(self) -> Self
```

#### `fresh_copy` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L468](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L468)</sup>

```python theme={null}
fresh_copy(self, **kwargs: Any) -> Self
```

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

#### `is_cancelled` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L443](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L443)</sup>

```python theme={null}
is_cancelled(self) -> bool
```

#### `is_cancelling` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L446](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L446)</sup>

```python theme={null}
is_cancelling(self) -> bool
```

#### `is_completed` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L434](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L434)</sup>

```python theme={null}
is_completed(self) -> bool
```

#### `is_crashed` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L440](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L440)</sup>

```python theme={null}
is_crashed(self) -> bool
```

#### `is_failed` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L437](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L437)</sup>

```python theme={null}
is_failed(self) -> bool
```

#### `is_final` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L449](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L449)</sup>

```python theme={null}
is_final(self) -> bool
```

#### `is_paused` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L452](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L452)</sup>

```python theme={null}
is_paused(self) -> bool
```

#### `is_pending` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L428](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L428)</sup>

```python theme={null}
is_pending(self) -> bool
```

#### `is_running` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L431](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L431)</sup>

```python theme={null}
is_running(self) -> bool
```

#### `is_scheduled` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L425](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L425)</sup>

```python theme={null}
is_scheduled(self) -> bool
```

#### `model_copy` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L455](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L455)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L293](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L293)</sup>

```python theme={null}
result(self: 'State[R]', raise_on_failure: Literal[True] = ..., retry_result_failure: bool = ...) -> R
```

#### `result` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L300](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L300)</sup>

```python theme={null}
result(self: 'State[R]', raise_on_failure: Literal[False] = False, retry_result_failure: bool = ...) -> Union[R, Exception]
```

#### `result` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L307](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L307)</sup>

```python theme={null}
result(self: 'State[R]', raise_on_failure: bool = ..., retry_result_failure: bool = ...) -> Union[R, Exception]
```

#### `result` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L314](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L314)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L420](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L420)</sup>

```python theme={null}
set_unpersisted_results_to_none(self) -> Self
```

### `FlowRunPolicy` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L529](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L529)</sup>

Defines of how a flow run should be orchestrated.

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `populate_deprecated_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L564](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L564)</sup>

```python theme={null}
populate_deprecated_fields(cls, values: Any) -> Any
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L570](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L570)</sup>

**Methods:**

#### `set_default_name` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L728](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L728)</sup>

```python theme={null}
set_default_name(cls, name: Optional[str]) -> str
```

### `TaskRunPolicy` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L732](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L732)</sup>

Defines of how a task run should retry.

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `populate_deprecated_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L761](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L761)</sup>

```python theme={null}
populate_deprecated_fields(self)
```

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

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L781](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L781)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L788](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L788)</sup>

```python theme={null}
validate_jitter_factor(cls, v: Optional[float]) -> Optional[float]
```

### `RunInput` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L792](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L792)</sup>

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

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L805](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L805)</sup>

Represents a task run result input to another task run.

### `FlowRunResult` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L812](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L812)</sup>

### `Parameter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L817](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L817)</sup>

Represents a parameter input to a task run.

### `Constant` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L824](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L824)</sup>

Represents constant input value to a task run.

### `TaskRun` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L831](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L831)</sup>

**Methods:**

#### `set_default_name` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L941](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L941)</sup>

```python theme={null}
set_default_name(cls, name: Optional[str]) -> Name
```

### `Workspace` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L957](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L957)</sup>

A Prefect Cloud workspace.

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

**Methods:**

#### `api_url` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L980](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L980)</sup>

```python theme={null}
api_url(self) -> str
```

Generate the API URL for accessing this workspace

#### `handle` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L974](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L974)</sup>

```python theme={null}
handle(self) -> str
```

The full handle of the workspace as `account_handle` / `workspace_handle`

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L990](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L990)</sup>

```python theme={null}
ui_url(self) -> str
```

Generate the UI URL for accessing this workspace

### `IPAllowlistEntry` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1004](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1004)</sup>

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1016](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1016)</sup>

A Prefect Cloud IP allowlist.

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

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1026](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1026)</sup>

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

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1033](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1033)</sup>

An ORM representation of a block type

### `BlockSchema` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1057](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1057)</sup>

A representation of a block schema.

### `BlockDocument` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1078](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1078)</sup>

An ORM representation of a block document.

**Methods:**

#### `serialize_data` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1118](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1118)</sup>

```python theme={null}
serialize_data(self, handler: SerializerFunctionWrapHandler, info: SerializationInfo) -> Any
```

#### `validate_name_is_present_if_not_anonymous` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1112](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1112)</sup>

```python theme={null}
validate_name_is_present_if_not_anonymous(cls, values: dict[str, Any]) -> dict[str, Any]
```

### `Flow` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1129](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1129)</sup>

An ORM representation of flow data.

### `DeploymentSchedule` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1143](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1143)</sup>

### `VersionInfo` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1168](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1168)</sup>

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1173](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1173)</sup>

### `DeploymentBranchingOptions` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1179](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1179)</sup>

### `Deployment` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1186](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1186)</sup>

An ORM representation of deployment data.

### `ConcurrencyLimit` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1291](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1291)</sup>

An ORM representation of a concurrency limit.

### `BlockSchemaReference` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1304](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1304)</sup>

An ORM representation of a block schema reference.

### `BlockDocumentReference` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1324](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1324)</sup>

An ORM representation of a block document reference.

**Methods:**

#### `validate_parent_and_ref_are_different` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1345](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1345)</sup>

```python theme={null}
validate_parent_and_ref_are_different(cls, values: Any) -> Any
```

### `Configuration` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1351](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1351)</sup>

An ORM representation of account info.

### `SavedSearchFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1358](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1358)</sup>

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

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1375](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1375)</sup>

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

### `Log` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1385](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1385)</sup>

An ORM representation of log data.

### `QueueFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1400](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1400)</sup>

Filter criteria definition for a work queue.

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1413](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1413)</sup>

An ORM representation of a work queue

### `WorkQueueHealthPolicy` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1457](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1457)</sup>

**Methods:**

#### `evaluate_health_status` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1473](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1473)</sup>

```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_count`: 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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1504](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1504)</sup>

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1520](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1520)</sup>

An ORM representation of an agent

### `WorkPoolStorageConfiguration` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1538](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1538)</sup>

A work pool storage configuration

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

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

### `ServerDefaultResultStorage` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1553](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1553)</sup>

Server-side default result storage configuration.

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

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

### `ServerDefaultResultStorageUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1562](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1562)</sup>

Request payload for setting the server default result storage block.

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1571](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1571)</sup>

An ORM representation of a work pool

**Methods:**

#### `helpful_error_for_missing_default_queue_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1625](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1625)</sup>

```python theme={null}
helpful_error_for_missing_default_queue_id(cls, v: Optional[UUID]) -> UUID
```

#### `is_managed_pool` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1620](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1620)</sup>

```python theme={null}
is_managed_pool(self) -> bool
```

#### `is_push_pool` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1616](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1616)</sup>

```python theme={null}
is_push_pool(self) -> bool
```

### `Worker` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1629](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1629)</sup>

An ORM representation of a worker

### `Artifact` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1655](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1655)</sup>

**Methods:**

#### `validate_metadata_length` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1693](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1693)</sup>

```python theme={null}
validate_metadata_length(cls, v: Optional[dict[str, str]]) -> Optional[dict[str, str]]
```

### `ArtifactCollection` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1699](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1699)</sup>

### `Variable` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1736](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1736)</sup>

### `FlowRunInput` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1755](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1755)</sup>

**Methods:**

#### `decoded_value` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1764](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1764)</sup>

```python theme={null}
decoded_value(self) -> Any
```

Decode the value of the input.

**Returns:**

* the decoded value

### `GlobalConcurrencyLimit` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1774](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1774)</sup>

An ORM representation of a global concurrency limit

### `CsrfToken` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1801](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1801)</sup>

### `Integration` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1817](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1817)</sup>

A representation of an installed Prefect integration.

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1824](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/objects.py#L1824)</sup>

Worker metadata.

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

**Methods:**

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

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