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

# filters

# `prefect.server.events.filters`

## Classes

### `AutomationFilterId` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L34](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L34)</sup>

Filter by `Automation.id`.

**Methods:**

#### `as_sql_filter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/filters.py#L53](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/filters.py#L53)</sup>

```python theme={null}
as_sql_filter(self) -> sa.ColumnElement[bool]
```

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

### `AutomationFilterCreated` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L47](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L47)</sup>

Filter by `Automation.created`.

**Methods:**

#### `as_sql_filter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/filters.py#L53](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/filters.py#L53)</sup>

```python theme={null}
as_sql_filter(self) -> sa.ColumnElement[bool]
```

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

### `AutomationFilterName` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L63](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L63)</sup>

Filter by `Automation.created`.

**Methods:**

#### `as_sql_filter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/filters.py#L53](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/filters.py#L53)</sup>

```python theme={null}
as_sql_filter(self) -> sa.ColumnElement[bool]
```

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

### `AutomationFilterTags` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L77](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L77)</sup>

Filter by `Automation.tags`.

**Methods:**

#### `as_sql_filter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/filters.py#L78](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/filters.py#L78)</sup>

```python theme={null}
as_sql_filter(self) -> sa.ColumnElement[bool]
```

### `AutomationFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L111](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L111)</sup>

**Methods:**

#### `as_sql_filter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/filters.py#L78](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/filters.py#L78)</sup>

```python theme={null}
as_sql_filter(self) -> sa.ColumnElement[bool]
```

### `EventDataFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L142](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L142)</sup>

A base class for filtering event data.

**Methods:**

#### `build_where_clauses` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L174](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L174)</sup>

```python theme={null}
build_where_clauses(self) -> Sequence['ColumnExpressionArgument[bool]']
```

Convert the criteria to a WHERE clause.

#### `excludes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L170](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L170)</sup>

```python theme={null}
excludes(self, event: Event) -> bool
```

Would the given filter exclude this event?

#### `get_filters` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L147](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L147)</sup>

```python theme={null}
get_filters(self) -> list['EventDataFilter']
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L166](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L166)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

Does the given event match the criteria of this filter?

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

### `EventOccurredFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L182](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L182)</sup>

**Methods:**

#### `build_where_clauses` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L206](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L206)</sup>

```python theme={null}
build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']
```

#### `clamp` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L195](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L195)</sup>

```python theme={null}
clamp(self, max_duration: timedelta) -> None
```

Limit how far the query can look back based on the given duration

#### `excludes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102)</sup>

```python theme={null}
excludes(self, event: Event) -> bool
```

Would the given filter exclude this event?

#### `get_filters` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80)</sup>

```python theme={null}
get_filters(self) -> list['EventDataFilter']
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L202](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L202)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

Does the given event match the criteria of this filter?

### `EventNameFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L215](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L215)</sup>

**Methods:**

#### `build_where_clauses` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L251](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L251)</sup>

```python theme={null}
build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']
```

#### `excludes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102)</sup>

```python theme={null}
excludes(self, event: Event) -> bool
```

Would the given filter exclude this event?

#### `get_filters` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80)</sup>

```python theme={null}
get_filters(self) -> list['EventDataFilter']
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L231](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L231)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

Does the given event match the criteria of this filter?

### `EventResourceFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L293](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L293)</sup>

**Methods:**

#### `build_where_clauses` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L329](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L329)</sup>

```python theme={null}
build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']
```

#### `excludes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102)</sup>

```python theme={null}
excludes(self, event: Event) -> bool
```

Would the given filter exclude this event?

#### `get_filters` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80)</sup>

```python theme={null}
get_filters(self) -> list['EventDataFilter']
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L311](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L311)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

Does the given event match the criteria of this filter?

### `EventRelatedFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L393](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L393)</sup>

**Methods:**

#### `build_where_clauses` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L411](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L411)</sup>

```python theme={null}
build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']
```

#### `excludes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102)</sup>

```python theme={null}
excludes(self, event: Event) -> bool
```

Would the given filter exclude this event?

#### `get_filters` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80)</sup>

```python theme={null}
get_filters(self) -> list['EventDataFilter']
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

Does the given event match the criteria of this filter?

### `EventAnyResourceFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L486](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L486)</sup>

**Methods:**

#### `build_where_clauses` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L523](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L523)</sup>

```python theme={null}
build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']
```

#### `excludes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102)</sup>

```python theme={null}
excludes(self, event: Event) -> bool
```

Would the given filter exclude this event?

#### `get_filters` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80)</sup>

```python theme={null}
get_filters(self) -> list['EventDataFilter']
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L501](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L501)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

Does the given event match the criteria of this filter?

### `EventIDFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L585](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L585)</sup>

**Methods:**

#### `build_where_clauses` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L598](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L598)</sup>

```python theme={null}
build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']
```

#### `excludes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102)</sup>

```python theme={null}
excludes(self, event: Event) -> bool
```

Would the given filter exclude this event?

#### `get_filters` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80)</sup>

```python theme={null}
get_filters(self) -> list['EventDataFilter']
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L590](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L590)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

Does the given event match the criteria of this filter?

### `EventTextFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L609](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L609)</sup>

Filter by text search across event content.

**Methods:**

#### `build_where_clauses` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L676](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L676)</sup>

```python theme={null}
build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']
```

Build SQLAlchemy WHERE clauses for text search

#### `excludes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102)</sup>

```python theme={null}
excludes(self, event: Event) -> bool
```

Would the given filter exclude this event?

#### `get_filters` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80)</sup>

```python theme={null}
get_filters(self) -> list['EventDataFilter']
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L623](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L623)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

Check if this text filter includes the given event.

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

Does the given event match the criteria of this filter?

### `EventOrder` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L745](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L745)</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`

### `EventFilter` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L750](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L750)</sup>

**Methods:**

#### `build_where_clauses` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L787](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L787)</sup>

```python theme={null}
build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']
```

#### `excludes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L102)</sup>

```python theme={null}
excludes(self, event: Event) -> bool
```

Would the given filter exclude this event?

#### `get_filters` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L80)</sup>

```python theme={null}
get_filters(self) -> list['EventDataFilter']
```

#### `includes` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/filters.py#L98)</sup>

```python theme={null}
includes(self, event: Event) -> bool
```

Does the given event match the criteria of this filter?

#### `logical_limit` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L804](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/filters.py#L804)</sup>

```python theme={null}
logical_limit(self) -> int
```

The logical limit for this query, which is a maximum number of rows that it
*could* return (regardless of what the caller has requested).  May be used as
an optimization for DB queries