org.apache.flink.table.runtime.operators.window.tvf.common

Interface WindowTimerService<W>

Type Parameters:

W - Type of the window namespace to which timers are scoped.

All Known Implementing Classes:

SlicingWindowTimerServiceImpl, UnslicingWindowTimerServiceImpl, WindowTimerServiceBase

@Internal
public interface WindowTimerService<W>

Interface for working with window time and timers which considers timezone for window splitting.

Method Summary

Modifier and Type	Method and Description
long	currentProcessingTime() Returns the current processing time.
long	currentWatermark() Returns the current event-time watermark.
ZoneId	getShiftTimeZone() The shift timezone of the window, if the proctime or rowtime type is TIMESTAMP_LTZ, the shift timezone is the timezone user configured in TableConfig, other cases the timezone is UTC which means never shift when assigning windows.
void	registerEventTimeWindowTimer(W window) Registers a window timer to be fired when event time watermark passes the window.
void	registerProcessingTimeWindowTimer(W window) Registers a window timer to be fired when processing time passes the window.

Method Detail

getShiftTimeZone

ZoneId getShiftTimeZone()

The shift timezone of the window, if the proctime or rowtime type is TIMESTAMP_LTZ, the shift timezone is the timezone user configured in TableConfig, other cases the timezone is UTC which means never shift when assigning windows.

currentProcessingTime

long currentProcessingTime()

Returns the current processing time.

currentWatermark

long currentWatermark()

Returns the current event-time watermark.

registerProcessingTimeWindowTimer

void registerProcessingTimeWindowTimer(W window)

Registers a window timer to be fired when processing time passes the window. The window you pass here will be provided when the timer fires.

registerEventTimeWindowTimer

void registerEventTimeWindowTimer(W window)

Registers a window timer to be fired when event time watermark passes the window. The window you pass here will be provided when the timer fires.