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

> Segmentation configuration.

Segmentation configuration.

### SegmentUsage

```python
class validio_sdk.resource.segmentations.SegmentUsage(*values)
```

Bases: `str`, `Enum`

Segment usage maps to an expected (maximum) number of segments. Values go from fewest (minimal) to most (maximal) expected segments for the segmentation. The higher the value, the shorter the retention period will be.

See docmentation for exact numbers: [Segment Usage and Metric Retention](https://docs.validio.io/v10.2/docs/segmentation/metric-retention.md#retention-periods)

#### EXTREME

```python
EXTREME = 'EXTREME'
```

#### HEAVY

```python
HEAVY = 'HEAVY'
```

#### LIGHT

```python
LIGHT = 'LIGHT'
```

#### MAXIMAL

```python
MAXIMAL = 'MAXIMAL'
```

#### MEDIUM

```python
MEDIUM = 'MEDIUM'
```

#### MINIMAL

```python
MINIMAL = 'MINIMAL'
```

### Segmentation

```python
class validio_sdk.resource.segmentations.Segmentation(*, name: str, source: Source, fields: list[str] | None = None, filter: Filter | None = None, segment_usage: SegmentUsage | None = None, display_name: str | None = None, ignore_changes: bool = False, recreate_on_change: bool = False)
```

**Parameters**

**name** `str` *required*

**source** `Source` *required*

**fields** `list[str] | None`

**filter** `Filter | None`

**Type:** `Filter | None`

**segment\_usage** `SegmentUsage | None`

**Type:** `SegmentUsage | None`

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

**ignore\_changes** `bool`

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

Bases: `Resource`

A segmentation resource.

See [About Segmentation](https://docs.validio.io/v10.2/docs/segmentation.md).

#### fields

```python
fields: list[str]
```

#### filter\_name

```python
filter_name: str | None
```

#### resource\_class\_name()

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

**Returns:** `str`

Returns the class name.

#### source\_name

```python
source_name: str
```