validio_sdk.resource package

Submodules

validio_sdk.resource.channels module

Notification Channels.

class validio_sdk.resource.channels.Channel(name: str, display_name: str | None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Resource

A notification channel configuration.

https://docs.validio.io/docs/channels

resource_class_name() → str

Returns the base class name.

class validio_sdk.resource.channels.EmailChannel(*, name: str, application_link_url: str, sender_address: str, recipient_addresses: list[str], auth: EmailChannelAuthSmtpUserPassword, interactive_message_enabled: bool = True, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Channel

Configuration to send notifications via email.

validio_sdk.resource.channels.EmailChannelAuth

alias of EmailChannelAuthSmtpUserPassword

class validio_sdk.resource.channels.EmailChannelAuthSmtpUserPassword(*, address: str, port: int, encryption: EmailChannelSmtpEncryption, username: str | None, password: str | None)

Bases: ApiSecretChangeNestedResource

Credential configuration for an Email channel resource.

Contains configuration based on SMTP user-password authentication.

class validio_sdk.resource.channels.EmailChannelSmtpEncryption(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Connection encryption mode for an EmailChannel.

NONE = 'NONE'

START_TLS = 'START_TLS'

TLS = 'TLS'

class validio_sdk.resource.channels.MsTeamsChannel(*, name: str, application_link_url: str, ms_teams_channel_id: str, client_id: str, client_secret: str, interactive_message_enabled: bool = True, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Channel

Configuration to send notifications to a Microsoft Teams channel.

https://docs.validio.io/docs/msteams

class validio_sdk.resource.channels.SlackChannel(*, name: str, application_link_url: str, slack_channel_id: str, token: str, signing_secret: str | None = None, app_token: str | None = None, interactive_message_enabled: bool = True, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Channel

Configuration to send notifications to a Slack channel.

https://docs.validio.io/docs/slack

class validio_sdk.resource.channels.WebhookChannel(*, name: str, application_link_url: str, webhook_url: str, auth_header: str | None = None, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Channel

Configuration to send notifications to a webhook.

https://docs.validio.io/docs/webhooks

validio_sdk.resource.credentials module

Credentials configuration.

class validio_sdk.resource.credentials.AtlanCredential(*, name: str, application_link_url: str, base_url: str, api_token: str, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

(BETA) An Atlan credential resource.

class validio_sdk.resource.credentials.AwsAthenaCredential(*, name: str, access_key: str, secret_key: str, region: str, query_result_location: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

Athena credential resource.

class validio_sdk.resource.credentials.AwsCredential(*, name: str, access_key: str, secret_key: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A credential resource that can be used to authenticate against AWS services.

class validio_sdk.resource.credentials.AwsRedshiftCredential(*, name: str, host: str, port: int, user: str, password: str, default_database: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: PostgresLikeCredential

A credential resource that can be used to connect to a Redshift table.

https://docs.validio.io/docs/redshift

class validio_sdk.resource.credentials.AzureSynapseBackendType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Backend type used for Azure Synapse.

DEDICATED_SQL_POOL = 'DEDICATED_SQL_POOL'

SERVERLESS_SQL_POOL = 'SERVERLESS_SQL_POOL'

class validio_sdk.resource.credentials.AzureSynapseCredential(*, name: str, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A base class of Azure Credential resource.

class validio_sdk.resource.credentials.AzureSynapseEntraIdCredential(*, name: str, host: str, port: int, backend_type: AzureSynapseBackendType, client_id: str, client_secret: str, database: str | None = None, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: AzureSynapseCredential

An Entra ID credential resource that can be used to connect to an Azure Synapse table.

class validio_sdk.resource.credentials.AzureSynapseSqlCredential(*, name: str, host: str, port: int, backend_type: AzureSynapseBackendType, username: str, password: str, database: str | None = None, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: AzureSynapseCredential

A Sql credential resource that can be used to connect to an Azure Synapse table.

class validio_sdk.resource.credentials.ClickHouseCredential(*, name: str, protocol: ClickHouseProtocol, host: str, port: int, username: str, password: str, default_database: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A credential resource that can be used to connect to a ClickHouse table.

class validio_sdk.resource.credentials.ClickHouseProtocol(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

ClickHouse protocol.

HTTP = 'HTTP'

HTTPS = 'HTTPS'

NATIVE = 'NATIVE'

NATIVE_TLS = 'NATIVE_TLS'

class validio_sdk.resource.credentials.Credential(name: str, display_name: str | None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Resource

Base class for a credential resource.

https://docs.validio.io/docs/credentials

resource_class_name() → str

Returns the base class name.

class validio_sdk.resource.credentials.DatabricksCredential(*, name: str, host: str, port: int, access_token: str, http_path: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A credential resource that can be used to connect to a Databricks table.

class validio_sdk.resource.credentials.DbtCloudCredential(*, name: str, warehouse_credential: Credential, account_id: str, token: str, api_base_url: str | None = None, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: DbtCredential

A dbt cloud credential.

class validio_sdk.resource.credentials.DbtCoreCredential(*, name: str, warehouse_credential: Credential, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: DbtCredential

A dbt core credential.

class validio_sdk.resource.credentials.DbtCredential(*, name: str, warehouse_credential: Credential, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A dbt base class credential.

class validio_sdk.resource.credentials.DemoCredential(*, name: str, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A demo credential resource.

class validio_sdk.resource.credentials.GcpCredential(*, name: str, credential: str, billing_project: str | None = None, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A credential resource that can be used to authenticate against Google Cloud Platform services.

class validio_sdk.resource.credentials.KafkaSaslSslPlainCredential(*, name: str, bootstrap_servers: list[str], username: str, password: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, ca_certificate: str | None = None, __internal__: ResourceGraph | None = None)

Bases: Credential

A Kafka SASL SSL credential.

Security protocol: SASL_SSL Sasl mechanism: PLAIN

https://docs.validio.io/docs/kafka#authentication-methods-for-source-config

class validio_sdk.resource.credentials.KafkaSslCredential(*, name: str, bootstrap_servers: list[str], ca_certificate: str, client_certificate: str, client_private_key: str, client_private_key_password: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A Kafka TLS credential.

Security protocol: SSL

https://docs.validio.io/docs/kafka#authentication-methods-for-source-config

class validio_sdk.resource.credentials.LookerCredential(*, name: str, base_url: str, client_id: str, client_secret: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A credential resource that can be used to connect to Looker.

class validio_sdk.resource.credentials.MsPowerBiCredential(*, name: str, auth: MsPowerBiCredentialAuthEntraId, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A credential resource that can be used to connect to PowerBI using an EntraID credential.

validio_sdk.resource.credentials.MsPowerBiCredentialAuth

alias of MsPowerBiCredentialAuthEntraId

class validio_sdk.resource.credentials.MsPowerBiCredentialAuthEntraId(*, client_id: str, client_secret: str, tenant_id: str)

Bases: ApiSecretChangeNestedResource

Azure EntraID authentication for PowerBI.

class validio_sdk.resource.credentials.MsSqlServerCredential(name: str, host: str, port: int, auth: MsSqlServerCredentialUserPassword | MsSqlServerCredentialEntraId, database: str | None = None, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

Credential to connect to a Microsoft Sql Server warehouse.

class validio_sdk.resource.credentials.MsSqlServerCredentialEntraId(client_id: str, client_secret: str)

Bases: ApiSecretChangeNestedResource

MsSql-compatible credential via entra-id auth.

class validio_sdk.resource.credentials.MsSqlServerCredentialUserPassword(user: str, password: str)

Bases: ApiSecretChangeNestedResource

MsSql-compatible credential via user-password auth.

class validio_sdk.resource.credentials.OracleCredential(name: str, host: str, port: int, database: str, auth: OracleCredentialUserPassword, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

Credential to connect to an Oracle database.

validio_sdk.resource.credentials.OracleCredentialAuth

alias of OracleCredentialUserPassword

class validio_sdk.resource.credentials.OracleCredentialUserPassword(user: str, password: str)

Bases: ApiSecretChangeNestedResource

Oracle credential via user-password auth.

class validio_sdk.resource.credentials.PostgreSqlCredential(*, name: str, host: str, port: int, user: str, password: str, default_database: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: PostgresLikeCredential

A credential resource that can be used to connect to a Postgres table.

https://docs.validio.io/docs/postgresql

class validio_sdk.resource.credentials.PostgresLikeCredential(*, name: str, host: str, port: int, user: str, password: str, default_database: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A credential resource that can be used to connect to a Postgres-compatible table.

class validio_sdk.resource.credentials.SigmaCredential(*, name: str, base_url: str, client_id: str, client_secret: str, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A Sigma credential resource.

class validio_sdk.resource.credentials.SnowflakeCredential(*, name: str, account: str, auth: SnowflakeCredentialKeyPair | SnowflakeCredentialUserPassword, warehouse: str | None = None, role: str | None = None, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A credential resource that can be used to connect to a Snowflake table.

class validio_sdk.resource.credentials.SnowflakeCredentialKeyPair(*, user: str, private_key: str, private_key_passphrase: str | None = None)

Bases: ApiSecretChangeNestedResource

Snowflake key-pair based authentication.

https://docs.snowflake.com/en/user-guide/key-pair-auth

class validio_sdk.resource.credentials.SnowflakeCredentialUserPassword(*, user: str, password: str)

Bases: ApiSecretChangeNestedResource

Snowflake password-based authentication.

class validio_sdk.resource.credentials.TableauConnectedAppCredential(*, name: str, host: str, user: str, client_id: str, secret_id: str, secret_value: str, site: str | None = None, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A credential resource that can be used to connect to Tableau using connected app.

class validio_sdk.resource.credentials.TableauPersonalAccessTokenCredential(*, name: str, host: str, token_name: str, token_value: str, site: str | None = None, enable_catalog: bool = False, display_name: str | None = None, ignore_changes: bool = False, __internal__: ResourceGraph | None = None)

Bases: Credential

A credential resource that can be used to connect to Tableau using a personal access token.

validio_sdk.resource.enums module

Enums for Validio resources.

class validio_sdk.resource.enums.IncidentGroupPriority(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Priority to use for incident groups.

CRITICAL = 'CRITICAL'

HIGH = 'HIGH'

LOW = 'LOW'

MEDIUM = 'MEDIUM'

validio_sdk.resource.filters module

Filters configuration.

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

Bases: Filter

A Boolean filter configuration.

https://docs.validio.io/docs/filters#boolean-filter

class validio_sdk.resource.filters.BooleanFilterOperator(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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 = 'IS_FALSE'

IS_TRUE = 'IS_TRUE'

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)

Bases: Filter

An Enum filter configuration.

https://docs.validio.io/docs/filters#enum

class validio_sdk.resource.filters.EnumFilterOperator(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Configures the behavior of an Enum filter.

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

ALLOW = 'ALLOW'

DENY = 'DENY'

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

Bases: Resource

Base class for a filter configuration.

https://docs.validio.io/docs/filters

resource_class_name() → str

Returns the base class name.

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)

Bases: Filter

A Null filter configuration.

https://docs.validio.io/docs/filters#null

class validio_sdk.resource.filters.NullFilterOperator(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Configures the behavior of a Null filter.

IS: Filter in NULL values IS_NOT: Filter in Non-NULL values

IS = 'IS'

IS_NOT = 'IS_NOT'

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

Bases: Filter

A SQL filter configuration.

https://docs.validio.io/docs/filters#sql-filter

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)

Bases: Filter

A String filter configuration.

https://docs.validio.io/docs/filters#string

class validio_sdk.resource.filters.StringFilterOperator(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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 = 'CONTAINS'

DOES_NOT_CONTAIN = 'DOES_NOT_CONTAIN'

ENDS_WITH = 'ENDS_WITH'

IS_EMPTY = 'IS_EMPTY'

IS_EXACTLY = 'IS_EXACTLY'

IS_NOT_EMPTY = 'IS_NOT_EMPTY'

REGEX = 'REGEX'

STARTS_WITH = 'STARTS_WITH'

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)

Bases: Filter

A Threshold filter configuration.

https://docs.validio.io/docs/filters#threshold-filter

class validio_sdk.resource.filters.ThresholdFilterOperator(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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 = 'EQUAL'

GREATER_THAN = 'GREATER'

GREATER_THAN_OR_EQUAL = 'GREATER_EQUAL'

LESS_THAN = 'LESS'

LESS_THAN_OR_EQUAL = 'LESS_EQUAL'

NOT_EQUAL = 'NOT_EQUAL'

validio_sdk.resource.notification_rules module

Notification rule configuration.

class validio_sdk.resource.notification_rules.Conditions(*, owner_condition: OwnerNotificationRuleCondition | None = None, segment_conditions: list[SegmentNotificationRuleCondition] | None = None, severity_condition: SeverityNotificationRuleCondition | None = None, source_condition: SourceNotificationRuleCondition | None = None, tag_conditions: list[TagNotificationRuleCondition] | None = None, type_condition: TypeNotificationRuleCondition | None = None)

Bases: Diffable

Conditions used for notification rules.

class validio_sdk.resource.notification_rules.IncidentSeverity(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Severity of an incident severity condition.

HIGH = 'HIGH'

LOW = 'LOW'

MEDIUM = 'MEDIUM'

class validio_sdk.resource.notification_rules.IssueTypename(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Name of issue type.

GenericSourceError = 'GenericSourceError'

SchemaChangeSourceError = 'SchemaChangeSourceError'

SegmentLimitExceededSourceError = 'SegmentLimitExceededSourceError'

ValidatorIncident = 'ValidatorIncident'

class validio_sdk.resource.notification_rules.NotificationRule(*, name: str, channel: Channel, conditions: Conditions | None = None, display_name: str | None = None, ignore_changes: bool = False)

Bases: Resource

A notification rule.

https://docs.validio.io/docs/notifications

resource_class_name() → str

Returns the base class name.

class validio_sdk.resource.notification_rules.NotificationRuleCondition

Bases: Diffable

A condition for notification rules.

class validio_sdk.resource.notification_rules.OwnerNotificationRuleCondition(*, owners: list[str])

Bases: NotificationRuleCondition

A condition for owners.

class validio_sdk.resource.notification_rules.SegmentCondition(field: str, value: str)

Bases: object

A segment condition is a field and value to match segments on.

field: str

value: str

class validio_sdk.resource.notification_rules.SegmentNotificationRuleCondition(*, segments: dict[str, str] | list[SegmentCondition])

Bases: NotificationRuleCondition

A condition for segments.

class validio_sdk.resource.notification_rules.SeverityNotificationRuleCondition(*, severities: list[IncidentSeverity])

Bases: NotificationRuleCondition

A condition for severity.

class validio_sdk.resource.notification_rules.SourceNotificationRuleCondition(*, sources: list[Source])

Bases: NotificationRuleCondition

A condition for sources.

class validio_sdk.resource.notification_rules.TagNotificationRuleCondition(*, tags: dict[str, str | None] | list[Tag])

Bases: NotificationRuleCondition

A condition for tags.

class validio_sdk.resource.notification_rules.TypeNotificationRuleCondition(*, types: list[IssueTypename])

Bases: NotificationRuleCondition

A condition for sources.

validio_sdk.resource.replacement module

Utils for computing replacement diffs on resources.

class validio_sdk.resource.replacement.CascadeReplacementReason(parent_resource_cls: type, parent_resource_name: str)

Bases: ReplacementReason

Represents a replacement occurring on a child resource, due to the parent resource being replaced.

class validio_sdk.resource.replacement.ImmutableFieldReplacementReason(field_name: str, resource_update: ResourceUpdate)

Bases: ReplacementReason

Represents a replacement occurring on a resource, due to an update to an immutable field on the resource.

class validio_sdk.resource.replacement.ReplacementContext(credentials: dict[str, ~validio_sdk.resource.replacement.ReplacementReason] = <factory>, channels: dict[str, ~validio_sdk.resource.replacement.ReplacementReason] = <factory>, sources: dict[str, ~validio_sdk.resource.replacement.ReplacementReason] = <factory>, windows: dict[str, ~validio_sdk.resource.replacement.ReplacementReason] = <factory>, filters: dict[str, ~validio_sdk.resource.replacement.ReplacementReason] = <factory>, segmentations: dict[str, ~validio_sdk.resource.replacement.ReplacementReason] = <factory>, validators: dict[str, ~validio_sdk.resource.replacement.ReplacementReason] = <factory>, notification_rules: dict[str, ~validio_sdk.resource.replacement.ReplacementReason] = <factory>, tags: dict[str, ~validio_sdk.resource.replacement.ReplacementReason] = <factory>)

Bases: object

Contains info around why a resource is being replaced. Grouped by type.

channels: dict[str, ReplacementReason]

credentials: dict[str, ReplacementReason]

filters: dict[str, ReplacementReason]

notification_rules: dict[str, ReplacementReason]

segmentations: dict[str, ReplacementReason]

sources: dict[str, ReplacementReason]

tags: dict[str, ReplacementReason]

validators: dict[str, ReplacementReason]

windows: dict[str, ReplacementReason]

class validio_sdk.resource.replacement.ReplacementReason

Bases: object

Contains info around why a resource is being replaced.

validio_sdk.resource.segmentations module

Segmentation configuration.

class validio_sdk.resource.segmentations.SegmentUsage(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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: https://docs.validio.io/docs/segmentation-configuration#segment-usage-options

EXTREME = 'EXTREME'

HEAVY = 'HEAVY'

LIGHT = 'LIGHT'

MAXIMAL = 'MAXIMAL'

MEDIUM = 'MEDIUM'

MINIMAL = 'MINIMAL'

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)

Bases: Resource

A segmentation resource.

https://docs.validio.io/docs/segmentation

resource_class_name() → str

Returns the class name.

validio_sdk.resource.sources module

Sources.

class validio_sdk.resource.sources.AwsAthenaSource(*, name: str, credential: AwsAthenaCredential, catalog: str, database: str, table: str, schedule: str | None, lookback_days: int | None = None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, cursor_field: str | None = None, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: WarehouseSource

An AWS Athena source configuration.

https://docs.validio.io/docs/athena

class validio_sdk.resource.sources.AwsKinesisSource(*, name: str, credential: AwsCredential, region: str, stream_name: str, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, message_format: StreamingMessageFormat | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: StreamSource

A Kinesis source configuration.

https://docs.validio.io/docs/kinesis

class validio_sdk.resource.sources.AwsRedshiftSource(*, name: str, credential: PostgreSqlCredential | AwsRedshiftCredential, database: str | None, table: str, schedule: str | None, schema: str, lookback_days: int | None = None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, cursor_field: str | None = None, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: PostgresLikeSource

A Redshift source configuration.

https://docs.validio.io/docs/redshift

class validio_sdk.resource.sources.AzureSynapseSource(*, name: str, credential: AzureSynapseCredential, database: str, table: str, schedule: str | None, schema: str, lookback_days: int | None = None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, cursor_field: str | None = None, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: WarehouseSource

A Azure Synapse source configuration.

https://docs.validio.io/docs/azure-synapse

class validio_sdk.resource.sources.ClickHouseSource(*, name: str, credential: ClickHouseCredential, database: str, table: str, schedule: str | None, lookback_days: int | None = None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, cursor_field: str | None = None, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: WarehouseSource

A ClickHouse source configuration.

https://docs.validio.io/docs/clickhouse

class validio_sdk.resource.sources.DatabricksSource(*, name: str, credential: DatabricksCredential, catalog: str, table: str, schedule: str | None, schema: str, lookback_days: int | None = None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, cursor_field: str | None = None, http_path: str | None = None, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: WarehouseSource

A Databricks source configuration.

https://docs.validio.io/docs/databricks

class validio_sdk.resource.sources.DbtModelRunSource(*, name: str, credential: GcpCredential, project_name: str, job_name: str, schedule: str | None = '0/15 * * * *', display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: DbtSource

A source for dbt model run results.

class validio_sdk.resource.sources.DbtSource(*, name: str, credential: GcpCredential, project_name: str, job_name: str, schedule: str | None = '0/15 * * * *', display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: WarehouseSource

A base class source.

class validio_sdk.resource.sources.DbtTestResultSource(*, name: str, credential: GcpCredential, project_name: str, job_name: str, schedule: str | None = '0/15 * * * *', display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: DbtSource

A source for dbt test results.

class validio_sdk.resource.sources.DemoSource(*, name: str, credential: DemoCredential, owner: str | None = None, display_name: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Source

A Demo source configuration.

class validio_sdk.resource.sources.GcpBigQuerySource(*, name: str, credential: GcpCredential, project: str, dataset: str, table: str, schedule: str | None, lookback_days: int | None = None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, cursor_field: str | None = None, description: str | None = None, jtd_schema: dict | None = None, billing_project: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: WarehouseSource

A BigQuery source configuration.

https://docs.validio.io/docs/bigquery

class validio_sdk.resource.sources.GcpPubSubSource(*, name: str, credential: GcpCredential, project: str, subscription_id: str, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, message_format: StreamingMessageFormat | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: StreamSource, ABC

A PubSub source configuration.

class validio_sdk.resource.sources.KafkaSource(*, name: str, credential: KafkaSslCredential | KafkaSaslSslPlainCredential, topic: str, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, message_format: StreamingMessageFormat | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: StreamSource

A Kafka source configuration.

https://docs.validio.io/docs/kafka

class validio_sdk.resource.sources.MsSqlServerSource(name: str, credential: MsSqlServerCredential, database: str, schema: str, table: str, schedule: str | None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Source

A Microsoft Sql Server source configuration.

class validio_sdk.resource.sources.OracleSource(name: str, credential: OracleCredential, database: str, schema: str, table: str, schedule: str | None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Source

An Oracle source configuration.

class validio_sdk.resource.sources.PostgreSqlSource(*, name: str, credential: PostgreSqlCredential | AwsRedshiftCredential, database: str | None, table: str, schedule: str | None, schema: str, lookback_days: int | None = None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, cursor_field: str | None = None, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: PostgresLikeSource

A PostgreSql source configuration.

https://docs.validio.io/docs/postgresql

class validio_sdk.resource.sources.PostgresLikeSource(*, name: str, credential: PostgreSqlCredential | AwsRedshiftCredential, database: str | None, table: str, schedule: str | None, schema: str, lookback_days: int | None = None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, cursor_field: str | None = None, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: WarehouseSource

A Postgres compatible source configuration.

class validio_sdk.resource.sources.SnowflakeSource(*, name: str, credential: SnowflakeCredential, database: str, table: str, schedule: str | None, schema: str, lookback_days: int | None = None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, cursor_field: str | None = None, warehouse: str | None = None, role: str | None = None, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: WarehouseSource

A Snowflake source configuration.

https://docs.validio.io/docs/snowflake

class validio_sdk.resource.sources.Source(name: str, credential: Credential, display_name: str | None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Resource

A source configuration.

https://docs.validio.io/docs/sources

resource_class_name() → str

Returns the base class name.

class validio_sdk.resource.sources.SqlSource(*, name: str, credential: AzureSynapseCredential | AwsAthenaCredential | AwsRedshiftCredential | ClickHouseCredential | DatabricksCredential | GcpCredential | PostgreSqlCredential | SnowflakeCredential, sql_query: str, schedule: str | None, display_name: str | None = None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: WarehouseSource

A Sql source configuration.

class validio_sdk.resource.sources.StreamSource(name: str, credential: Credential, display_name: str | None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, message_format: StreamingMessageFormat | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Source

Base class for streaming sources.

class validio_sdk.resource.sources.StreamingMessageFormat(format: StreamingSourceMessageFormat | None = StreamingSourceMessageFormat.JSON, schema: str | None = None)

Bases: Diffable

Message format configuration for a streaming source.

class validio_sdk.resource.sources.StreamingSourceMessageFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Message format for streaming data.

AVRO = 'AVRO'

JSON = 'JSON'

PROTOBUF = 'PROTOBUF'

class validio_sdk.resource.sources.WarehouseSource(name: str, credential: Credential, display_name: str | None, owner: str | None = None, ignore_changes: bool = False, jtd_schema: dict | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Source

Base class for warehouse sources.

validio_sdk.resource.tags module

Tags configuration.

class validio_sdk.resource.tags.Tag(key: str, value: str | None = None, __internal__: ResourceGraph | None = None)

Bases: Resource

A tag can only be added as a resource but not yet updated or deleted. Reason being that tags are global and not bound to your namespace but you should still be able to use them in your project.

https://docs.validio.io/docs/managing-tags

has_user_defined_name() → bool

Returns if a resource has a user defined name.

resource_class_name() → str

Returns the base class name.

validio_sdk.resource.thresholds module

Threshold configuration.

class validio_sdk.resource.thresholds.AdaptionRate(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Adaption rate.

FAST = 'FAST'

SLOW = 'SLOW'

class validio_sdk.resource.thresholds.ComparisonOperator(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Operator for comparing two numeric values.

EQUAL = 'EQUAL'

GREATER = 'GREATER'

GREATER_EQUAL = 'GREATER_EQUAL'

LESS = 'LESS'

LESS_EQUAL = 'LESS_EQUAL'

NOT_EQUAL = 'NOT_EQUAL'

class validio_sdk.resource.thresholds.DecisionBoundsType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Decision bounds type.

LOWER = 'LOWER'

UPPER = 'UPPER'

UPPER_AND_LOWER = 'UPPER_AND_LOWER'

class validio_sdk.resource.thresholds.DifferenceOperator(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Operator for difference threshold.

DECREASING = 'DECREASING'

INCREASING = 'INCREASING'

STRICTLY_DECREASING = 'STRICTLY_DECREASING'

STRICTLY_INCREASING = 'STRICTLY_INCREASING'

class validio_sdk.resource.thresholds.DifferenceThreshold(*, difference_type: DifferenceType, operator: DifferenceOperator, number_of_windows: int, value: int)

Bases: Threshold

A dynamic threshold configuration.

https://docs.validio.io/docs/thresholds#difference-threshold

class validio_sdk.resource.thresholds.DifferenceType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Type of difference.

ABSOLUTE = 'ABSOLUTE'

PERCENTAGE = 'PERCENTAGE'

class validio_sdk.resource.thresholds.DynamicThreshold(*, sensitivity: float = 3.0, decision_bounds_type: DecisionBoundsType = DecisionBoundsType.UPPER_AND_LOWER, adaption_rate: AdaptionRate = AdaptionRate.FAST, algorithm: DynamicThresholdAlgorithm | None = None)

Bases: Threshold

A dynamic threshold configuration.

https://docs.validio.io/docs/thresholds#dynamic-threshold

class validio_sdk.resource.thresholds.DynamicThresholdAlgorithm(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Dynamic threshold algorithm.

V1 = 'V1'

V2 = 'V2'

class validio_sdk.resource.thresholds.FixedThreshold(*, value: float, operator: ComparisonOperator)

Bases: Threshold

A fixed threshold configuration.

https://docs.validio.io/docs/thresholds#fixed-threshold

class validio_sdk.resource.thresholds.Threshold

Bases: Diffable

Base class for a threshold configuration.

https://docs.validio.io/docs/thresholds

validio_sdk.resource.validators module

Validator configuration.

class validio_sdk.resource.validators.CategoricalDistributionMetric(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Metric for categorical distribution.

ADDED = 'ADDED'

CHANGED = 'CHANGED'

RELATIVE_ENTROPY = 'RELATIVE_ENTROPY'

REMOVED = 'REMOVED'

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, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Validator

A Categorical distribution validator resource.

https://docs.validio.io/docs/categorical-distribution

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, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Validator

A Freshness validator resource.

https://docs.validio.io/docs/freshness

class validio_sdk.resource.validators.NumericDistributionMetric(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Metric for numeric distribution.

MAXIMUM_RATIO = 'MAXIMUM_RATIO'

MEAN_RATIO = 'MEAN_RATIO'

MINIMUM_RATIO = 'MINIMUM_RATIO'

RELATIVE_ENTROPY = 'RELATIVE_ENTROPY'

STANDARD_DEVIATION_RATIO = 'STANDARD_DEVIATION_RATIO'

SUM_RATIO = 'SUM_RATIO'

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, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Validator

A Numeric distribution validator resource.

https://docs.validio.io/docs/numeric-distribution

class validio_sdk.resource.validators.NumericMetric(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Metric for numeric.

MAX = 'MAX'

MEAN = 'MEAN'

MIN = 'MIN'

STD = 'STD'

SUM = 'SUM'

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, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Validator

A Numeric validator resource.

https://docs.validio.io/docs/numeric

class validio_sdk.resource.validators.Reference(history: int, offset: int, source: Source | None = None, window: Window | None = None, filter: Filter | None = None)

Bases: Diffable

Represents configuration for reference validators.

See the Validio docs for more info on reference configuration https://docs.validio.io/docs/reference-source-config

class validio_sdk.resource.validators.RelativeTimeMetric(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Metric for relative time.

MAXIMUM_DIFFERENCE = 'MAXIMUM_DIFFERENCE'

MEAN_DIFFERENCE = 'MEAN_DIFFERENCE'

MINIMUM_DIFFERENCE = 'MINIMUM_DIFFERENCE'

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, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Validator

A Relative time validator resource.

https://docs.validio.io/docs/relative-time

class validio_sdk.resource.validators.RelativeVolumeMetric(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Metric for relative volume.

COUNT_RATIO = 'COUNT_RATIO'

PERCENTAGE_RATIO = 'PERCENTAGE_RATIO'

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, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Validator

A Relative volume validator resource.

https://docs.validio.io/docs/relative-volume

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

Bases: Diffable

Sliding window configuration for validators.

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, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Validator

A SQL validator resource.

https://docs.validio.io/docs/custom-sql

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, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Resource, ABC

Base class for a validator resources.

https://docs.validio.io/docs/validators

resource_class_name() → str

Returns the base class name.

class validio_sdk.resource.validators.VolumeMetric(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Metric for volume.

COUNT = 'COUNT'

DUPLICATES_COUNT = 'DUPLICATES_COUNT'

DUPLICATES_PERCENTAGE = 'DUPLICATES_PERCENTAGE'

PERCENTAGE = 'PERCENTAGE'

UNIQUE_COUNT = 'UNIQUE_COUNT'

UNIQUE_PERCENTAGE = 'UNIQUE_PERCENTAGE'

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, optional_source_field: str | None = None, description: str | None = None, tags: list[Tag] | None = None, priority: IncidentGroupPriority | None = None)

Bases: Validator

A Volume validator resource.

https://docs.validio.io/docs/volume

validio_sdk.resource.windows module

Window configuration.

class validio_sdk.resource.windows.Duration(*, length: int, unit: DurationTimeUnit)

Bases: Diffable

Duration defines a span of time, represented by a length and unit of the duration. For example, a length of 5 and unit of Month represents 5 months.

class validio_sdk.resource.windows.DurationTimeUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

A unit of time.

DAY = 'DAY'

HOUR = 'HOUR'

MINUTE = 'MINUTE'

MONTH = 'MONTH'

WEEK = 'WEEK'

class validio_sdk.resource.windows.FixedBatchWindow(*, name: str, source: Source, data_time_field: str, batch_size: int, segmented_batching: bool = False, batch_timeout_secs: int | None = None, display_name: str | None = None, segment_retention_period_days: int | None = None, ignore_changes: bool = False)

Bases: Window

A FixedBatch window resource.

https://docs.validio.io/docs/windows-configuration#31-fixed-batch-window

class validio_sdk.resource.windows.GlobalWindow(*, name: str, source: Source, display_name: str | None = None, segment_retention_period_days: int | None = None, ignore_changes: bool = False)

Bases: Window

A Global window resource.

Represent a single window spanning over all the data.

class validio_sdk.resource.windows.PartitionFilter(*, field: str, lookback: Duration)

Bases: Diffable

For a partitioned table, this provides configuration to add a qualifying filter on the value of the partitioning column. This is useful when the the configured datatime field of the tumbling window is not the same as the partitioning column of the table, in which case - a partition filter helps prune out irrelevant partitions in queries.

class validio_sdk.resource.windows.TumblingWindow(*, name: str, source: Source, data_time_field: str, window_size: int, time_unit: WindowTimeUnit, window_timeout_disabled: bool = False, display_name: str | None = None, segment_retention_period_days: int | None = None, lookback: Duration | None = None, partition_filter: PartitionFilter | None = None, ignore_changes: bool = False)

Bases: Window

A Tumbling window resource.

class validio_sdk.resource.windows.Window(name: str, source: Source, display_name: str | None, segment_retention_period_days: int | None = None, ignore_changes: bool = False)

Bases: Resource

Base class for a window resource.

https://docs.validio.io/docs/windows

resource_class_name() → str

Returns the base class name.

class validio_sdk.resource.windows.WindowTimeUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Unit of window time.

DAY = 'DAY'

HOUR = 'HOUR'

MINUTE = 'MINUTE'

MONTH = 'MONTH'

WEEK = 'WEEK'

Module contents