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

# validio_sdk.resource.filters module

> Filters configuration.

Filters configuration.

### BooleanFilter

```python
class validio_sdk.resource.filters.BooleanFilter(*, field: str, operator: BooleanFilterOperator, name: str, source: Source, display_name: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False)
```

**Parameters**

**field** `str` *required*

**operator** `BooleanFilterOperator` *required*

**name** `str` *required*

**source** `Source` *required*

**display\_name** `str | None`

**ignore\_changes** `bool`

**recreate\_on\_change** `bool`

Bases: [`Filter`](https://docs.validio.io/v11.0/sdk-reference/validio_sdk.resource#filter "validio_sdk.resource.filters.Filter")

A Boolean filter configuration.

See [Filter Types](https://docs.validio.io/v11.0/docs/filters/filter-types.md#boolean-filter).

### BooleanFilterOperator

```python
class validio_sdk.resource.filters.BooleanFilterOperator(*values)
```

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

```python
IS_FALSE = 'IS_FALSE'
```

#### IS\_TRUE

```python
IS_TRUE = 'IS_TRUE'
```

### EnumFilter

```python
class validio_sdk.resource.filters.EnumFilter(*, field: str, values: list[str], name: str, source: Source, operator: EnumFilterOperator = EnumFilterOperator.ALLOW, display_name: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False)
```

**Parameters**

**field** `str` *required*

**values** `list[str]` *required*

**name** `str` *required*

**source** `Source` *required*

**operator** `EnumFilterOperator`

**display\_name** `str | None`

**ignore\_changes** `bool`

**recreate\_on\_change** `bool`

Bases: [`Filter`](https://docs.validio.io/v11.0/sdk-reference/validio_sdk.resource#filter "validio_sdk.resource.filters.Filter")

An Enum filter configuration.

See [Filter Types](https://docs.validio.io/v11.0/docs/filters/filter-types.md#enum-filter).

### EnumFilterOperator

```python
class validio_sdk.resource.filters.EnumFilterOperator(*values)
```

Bases: `str`, `Enum`

Configures the behavior of an Enum filter.

ALLOW: Allow values in the enum DENY: Deny values in the enum

#### ALLOW

```python
ALLOW = 'ALLOW'
```

#### DENY

```python
DENY = 'DENY'
```

### Filter

```python
class validio_sdk.resource.filters.Filter(name: str, source: Source, display_name: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False)
```

**Parameters**

**name** `str` *required*

**source** `Source` *required*

**display\_name** `str | None`

**ignore\_changes** `bool`

**recreate\_on\_change** `bool`

Bases: `Resource`

Base class for a filter configuration.

See [About Filters](https://docs.validio.io/v11.0/docs/filters.md).

#### resource\_class\_name()

```python
resource_class_name() → str
```

**Returns:** `str`

Returns the base class name.

#### source\_name

```python
source_name: str
```

### NullFilter

```python
class validio_sdk.resource.filters.NullFilter(*, field: str, name: str, source: Source, operator: NullFilterOperator = NullFilterOperator.IS, display_name: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False)
```

**Parameters**

**field** `str` *required*

**name** `str` *required*

**source** `Source` *required*

**operator** `NullFilterOperator`

**display\_name** `str | None`

**ignore\_changes** `bool`

**recreate\_on\_change** `bool`

Bases: [`Filter`](https://docs.validio.io/v11.0/sdk-reference/validio_sdk.resource#filter "validio_sdk.resource.filters.Filter")

A Null filter configuration.

See [Filter Types](https://docs.validio.io/v11.0/docs/filters/filter-types.md#null-filter).

### NullFilterOperator

```python
class validio_sdk.resource.filters.NullFilterOperator(*values)
```

Bases: `str`, `Enum`

Configures the behavior of a Null filter.

IS: Filter in NULL values IS\_NOT: Filter in Non-NULL values

#### IS

```python
IS = 'IS'
```

#### IS\_NOT

```python
IS_NOT = 'IS_NOT'
```

### SqlFilter

```python
class validio_sdk.resource.filters.SqlFilter(*, query: str, name: str, source: Source, display_name: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False)
```

**Parameters**

**query** `str` *required*

**name** `str` *required*

**source** `Source` *required*

**display\_name** `str | None`

**ignore\_changes** `bool`

**recreate\_on\_change** `bool`

Bases: [`Filter`](https://docs.validio.io/v11.0/sdk-reference/validio_sdk.resource#filter "validio_sdk.resource.filters.Filter")

A SQL filter configuration.

See [Filter Types](https://docs.validio.io/v11.0/docs/filters/filter-types.md#sql-filter).

### StringFilter

```python
class validio_sdk.resource.filters.StringFilter(*, field: str, operator: StringFilterOperator, name: str, source: Source, value: str | None = None, display_name: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False)
```

**Parameters**

**field** `str` *required*

**operator** `StringFilterOperator` *required*

**name** `str` *required*

**source** `Source` *required*

**value** `str | None`

**display\_name** `str | None`

**ignore\_changes** `bool`

**recreate\_on\_change** `bool`

Bases: [`Filter`](https://docs.validio.io/v11.0/sdk-reference/validio_sdk.resource#filter "validio_sdk.resource.filters.Filter")

A String filter configuration.

See [Filter Types](https://docs.validio.io/v11.0/docs/filters/filter-types.md#string-filter).

### StringFilterOperator

```python
class validio_sdk.resource.filters.StringFilterOperator(*values)
```

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

```python
CONTAINS = 'CONTAINS'
```

#### DOES\_NOT\_CONTAIN

```python
DOES_NOT_CONTAIN = 'DOES_NOT_CONTAIN'
```

#### ENDS\_WITH

```python
ENDS_WITH = 'ENDS_WITH'
```

#### IS\_EMPTY

```python
IS_EMPTY = 'IS_EMPTY'
```

#### IS\_EXACTLY

```python
IS_EXACTLY = 'IS_EXACTLY'
```

#### IS\_NOT\_EMPTY

```python
IS_NOT_EMPTY = 'IS_NOT_EMPTY'
```

#### REGEX

```python
REGEX = 'REGEX'
```

#### STARTS\_WITH

```python
STARTS_WITH = 'STARTS_WITH'
```

### ThresholdFilter

```python
class validio_sdk.resource.filters.ThresholdFilter(*, field: str, value: float, name: str, source: Source, operator: ThresholdFilterOperator, display_name: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False)
```

**Parameters**

**field** `str` *required*

**value** `float` *required*

**name** `str` *required*

**source** `Source` *required*

**operator** `ThresholdFilterOperator` *required*

**display\_name** `str | None`

**ignore\_changes** `bool`

**recreate\_on\_change** `bool`

Bases: [`Filter`](https://docs.validio.io/v11.0/sdk-reference/validio_sdk.resource#filter "validio_sdk.resource.filters.Filter")

A Threshold filter configuration.

See [Filter Types](https://docs.validio.io/v11.0/docs/filters/filter-types.md#threshold-filter).

### ThresholdFilterOperator

```python
class validio_sdk.resource.filters.ThresholdFilterOperator(*values)
```

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

```python
EQUAL = 'EQUAL'
```

#### GREATER\_THAN

```python
GREATER_THAN = 'GREATER'
```

#### GREATER\_THAN\_OR\_EQUAL

```python
GREATER_THAN_OR_EQUAL = 'GREATER_EQUAL'
```

#### LESS\_THAN

```python
LESS_THAN = 'LESS'
```

#### LESS\_THAN\_OR\_EQUAL

```python
LESS_THAN_OR_EQUAL = 'LESS_EQUAL'
```

#### NOT\_EQUAL

```python
NOT_EQUAL = 'NOT_EQUAL'
```