Documentation Index Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
Use this file to discover all available pages before exploring further.
prefect.server.events.filtersClasses AutomationFilterCreated Filter by Automation.created.
Methods: as_sql_filter 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 Filter by Automation.created.
Methods: as_sql_filter as_sql_filter( self ) -> sa.ColumnElement[ bool ]
Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.
Filter by Automation.tags.
Methods: as_sql_filter as_sql_filter( self ) -> sa.ColumnElement[ bool ]
AutomationFilter Methods: as_sql_filter as_sql_filter( self ) -> sa.ColumnElement[ bool ]
EventDataFilter A base class for filtering event data.
Methods: build_where_clauses build_where_clauses( self ) -> Sequence[ 'ColumnExpressionArgument[bool]' ]
Convert the criteria to a WHERE clause.
excludes excludes( self , event: Event) -> bool
Would the given filter exclude this event?
get_filters get_filters( self ) -> list[ 'EventDataFilter' ]
includes includes( self , event: Event) -> bool
Does the given event match the criteria of this filter?
model_validate_list model_validate_list( cls , obj: Any) -> list[Self]
reset_fields 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 Methods: build_where_clauses build_where_clauses( self , db: PrefectDBInterface) -> Sequence[ 'ColumnExpressionArgument[bool]' ]
clamp clamp( self , max_duration: timedelta) -> None
Limit how far the query can look back based on the given duration
excludes excludes( self , event: Event) -> bool
Would the given filter exclude this event?
get_filters get_filters( self ) -> list[ 'EventDataFilter' ]
includes includes( self , event: Event) -> bool
includes includes( self , event: Event) -> bool
Does the given event match the criteria of this filter?
EventNameFilter Methods: build_where_clauses build_where_clauses( self , db: PrefectDBInterface) -> Sequence[ 'ColumnExpressionArgument[bool]' ]
excludes excludes( self , event: Event) -> bool
Would the given filter exclude this event?
get_filters get_filters( self ) -> list[ 'EventDataFilter' ]
includes includes( self , event: Event) -> bool
includes includes( self , event: Event) -> bool
Does the given event match the criteria of this filter?
EventResourceFilter Methods: build_where_clauses build_where_clauses( self , db: PrefectDBInterface) -> Sequence[ 'ColumnExpressionArgument[bool]' ]
excludes excludes( self , event: Event) -> bool
Would the given filter exclude this event?
get_filters get_filters( self ) -> list[ 'EventDataFilter' ]
includes includes( self , event: Event) -> bool
includes includes( self , event: Event) -> bool
Does the given event match the criteria of this filter?
Methods: build_where_clauses build_where_clauses( self , db: PrefectDBInterface) -> Sequence[ 'ColumnExpressionArgument[bool]' ]
excludes excludes( self , event: Event) -> bool
Would the given filter exclude this event?
get_filters get_filters( self ) -> list[ 'EventDataFilter' ]
includes includes( self , event: Event) -> bool
Does the given event match the criteria of this filter?
EventAnyResourceFilter Methods: build_where_clauses build_where_clauses( self , db: PrefectDBInterface) -> Sequence[ 'ColumnExpressionArgument[bool]' ]
excludes excludes( self , event: Event) -> bool
Would the given filter exclude this event?
get_filters get_filters( self ) -> list[ 'EventDataFilter' ]
includes includes( self , event: Event) -> bool
includes includes( self , event: Event) -> bool
Does the given event match the criteria of this filter?
EventIDFilter Methods: build_where_clauses build_where_clauses( self , db: PrefectDBInterface) -> Sequence[ 'ColumnExpressionArgument[bool]' ]
excludes excludes( self , event: Event) -> bool
Would the given filter exclude this event?
get_filters get_filters( self ) -> list[ 'EventDataFilter' ]
includes includes( self , event: Event) -> bool
includes includes( self , event: Event) -> bool
Does the given event match the criteria of this filter?
EventTextFilter Filter by text search across event content.
Methods: build_where_clauses build_where_clauses( self , db: PrefectDBInterface) -> Sequence[ 'ColumnExpressionArgument[bool]' ]
Build SQLAlchemy WHERE clauses for text search
excludes excludes( self , event: Event) -> bool
Would the given filter exclude this event?
get_filters get_filters( self ) -> list[ 'EventDataFilter' ]
includes includes( self , event: Event) -> bool
Check if this text filter includes the given event.
includes includes( self , event: Event) -> bool
Does the given event match the criteria of this filter?
EventOrder Methods: auto Exposes enum.auto() to avoid requiring a second import to use AutoEnum
EventFilter Methods: build_where_clauses build_where_clauses( self , db: PrefectDBInterface) -> Sequence[ 'ColumnExpressionArgument[bool]' ]
excludes excludes( self , event: Event) -> bool
Would the given filter exclude this event?
get_filters get_filters( self ) -> list[ 'EventDataFilter' ]
includes includes( self , event: Event) -> bool
Does the given event match the criteria of this filter?
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 
