org.apache.samza.operators.windows.internal

Class WindowInternal<M,WK,WV>

java.lang.Object

org.apache.samza.operators.windows.internal.WindowInternal<M,WK,WV>

Type Parameters:

M - the type of input message

WK - the type of key for the window

WV - the type of aggregated value in the window output

All Implemented Interfaces:

java.io.Serializable, Window<M,WK,WV>

@InterfaceStability.Unstable
public final class WindowInternal<M,WK,WV>
extends java.lang.Object
implements Window<M,WK,WV>

Internal representation of a Window. This specifies default, early and late triggers for the Window and whether to accumulate or discard previously emitted panes. Note: This class is meant to be used internally by Samza, and is not to be instantiated by programmers.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WindowInternal(Trigger<M> defaultTrigger, SupplierFunction<WV> initializer, FoldLeftFunction<M,WV> foldLeftFunction, MapFunction<M,WK> keyExtractor, MapFunction<M,java.lang.Long> eventTimeExtractor, WindowType windowType, Serde<WK> keySerde, Serde<WV> windowValueSerde, Serde<M> msgSerde)

Method Summary

Modifier and Type	Method and Description
AccumulationMode	getAccumulationMode()
Trigger<M>	getDefaultTrigger()
Trigger<M>	getEarlyTrigger()
MapFunction<M,java.lang.Long>	getEventTimeExtractor()
FoldLeftFunction<M,WV>	getFoldLeftFunction()
SupplierFunction<WV>	getInitializer()
MapFunction<M,WK>	getKeyExtractor()
Serde<WK>	getKeySerde()
Trigger<M>	getLateTrigger()
AccumulationMode	getMode()
Serde<M>	getMsgSerde()
WindowType	getWindowType()
Serde<WV>	getWindowValSerde()
Window<M,WK,WV>	setAccumulationMode(AccumulationMode mode) Specify how a Window should process its previously emitted WindowPanes.
Window<M,WK,WV>	setEarlyTrigger(Trigger<M> trigger) Set the early triggers for this Window.
Window<M,WK,WV>	setLateTrigger(Trigger<M> trigger) Set the late triggers for this Window.

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowInternal

public WindowInternal(Trigger<M> defaultTrigger,
                      SupplierFunction<WV> initializer,
                      FoldLeftFunction<M,WV> foldLeftFunction,
                      MapFunction<M,WK> keyExtractor,
                      MapFunction<M,java.lang.Long> eventTimeExtractor,
                      WindowType windowType,
                      Serde<WK> keySerde,
                      Serde<WV> windowValueSerde,
                      Serde<M> msgSerde)

Method Detail

getDefaultTrigger

public Trigger<M> getDefaultTrigger()

getEarlyTrigger

public Trigger<M> getEarlyTrigger()

getLateTrigger

public Trigger<M> getLateTrigger()

getInitializer

public SupplierFunction<WV> getInitializer()

getFoldLeftFunction

public FoldLeftFunction<M,WV> getFoldLeftFunction()

getKeyExtractor

public MapFunction<M,WK> getKeyExtractor()

getEventTimeExtractor

public MapFunction<M,java.lang.Long> getEventTimeExtractor()

getWindowType

public WindowType getWindowType()

getAccumulationMode

public AccumulationMode getAccumulationMode()

getKeySerde

public Serde<WK> getKeySerde()

getWindowValSerde

public Serde<WV> getWindowValSerde()

getMsgSerde

public Serde<M> getMsgSerde()

getMode

public AccumulationMode getMode()

setEarlyTrigger

public Window<M,WK,WV> setEarlyTrigger(Trigger<M> trigger)

Description copied from interface: Window

Set the early triggers for this Window.

Use the Triggers APIs to create instances of Trigger

Specified by:

setEarlyTrigger in interface Window<M,WK,WV>

Parameters:

trigger - the early trigger

Returns:

the Window function with the early trigger

setLateTrigger

public Window<M,WK,WV> setLateTrigger(Trigger<M> trigger)

Description copied from interface: Window

Set the late triggers for this Window.

Use the Triggers APIs to create instances of Trigger

Specified by:

setLateTrigger in interface Window<M,WK,WV>

Parameters:

trigger - the late trigger

Returns:

the Window function with the late trigger

setAccumulationMode

public Window<M,WK,WV> setAccumulationMode(AccumulationMode mode)

Description copied from interface: Window

Specify how a Window should process its previously emitted WindowPanes.

There are two types of AccumulationModes:

• ACCUMULATING: Specifies that window panes should include all messages collected for the window so far, even if they were included in previously emitted window panes.
• DISCARDING: Specifies that window panes should only include messages collected for this window since the last emitted window pane.

Specified by:

setAccumulationMode in interface Window<M,WK,WV>

Parameters:

mode - the accumulation mode

Returns:

the Window function with mode set as its AccumulationMode.