org.apache.flink.streaming.api.windowing.evictors

Class TimeEvictor<W extends Window>

java.lang.Object

org.apache.flink.streaming.api.windowing.evictors.TimeEvictor<W>

Type Parameters:

W - The type of Windows on which this Evictor can operate.

All Implemented Interfaces:

Serializable, Evictor<Object,W>

@PublicEvolving
public class TimeEvictor<W extends Window>
extends Object
implements Evictor<Object,W>

An Evictor that keeps elements for a certain amount of time. Elements older than current_time - keep_time are evicted. The current_time is time associated with TimestampedValue

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.windowing.evictors.Evictor

Evictor.EvictorContext

Constructor Summary

Constructors

Constructor and Description
TimeEvictor(long windowSize)
TimeEvictor(long windowSize, boolean doEvictAfter)

Method Summary

Modifier and Type	Method and Description
void	evictAfter(Iterable<TimestampedValue<Object>> elements, int size, W window, Evictor.EvictorContext ctx) Optionally evicts elements.
void	evictBefore(Iterable<TimestampedValue<Object>> elements, int size, W window, Evictor.EvictorContext ctx) Optionally evicts elements.
long	getWindowSize()
static <W extends Window> TimeEvictor<W>	of(Time windowSize) Creates a TimeEvictor that keeps the given number of elements.
static <W extends Window> TimeEvictor<W>	of(Time windowSize, boolean doEvictAfter) Creates a TimeEvictor that keeps the given number of elements.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeEvictor

public TimeEvictor(long windowSize)

TimeEvictor

public TimeEvictor(long windowSize,
                   boolean doEvictAfter)

Method Detail

evictBefore

public void evictBefore(Iterable<TimestampedValue<Object>> elements,
                        int size,
                        W window,
                        Evictor.EvictorContext ctx)

Description copied from interface: Evictor

Optionally evicts elements. Called before windowing function.

Specified by:

evictBefore in interface Evictor<Object,W extends Window>

Parameters:

elements - The elements currently in the pane.

size - The current number of elements in the pane.

window - The Window

ctx - The context for the Evictor

evictAfter

public void evictAfter(Iterable<TimestampedValue<Object>> elements,
                       int size,
                       W window,
                       Evictor.EvictorContext ctx)

Description copied from interface: Evictor

Optionally evicts elements. Called after windowing function.

Specified by:

evictAfter in interface Evictor<Object,W extends Window>

Parameters:

elements - The elements currently in the pane.

size - The current number of elements in the pane.

window - The Window

ctx - The context for the Evictor

toString

public String toString()

Overrides:

toString in class Object

getWindowSize

@VisibleForTesting
public long getWindowSize()

of

public static <W extends Window> TimeEvictor<W> of(Time windowSize)

Creates a TimeEvictor that keeps the given number of elements. Eviction is done before the window function.

Parameters:

windowSize - The amount of time for which to keep elements.

of

public static <W extends Window> TimeEvictor<W> of(Time windowSize,
                                                   boolean doEvictAfter)

Creates a TimeEvictor that keeps the given number of elements. Eviction is done before/after the window function based on the value of doEvictAfter.

Parameters:

windowSize - The amount of time for which to keep elements.

doEvictAfter - Whether eviction is done after window function.