Share via


Filter Class

This is the base type that represents a filter. To configure a filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsFilter, NumberInFilter etc depending on the type of the key based on which you want to filter.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BoolEqualsFilter, IsNotNullFilter, IsNullOrUndefinedFilter, NumberGreaterThanFilter, NumberGreaterThanOrEqualsFilter, NumberInFilter, NumberInRangeFilter, NumberLessThanFilter, NumberLessThanOrEqualsFilter, NumberNotInFilter, NumberNotInRangeFilter, StringBeginsWithFilter, StringContainsFilter, StringEndsWithFilter, StringInFilter, StringNotBeginsWithFilter, StringNotContainsFilter, StringNotEndsWithFilter, StringNotInFilter

All required parameters must be populated in order to send to server.

Constructor

Filter(*, key: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
key
str

The field/property in the event based on which you want to filter.

Default value: None

Variables

Name Description
operator_type

The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: "NumberIn", "NumberNotIn", "NumberLessThan", "NumberGreaterThan", "NumberLessThanOrEquals", "NumberGreaterThanOrEquals", "BoolEquals", "StringIn", "StringNotIn", "StringBeginsWith", "StringEndsWith", "StringContains", "NumberInRange", "NumberNotInRange", "StringNotBeginsWith", "StringNotEndsWith", "StringNotContains", "IsNullOrUndefined", and "IsNotNull".

key
str

The field/property in the event based on which you want to filter.