monitor_schema.models.analyzer.targets#

Define what targets for the analyses.

Attributes#

COLUMN_NAME_TYPE

Classes#

`NoExtrasBaseModel`	No extras base model.
`Segment`	A segment is a list of tags.
`TargetLevel`	Which nested level we are targeting.
`_BaseMatrix`	No extras base model.
`DatasetMatrix`	Define the matrix of fields and segments to fan out for monitoring.
`ColumnGroups`	Standard column groupings.
`ColumnMatrix`	Define the matrix of columns and segments to fan out for monitoring.

Module Contents#

class monitor_schema.models.analyzer.targets.NoExtrasBaseModel[source]#

Bases: pydantic.BaseModel

No extras base model.

Inherit to prevent accidental extra fields.

class monitor_schema.models.analyzer.targets.Segment[source]#

Bases: monitor_schema.models.commons.NoExtrasBaseModel

A segment is a list of tags.

We normalize these in the backend.

tags: List[SegmentTag]#

monitor_schema.models.analyzer.targets.COLUMN_NAME_TYPE#

class monitor_schema.models.analyzer.targets.TargetLevel[source]#

Bases: str, enum.Enum

Which nested level we are targeting.

dataset = 'dataset'#

column = 'column'#

class monitor_schema.models.analyzer.targets._BaseMatrix[source]#

Bases: monitor_schema.models.commons.NoExtrasBaseModel

No extras base model.

Inherit to prevent accidental extra fields.

segments: List[monitor_schema.models.segments.Segment] | None#

excludeSegments: List[monitor_schema.models.segments.Segment] | None#

class monitor_schema.models.analyzer.targets.DatasetMatrix[source]#

Bases: _BaseMatrix

Define the matrix of fields and segments to fan out for monitoring.

.

type: Literal[TargetLevel]#

class monitor_schema.models.analyzer.targets.ColumnGroups[source]#

Bases: str, enum.Enum

Standard column groupings.

group_continuous = 'group:continuous'#

group_discrete = 'group:discrete'#

group_input = 'group:input'#

group_output = 'group:output'#

class monitor_schema.models.analyzer.targets.ColumnMatrix[source]#

Bases: _BaseMatrix

Define the matrix of columns and segments to fan out for monitoring.

type: Literal[TargetLevel]#

include: List[ColumnGroups | monitor_schema.models.utils.COLUMN_NAME_TYPE] | None#

exclude: List[ColumnGroups | monitor_schema.models.utils.COLUMN_NAME_TYPE] | None#

profileId: str | None#