Skip to main content
Filters configuration.

BooleanFilter

Parameters
str
required
str
required
required
str | None
bool
bool
Bases: Filter A Boolean filter configuration. See Filter Types.

BooleanFilterOperator

Bases: str, Enum Configures the behavior of a Boolean filter. IS_TRUE: Allow values equal to TRUE IS_FALSE: Allow values equal to FALSE

IS_FALSE

IS_TRUE

EnumFilter

Parameters
str
required
list[str]
required
str
required
required
str | None
bool
bool
Bases: Filter An Enum filter configuration. See Filter Types.

EnumFilterOperator

Bases: str, Enum Configures the behavior of an Enum filter. ALLOW: Allow values in the enum DENY: Deny values in the enum

ALLOW

DENY

Filter

Parameters
str
required
required
str | None
bool
bool
Bases: Resource Base class for a filter configuration. See About Filters.

resource_class_name()

Returns: str Returns the base class name.

source_name

NullFilter

Parameters
str
required
str
required
required
str | None
bool
bool
Bases: Filter A Null filter configuration. See Filter Types.

NullFilterOperator

Bases: str, Enum Configures the behavior of a Null filter. IS: Filter in NULL values IS_NOT: Filter in Non-NULL values

IS

IS_NOT

SqlFilter

Parameters
str
required
str
required
required
str | None
bool
bool
Bases: Filter A SQL filter configuration. See Filter Types.

StringFilter

Parameters
str
required
str
required
required
str | None
str | None
bool
bool
Bases: Filter A String filter configuration. See Filter Types.

StringFilterOperator

Bases: str, Enum Configures the behavior of a String filter. IS_EMPTY: The string is empty IS_NOT_EMPTY: The string is not empty CONTAINS: The string contains DOES_NOT_CONTAIN: The string does not contain STARTS_WITH: The string is prefixed with ENDS_WITH: The string is suffixed with IS_EXACTLY: Exact match of full string REGEX: Regular expressions

CONTAINS

DOES_NOT_CONTAIN

ENDS_WITH

IS_EMPTY

IS_EXACTLY

IS_NOT_EMPTY

REGEX

STARTS_WITH

ThresholdFilter

Parameters
str
required
float
required
str
required
required
str | None
bool
bool
Bases: Filter A Threshold filter configuration. See Filter Types.

ThresholdFilterOperator

Bases: str, Enum Configures the behavior of a String filter. EQUAL: The value equals (==) NOT_EQUAL: The value does not equal (!=) LESS_THAN: The value is less than (<) LESS_THAN_OR_EQUAL: The value is less than or equal (<=) GREATER_THAN: The value is greater than (>) GREATER_THAN_OR_EQUAL: The value is greater than or equal (>=)

EQUAL

GREATER_THAN

GREATER_THAN_OR_EQUAL

LESS_THAN

LESS_THAN_OR_EQUAL

NOT_EQUAL