`prefect.server.events.filters`

Classes

`AutomationFilterCreated`

Filter by Automation.created.

`AutomationFilterName`

Filter by Automation.created.

`AutomationFilterTags`

Filter by Automation.tags.

`AutomationFilter`

`EventDataFilter`

A base class for filtering event data.

Methods:

`get_filters`

get_filters(self) -> list['EventDataFilter']

`includes`

includes(self, event: Event) -> bool

Does the given event match the criteria of this filter?

`excludes`

excludes(self, event: Event) -> bool

Would the given filter exclude this event?

`build_where_clauses`

build_where_clauses(self) -> Sequence['ColumnExpressionArgument[bool]']

Convert the criteria to a WHERE clause.

`EventOccurredFilter`

Methods:

`clamp`

clamp(self, max_duration: timedelta) -> None

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

`includes`

includes(self, event: Event) -> bool

`build_where_clauses`

build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']

`EventNameFilter`

Methods:

`includes`

includes(self, event: Event) -> bool

`build_where_clauses`

build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']

`LabelSet`

`LabelOperations`

`EventResourceFilter`

Methods:

`includes`

includes(self, event: Event) -> bool

`build_where_clauses`

build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']

`EventRelatedFilter`

Methods:

`build_where_clauses`

build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']

`EventAnyResourceFilter`

Methods:

`includes`

includes(self, event: Event) -> bool

`build_where_clauses`

build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']

`EventIDFilter`

Methods:

`includes`

includes(self, event: Event) -> bool

`build_where_clauses`

build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']

`EventOrder`

`EventFilter`

Methods:

`build_where_clauses`

build_where_clauses(self, db: PrefectDBInterface) -> Sequence['ColumnExpressionArgument[bool]']

`logical_limit`

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

API Reference

​prefect.server.events.filters

​Classes

​AutomationFilterCreated

​AutomationFilterName

​AutomationFilterTags

​AutomationFilter

​EventDataFilter

​get_filters

​includes

​excludes

​build_where_clauses

​EventOccurredFilter

​clamp

​includes

​build_where_clauses

​EventNameFilter

​includes

​build_where_clauses

​LabelSet

​LabelOperations

​EventResourceFilter

​includes

​build_where_clauses

​EventRelatedFilter

​build_where_clauses

​EventAnyResourceFilter

​includes

​build_where_clauses

​EventIDFilter

​includes

​build_where_clauses

​EventOrder

​EventFilter

​build_where_clauses

​logical_limit

`prefect.server.events.filters`

Classes

`AutomationFilterCreated`

`AutomationFilterName`

`AutomationFilterTags`

`AutomationFilter`

`EventDataFilter`

`get_filters`

`includes`

`excludes`

`build_where_clauses`

`EventOccurredFilter`

`clamp`

`includes`

`build_where_clauses`

`EventNameFilter`

`includes`

`build_where_clauses`

`LabelSet`

`LabelOperations`

`EventResourceFilter`

`includes`

`build_where_clauses`

`EventRelatedFilter`

`build_where_clauses`

`EventAnyResourceFilter`

`includes`

`build_where_clauses`

`EventIDFilter`

`includes`

`build_where_clauses`

`EventOrder`

`EventFilter`

`build_where_clauses`

`logical_limit`