validio_sdk.resource.windows module

Window configuration.

Duration

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

Parameters

int

required

DurationTimeUnit

required

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.

DurationTimeUnit

class validio_sdk.resource.windows.DurationTimeUnit(*values)

Bases: str, Enum A unit of time.

DAY

DAY = 'DAY'

HOUR

HOUR = 'HOUR'

MINUTE

MINUTE = 'MINUTE'

MONTH

MONTH = 'MONTH'

WEEK

WEEK = 'WEEK'

FixedBatchWindow

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, recreate_on_change: bool = False)

Parameters

str

required

Source

required

str

required

int

required

bool

int | None

str | None

int | None

bool

Bases: Window A FixedBatch window resource. See About Windows.

data_time_field

data_time_field: str

GlobalWindow

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, recreate_on_change: bool = False)

Parameters

str

required

Source

required

str | None

int | None

bool

Bases: Window A Global window resource. Represent a single window spanning over all the data.

PartitionFilter

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

Parameters

str

required

Duration

required

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.

TumblingWindow

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, recreate_on_change: bool = False)

Parameters

str

required

Source

required

str

required

int

required

WindowTimeUnit

required

bool

str | None

int | None

Duration | None

Type: Duration

PartitionFilter | None

Type: PartitionFilter

bool

Bases: Window A Tumbling window resource.

data_time_field

data_time_field: str

window_size

window_size: int

Window

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, recreate_on_change: bool = False)

Parameters

str

required

Source

required

str | None

required

int | None

bool

Bases: Resource Base class for a window resource. See About Windows.

resource_class_name()

resource_class_name() → str

Returns: str Returns the base class name.

source_name

source_name: str

WindowTimeUnit

class validio_sdk.resource.windows.WindowTimeUnit(*values)

Bases: str, Enum Unit of window time.

DAY

DAY = 'DAY'

HOUR

HOUR = 'HOUR'

MINUTE

MINUTE = 'MINUTE'

MONTH

MONTH = 'MONTH'

WEEK

WEEK = 'WEEK'

Overview

API Reference

validio_sdk.resource.windows module

Duration

DurationTimeUnit

DAY

HOUR

MINUTE

MONTH

WEEK

FixedBatchWindow

data_time_field

GlobalWindow

PartitionFilter

TumblingWindow

data_time_field

window_size

Window

resource_class_name()

source_name

WindowTimeUnit

DAY

HOUR

MINUTE

MONTH

WEEK

​Duration

​DurationTimeUnit

​DAY

​HOUR

​MINUTE

​MONTH

​WEEK

​FixedBatchWindow

​data_time_field

​GlobalWindow

​PartitionFilter

​TumblingWindow

​data_time_field

​window_size

​Window

​resource_class_name()

​source_name

​WindowTimeUnit

​DAY

​HOUR

​MINUTE

​MONTH

​WEEK

Duration

DurationTimeUnit

DAY

HOUR

MINUTE

MONTH

WEEK

FixedBatchWindow

data_time_field

GlobalWindow

PartitionFilter

TumblingWindow

data_time_field

window_size

Window

resource_class_name()

source_name

WindowTimeUnit

DAY

HOUR

MINUTE

MONTH

WEEK