Package org.apache.flink.table.runtime.operators.window.tvf.unslicing

Class UnsliceAssigners.SessionUnsliceAssigner

java.lang.Object

org.apache.flink.table.runtime.operators.window.tvf.unslicing.UnsliceAssigners.SessionUnsliceAssigner

All Implemented Interfaces:

Serializable, WindowAssigner, UnsliceAssigner<TimeWindow>

Enclosing class:

UnsliceAssigners

public static class UnsliceAssigners.SessionUnsliceAssigner
extends Object
implements UnsliceAssigner<TimeWindow>

The UnsliceAssigner for session windows.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SessionUnsliceAssigner(int rowtimeIndex, java.time.ZoneId shiftTimeZone, long sessionGap)

Method Summary

Modifier and Type	Method	Description
Optional<TimeWindow>	assignActualWindow(org.apache.flink.table.data.RowData element, ClockService clock, MergingWindowProcessFunction<?,TimeWindow> windowFunction)	Returns the Window that the given element should belong to be used to trigger on.
Optional<TimeWindow>	assignStateNamespace(org.apache.flink.table.data.RowData element, ClockService clock, MergingWindowProcessFunction<?,TimeWindow> windowFunction)	Returns the Window that the given element should belong to be used as a namespace to restore the state.
String	getDescription()	Returns a description of this window assigner.
MergingWindowAssigner<TimeWindow>	getMergingWindowAssigner()	Currently, unslice assigner has an inner MergingWindowAssigner to reuse the logic in GroupWindowAssigner to merge windows.
protected long	getUtcTimestamp(org.apache.flink.table.data.RowData element, ClockService clock)
boolean	isEventTime()	Returns true if elements are assigned to windows based on event time, false based on processing time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionUnsliceAssigner

public SessionUnsliceAssigner(int rowtimeIndex,
                              java.time.ZoneId shiftTimeZone,
                              long sessionGap)

Method Detail

getMergingWindowAssigner

public MergingWindowAssigner<TimeWindow> getMergingWindowAssigner()

Description copied from interface: UnsliceAssigner

Currently, unslice assigner has an inner MergingWindowAssigner to reuse the logic in GroupWindowAssigner to merge windows.

Specified by:

getMergingWindowAssigner in interface UnsliceAssigner<TimeWindow>

assignActualWindow

public Optional<TimeWindow> assignActualWindow(org.apache.flink.table.data.RowData element,
                                               ClockService clock,
                                               MergingWindowProcessFunction<?,TimeWindow> windowFunction)
                                        throws Exception

Description copied from interface: UnsliceAssigner

Returns the Window that the given element should belong to be used to trigger on.

See more details in MergingWindowProcessFunction.assignActualWindows(org.apache.flink.table.data.RowData, long).

Specified by:

assignActualWindow in interface UnsliceAssigner<TimeWindow>

Parameters:

element - the element to which slice should belong to.

clock - the service to get current processing time.

Returns:

if empty, that means the element is late.

Throws:

Exception

assignStateNamespace

public Optional<TimeWindow> assignStateNamespace(org.apache.flink.table.data.RowData element,
                                                 ClockService clock,
                                                 MergingWindowProcessFunction<?,TimeWindow> windowFunction)
                                          throws Exception

Description copied from interface: UnsliceAssigner

Returns the Window that the given element should belong to be used as a namespace to restore the state.

See more details in MergingWindowProcessFunction.assignStateNamespace(org.apache.flink.table.data.RowData, long).

Specified by:

assignStateNamespace in interface UnsliceAssigner<TimeWindow>

Parameters:

element - the element to which slice should belong to.

clock - the service to get current processing time.

Returns:

if empty, that means the element is late.

Throws:

Exception

getUtcTimestamp

protected long getUtcTimestamp(org.apache.flink.table.data.RowData element,
                               ClockService clock)

isEventTime

public boolean isEventTime()

Description copied from interface: WindowAssigner

Returns true if elements are assigned to windows based on event time, false based on processing time.

Specified by:

isEventTime in interface WindowAssigner

getDescription

public String getDescription()

Description copied from interface: WindowAssigner

Returns a description of this window assigner.

Specified by:

getDescription in interface WindowAssigner