org.apache.flink.streaming.api.windowing.triggers

Class PurgingTrigger<T,W extends Window>

java.lang.Object

org.apache.flink.streaming.api.windowing.triggers.PurgingTrigger<T,W>

Type Parameters:

T - The type of elements on which this trigger can operate.

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

All Implemented Interfaces:

Serializable, Trigger<T,W>

public class PurgingTrigger<T,W extends Window>
extends Object
implements Trigger<T,W>

A trigger that can turn any Trigger into a purging Trigger.

When the nested trigger fires, this will return a FIRE_AND_PURGE Trigger.TriggerResult

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.windowing.triggers.Trigger

Trigger.TriggerContext, Trigger.TriggerResult

Method Summary

Methods

Modifier and Type	Method and Description
Trigger<T,W>	getNestedTrigger()
static <T,W extends Window> PurgingTrigger<T,W>	of(Trigger<T,W> nestedTrigger) Creates a new purging trigger from the given Trigger.
Trigger.TriggerResult	onElement(T element, long timestamp, W window, Trigger.TriggerContext ctx) Called for every element that gets added to a pane.
Trigger.TriggerResult	onEventTime(long time, W window, Trigger.TriggerContext ctx) Called when an event-time timer that was set using the trigger context fires.
Trigger.TriggerResult	onProcessingTime(long time, W window, Trigger.TriggerContext ctx) Called when a processing-time timer that was set using the trigger context fires.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

onElement

public Trigger.TriggerResult onElement(T element,
                              long timestamp,
                              W window,
                              Trigger.TriggerContext ctx)
                                throws Exception

Description copied from interface: Trigger

Called for every element that gets added to a pane. The result of this will determine whether the pane is evaluated to emit results.

Specified by:

onElement in interface Trigger<T,W extends Window>

Parameters:

element - The element that arrived.

timestamp - The timestamp of the element that arrived.

window - The window to which this pane belongs.

ctx - A context object that can be used to register timer callbacks.

Throws:

Exception

onEventTime

public Trigger.TriggerResult onEventTime(long time,
                                W window,
                                Trigger.TriggerContext ctx)
                                  throws Exception

Description copied from interface: Trigger

Called when an event-time timer that was set using the trigger context fires.

Specified by:

onEventTime in interface Trigger<T,W extends Window>

Parameters:

time - The timestamp at which the timer fired.

ctx - A context object that can be used to register timer callbacks.

Throws:

Exception

onProcessingTime

public Trigger.TriggerResult onProcessingTime(long time,
                                     W window,
                                     Trigger.TriggerContext ctx)
                                       throws Exception

Description copied from interface: Trigger

Called when a processing-time timer that was set using the trigger context fires.

Specified by:

onProcessingTime in interface Trigger<T,W extends Window>

Parameters:

time - The timestamp at which the timer fired.

ctx - A context object that can be used to register timer callbacks.

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

of

public static <T,W extends Window> PurgingTrigger<T,W> of(Trigger<T,W> nestedTrigger)

Creates a new purging trigger from the given Trigger.

Parameters:

nestedTrigger - The trigger that is wrapped by this purging trigger

getNestedTrigger

public Trigger<T,W> getNestedTrigger()