> ## 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.validators module

> Validator configuration.

Validator configuration.

### CategoricalDistributionMetric

```python
class validio_sdk.resource.validators.CategoricalDistributionMetric(*values)
```

Bases: `str`, `Enum`

Metric for categorical distribution.

#### ADDED

```python
ADDED = 'ADDED'
```

#### CHANGED

```python
CHANGED = 'CHANGED'
```

#### RELATIVE\_ENTROPY

```python
RELATIVE_ENTROPY = 'RELATIVE_ENTROPY'
```

#### REMOVED

```python
REMOVED = 'REMOVED'
```

### CategoricalDistributionValidator

```python
class validio_sdk.resource.validators.CategoricalDistributionValidator(*, name: str, window: Window, segmentation: Segmentation, metric: CategoricalDistributionMetric, source_field: str, reference_source_field: str, reference: Reference, threshold: Threshold | None = None, filter: Filter | None = None, initialize_with_backfill: bool = False, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `Window` *required*

**segmentation** `Segmentation` *required*

**metric** `CategoricalDistributionMetric` *required*

**source\_field** `str` *required*

**reference\_source\_field** `str` *required*

**reference** `Reference` *required*

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**filter** `Filter | None`

**Type:** `Filter | None`

**initialize\_with\_backfill** `bool`

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

**owner** `str | None`

**ignore\_changes** `bool`

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

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: [`Validator`](https://docs.validio.io/v11.1/sdk-reference/validio_sdk.resource#validator "validio_sdk.resource.validators.Validator")

A Categorical distribution validator resource.

See [Categorical Distribution](https://docs.validio.io/v11.1/docs/validators/validator-types/categorical-distribution.md).

#### reference\_source\_field

```python
reference_source_field: str
```

#### source\_field

```python
source_field: str
```

### FieldMapping

```python
class validio_sdk.resource.validators.FieldMapping(*, source_field: str, reference_field: str)
```

**Parameters**

**source\_field** `str` *required*

**reference\_field** `str` *required*

Bases: `Diffable`

Represents a field mapping between source and reference datasets.

### FreshnessValidator

```python
class validio_sdk.resource.validators.FreshnessValidator(*, name: str, window: TumblingWindow, segmentation: Segmentation, threshold: Threshold | None = None, filter: Filter | None = None, initialize_with_backfill: bool = False, metadata_enabled: bool = False, source_field: str | None = None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `TumblingWindow` *required*

**segmentation** `Segmentation` *required*

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**filter** `Filter | None`

**Type:** `Filter | None`

**initialize\_with\_backfill** `bool`

**metadata\_enabled** `bool`

**source\_field** `str | None`

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

**owner** `str | None`

**ignore\_changes** `bool`

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

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: [`Validator`](https://docs.validio.io/v11.1/sdk-reference/validio_sdk.resource#validator "validio_sdk.resource.validators.Validator")

A Freshness validator resource.

See [Freshness](https://docs.validio.io/v11.1/docs/validators/validator-types/freshness.md).

### NumericDistributionMetric

```python
class validio_sdk.resource.validators.NumericDistributionMetric(*values)
```

Bases: `str`, `Enum`

Metric for numeric distribution.

#### MAXIMUM\_RATIO

```python
MAXIMUM_RATIO = 'MAXIMUM_RATIO'
```

#### MEAN\_RATIO

```python
MEAN_RATIO = 'MEAN_RATIO'
```

#### MINIMUM\_RATIO

```python
MINIMUM_RATIO = 'MINIMUM_RATIO'
```

#### RELATIVE\_ENTROPY

```python
RELATIVE_ENTROPY = 'RELATIVE_ENTROPY'
```

#### STANDARD\_DEVIATION\_RATIO

```python
STANDARD_DEVIATION_RATIO = 'STANDARD_DEVIATION_RATIO'
```

#### SUM\_RATIO

```python
SUM_RATIO = 'SUM_RATIO'
```

### NumericDistributionValidator

```python
class validio_sdk.resource.validators.NumericDistributionValidator(*, name: str, window: Window, segmentation: Segmentation, metric: NumericDistributionMetric, source_field: str, reference_source_field: str, reference: Reference, threshold: Threshold | None = None, filter: Filter | None = None, initialize_with_backfill: bool = False, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `Window` *required*

**segmentation** `Segmentation` *required*

**metric** `NumericDistributionMetric` *required*

**source\_field** `str` *required*

**reference\_source\_field** `str` *required*

**reference** `Reference` *required*

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**filter** `Filter | None`

**Type:** `Filter | None`

**initialize\_with\_backfill** `bool`

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

**owner** `str | None`

**ignore\_changes** `bool`

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

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: [`Validator`](https://docs.validio.io/v11.1/sdk-reference/validio_sdk.resource#validator "validio_sdk.resource.validators.Validator")

A Numeric distribution validator resource.

See [Numeric Distribution](https://docs.validio.io/v11.1/docs/validators/validator-types/numeric-distribution.md).

#### reference\_source\_field

```python
reference_source_field: str
```

#### source\_field

```python
source_field: str
```

### NumericMetric

```python
class validio_sdk.resource.validators.NumericMetric(*values)
```

Bases: `str`, `Enum`

Metric for numeric.

#### MAX

```python
MAX = 'MAX'
```

#### MEAN

```python
MEAN = 'MEAN'
```

#### MIN

```python
MIN = 'MIN'
```

#### STD

```python
STD = 'STD'
```

#### SUM

```python
SUM = 'SUM'
```

### NumericValidator

```python
class validio_sdk.resource.validators.NumericValidator(*, name: str, window: Window, segmentation: Segmentation, metric: NumericMetric, source_field: str, slide_config: SlideConfig | None = None, threshold: Threshold | None = None, filter: Filter | None = None, initialize_with_backfill: bool = False, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `Window` *required*

**segmentation** `Segmentation` *required*

**metric** `NumericMetric` *required*

**source\_field** `str` *required*

**slide\_config** `SlideConfig | None`

**Type:** `SlideConfig | None`

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**filter** `Filter | None`

**Type:** `Filter | None`

**initialize\_with\_backfill** `bool`

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

**owner** `str | None`

**ignore\_changes** `bool`

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

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: [`Validator`](https://docs.validio.io/v11.1/sdk-reference/validio_sdk.resource#validator "validio_sdk.resource.validators.Validator")

A Numeric validator resource.

See [Numeric Statistics](https://docs.validio.io/v11.1/docs/validators/validator-types/numeric.md).

#### source\_field

```python
source_field: str
```

### ReconciliationMetric

```python
class validio_sdk.resource.validators.ReconciliationMetric(*values)
```

Bases: `str`, `Enum`

Metric for reconciliation.

#### ABSOLUTE\_DIFF

```python
ABSOLUTE_DIFF = 'ABSOLUTE_DIFF'
```

#### DIFF

```python
DIFF = 'DIFF'
```

#### RATIO

```python
RATIO = 'RATIO'
```

#### SUM

```python
SUM = 'SUM'
```

### ReconciliationValidator

```python
class validio_sdk.resource.validators.ReconciliationValidator(*, name: str, window: Window, segmentation: Segmentation, metric: ReconciliationMetric, reference_validator_left: Validator, reference_validator_right: Validator, segmentation_field_mapping: list[FieldMapping] | None = None, threshold: Threshold | None = None, initialize_with_backfill: bool = False, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `Window` *required*

**segmentation** `Segmentation` *required*

**metric** `ReconciliationMetric` *required*

**reference\_validator\_left** `Validator` *required*

**reference\_validator\_right** `Validator` *required*

**segmentation\_field\_mapping** `list[FieldMapping] | None`

**Type:** `list[FieldMapping] | None`

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**initialize\_with\_backfill** `bool`

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

**owner** `str | None`

**ignore\_changes** `bool`

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

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: [`Validator`](https://docs.validio.io/v11.1/sdk-reference/validio_sdk.resource#validator "validio_sdk.resource.validators.Validator")

A Reconciliation validator resource.

Compares metrics from two other validators (left and right), enabling cross-source data comparisons.

See [Reconciliation](https://docs.validio.io/v11.1/docs/validators/validator-types/reconciliation.md).

#### has\_cross\_source\_references()

```python
static has_cross_source_references() → bool
```

**Returns:** `bool`

Returns whether the validator references resources from other sources.

### Reference

```python
class validio_sdk.resource.validators.Reference(history: int, offset: int, filter: Filter | None = None)
```

**Parameters**

**history** `int` *required*

**offset** `int` *required*

**filter** `Filter | None`

**Type:** `Filter | None`

Bases: `Diffable`

Represents configuration for reference validators.

See the Validio docs for more info on reference configuration [Reference Source Validation](https://docs.validio.io/v11.1/docs/validators/validators-configuration/reference-source-config.md)

### ReferentialIntegrityValidator

```python
class validio_sdk.resource.validators.ReferentialIntegrityValidator(*, name: str, window: Window, segmentation: Segmentation, key_fields: list[FieldMapping], value_fields: list[FieldMapping] | None = None, reference_source: Source, reference_window: Window, reference_filter: Filter | None = None, threshold: Threshold | None = None, filter: Filter | None = None, initialize_with_backfill: bool = False, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `Window` *required*

**segmentation** `Segmentation` *required*

**key\_fields** `list[FieldMapping]` *required*

**Type:** `list[FieldMapping]`

**value\_fields** `list[FieldMapping] | None`

**Type:** `list[FieldMapping] | None`

**reference\_source** `Source` *required*

**reference\_window** `Window` *required*

**reference\_filter** `Filter | None`

**Type:** `Filter | None`

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**filter** `Filter | None`

**Type:** `Filter | None`

**initialize\_with\_backfill** `bool`

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

**owner** `str | None`

**ignore\_changes** `bool`

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

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: [`Validator`](https://docs.validio.io/v11.1/sdk-reference/validio_sdk.resource#validator "validio_sdk.resource.validators.Validator")

A Referential Integrity validator resource.

Validates referential integrity by matching records between source and reference datasets using key fields, with optional value field comparison for data consistency checks.

See [Referential Integrity](https://docs.validio.io/v11.1/docs/validators/validator-types/referential-integrity.md).

#### has\_cross\_source\_references()

```python
static has_cross_source_references() → bool
```

**Returns:** `bool`

Returns whether the validator references resources from other sources.

### RelativeTimeMetric

```python
class validio_sdk.resource.validators.RelativeTimeMetric(*values)
```

Bases: `str`, `Enum`

Metric for relative time.

#### MAXIMUM\_DIFFERENCE

```python
MAXIMUM_DIFFERENCE = 'MAXIMUM_DIFFERENCE'
```

#### MEAN\_DIFFERENCE

```python
MEAN_DIFFERENCE = 'MEAN_DIFFERENCE'
```

#### MINIMUM\_DIFFERENCE

```python
MINIMUM_DIFFERENCE = 'MINIMUM_DIFFERENCE'
```

### RelativeTimeValidator

```python
class validio_sdk.resource.validators.RelativeTimeValidator(*, name: str, window: Window, segmentation: Segmentation, metric: RelativeTimeMetric, source_field_minuend: str, source_field_subtrahend: str, threshold: Threshold | None = None, filter: Filter | None = None, initialize_with_backfill: bool = False, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `Window` *required*

**segmentation** `Segmentation` *required*

**metric** `RelativeTimeMetric` *required*

**source\_field\_minuend** `str` *required*

**source\_field\_subtrahend** `str` *required*

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**filter** `Filter | None`

**Type:** `Filter | None`

**initialize\_with\_backfill** `bool`

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

**owner** `str | None`

**ignore\_changes** `bool`

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

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: [`Validator`](https://docs.validio.io/v11.1/sdk-reference/validio_sdk.resource#validator "validio_sdk.resource.validators.Validator")

A Relative time validator resource.

See [Relative Time](https://docs.validio.io/v11.1/docs/validators/validator-types/relative-time.md).

### RelativeVolumeMetric

```python
class validio_sdk.resource.validators.RelativeVolumeMetric(*values)
```

Bases: `str`, `Enum`

Metric for relative volume.

#### COUNT\_RATIO

```python
COUNT_RATIO = 'COUNT_RATIO'
```

#### PERCENTAGE\_RATIO

```python
PERCENTAGE_RATIO = 'PERCENTAGE_RATIO'
```

### RelativeVolumeValidator

```python
class validio_sdk.resource.validators.RelativeVolumeValidator(*, name: str, window: Window, segmentation: Segmentation, metric: RelativeVolumeMetric, reference: Reference, source_field: str | None = None, reference_source_field: str | None = None, threshold: Threshold | None = None, filter: Filter | None = None, initialize_with_backfill: bool = False, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `Window` *required*

**segmentation** `Segmentation` *required*

**metric** `RelativeVolumeMetric` *required*

**reference** `Reference` *required*

**source\_field** `str | None`

**reference\_source\_field** `str | None`

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**filter** `Filter | None`

**Type:** `Filter | None`

**initialize\_with\_backfill** `bool`

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

**owner** `str | None`

**ignore\_changes** `bool`

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

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: [`Validator`](https://docs.validio.io/v11.1/sdk-reference/validio_sdk.resource#validator "validio_sdk.resource.validators.Validator")

A Relative volume validator resource.

See [Relative Volume](https://docs.validio.io/v11.1/docs/validators/validator-types/relative-volume.md).

### SlideConfig

```python
class validio_sdk.resource.validators.SlideConfig(*, history: int)
```

**Parameters**

**history** `int` *required*

Bases: `Diffable`

Sliding window configuration for validators.

### SqlValidator

```python
class validio_sdk.resource.validators.SqlValidator(*, name: str, window: TumblingWindow, segmentation: Segmentation, query: str, threshold: Threshold | None = None, initialize_with_backfill: bool = False, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `TumblingWindow` *required*

**segmentation** `Segmentation` *required*

**query** `str` *required*

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**initialize\_with\_backfill** `bool`

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

**owner** `str | None`

**ignore\_changes** `bool`

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

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: [`Validator`](https://docs.validio.io/v11.1/sdk-reference/validio_sdk.resource#validator "validio_sdk.resource.validators.Validator")

A SQL validator resource.

See [Custom SQL Validators](https://docs.validio.io/v11.1/docs/validators/validator-types/custom-sql.md).

### Validator

```python
class validio_sdk.resource.validators.Validator(name: str, window: Window, segmentation: Segmentation, display_name: str | None, threshold: Threshold | None = None, owner: str | None = None, filter: Filter | None = None, reference: Reference | None = None, initialize_with_backfill: bool = False, ignore_changes: bool = False, recreate_on_change: bool = False, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `Window` *required*

**segmentation** `Segmentation` *required*

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

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**owner** `str | None`

**filter** `Filter | None`

**Type:** `Filter | None`

**reference** `Reference | None`

**Type:** `Reference | None`

**initialize\_with\_backfill** `bool`

**ignore\_changes** `bool`

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

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: `Resource`, `ABC`

Base class for a validator resources.

See [About Validators](https://docs.validio.io/v11.1/docs/validators.md).

#### has\_cross\_source\_references()

```python
static has_cross_source_references() → bool
```

**Returns:** `bool`

Returns whether the validator references resources from other sources.

#### initialize\_with\_backfill

```python
initialize_with_backfill: bool
```

#### resource\_class\_name()

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

**Returns:** `str`

Returns the base class name.

#### segmentation\_name

```python
segmentation_name: str
```

#### source\_name

```python
source_name: str
```

#### window\_name

```python
window_name: str
```

### VolumeMetric

```python
class validio_sdk.resource.validators.VolumeMetric(*values)
```

Bases: `str`, `Enum`

Metric for volume.

#### COUNT

```python
COUNT = 'COUNT'
```

#### DUPLICATES\_COUNT

```python
DUPLICATES_COUNT = 'DUPLICATES_COUNT'
```

#### DUPLICATES\_PERCENTAGE

```python
DUPLICATES_PERCENTAGE = 'DUPLICATES_PERCENTAGE'
```

#### PERCENTAGE

```python
PERCENTAGE = 'PERCENTAGE'
```

#### UNIQUE\_COUNT

```python
UNIQUE_COUNT = 'UNIQUE_COUNT'
```

#### UNIQUE\_PERCENTAGE

```python
UNIQUE_PERCENTAGE = 'UNIQUE_PERCENTAGE'
```

### VolumeValidator

```python
class validio_sdk.resource.validators.VolumeValidator(*, name: str, window: Window, segmentation: Segmentation, metric: VolumeMetric, source_fields: list[str] | None = None, slide_config: SlideConfig | None = None, threshold: Threshold | None = None, filter: Filter | None = None, initialize_with_backfill: bool = False, metadata_enabled: bool = False, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False, optional_source_field: str | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None, data_quality_dimension: DataQualityDimension | None = None, data_quality_fields: list[str] | None = None)
```

**Parameters**

**name** `str` *required*

**window** `Window` *required*

**segmentation** `Segmentation` *required*

**metric** `VolumeMetric` *required*

**source\_fields** `list[str] | None`

**slide\_config** `SlideConfig | None`

**Type:** `SlideConfig | None`

**threshold** `Threshold | None`

**Type:** `Threshold | None`

**filter** `Filter | None`

**Type:** `Filter | None`

**initialize\_with\_backfill** `bool`

**metadata\_enabled** `bool`

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

**owner** `str | None`

**ignore\_changes** `bool`

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

**optional\_source\_field** `str | None`

**description** `str | None`

**tags** `list[Tag] | None`

**Type:** `list[Tag] | None`

**priority** `IncidentGroupPriority | None`

**Type:** `IncidentGroupPriority | None`

**data\_quality\_dimension** `DataQualityDimension | None`

**Type:** `DataQualityDimension | None`

**data\_quality\_fields** `list[str] | None`

Bases: [`Validator`](https://docs.validio.io/v11.1/sdk-reference/validio_sdk.resource#validator "validio_sdk.resource.validators.Validator")

A Volume validator resource.

See [Volume](https://docs.validio.io/v11.1/docs/validators/validator-types/volume.md).

#### optional\_source\_field

```python
optional_source_field: str | None
```