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

Class ProcessingTimeoutTrigger<T,W extends Window>

java.lang.Object

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

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

Type Parameters:

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

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

All Implemented Interfaces:

Serializable

@PublicEvolving
public class ProcessingTimeoutTrigger<T,W extends Window>
extends Trigger<T,W>

A Trigger that can turn any Trigger into a timeout Trigger.

On the first arriving element a configurable processing-time timeout will be set. Using of(Trigger, Duration, boolean, boolean), you can also re-new the timer for each arriving element by specifying resetTimerOnNewRecord and you can specify whether Trigger.clear(Window, TriggerContext) should be called on timout via shouldClearOnTimeout.

See Also:

Serialized Form

Nested Class Summary

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

Trigger.OnMergeContext, Trigger.TriggerContext

Method Summary

Modifier and Type	Method and Description
void	clear(W window, Trigger.TriggerContext ctx) Clears any state that the trigger might still hold for the given window.
static <T,W extends Window> ProcessingTimeoutTrigger<T,W>	of(Trigger<T,W> nestedTrigger, java.time.Duration timeout) Creates a new ProcessingTimeoutTrigger that fires when the inner trigger is fired or when the timeout timer fires.
static <T,W extends Window> ProcessingTimeoutTrigger<T,W>	of(Trigger<T,W> nestedTrigger, java.time.Duration timeout, boolean resetTimerOnNewRecord, boolean shouldClearOnTimeout) Creates a new ProcessingTimeoutTrigger that fires when the inner trigger is fired or when the timeout timer fires.
TriggerResult	onElement(T element, long timestamp, W window, Trigger.TriggerContext ctx) Called for every element that gets added to a pane.
TriggerResult	onEventTime(long timestamp, W window, Trigger.TriggerContext ctx) Called when an event-time timer that was set using the trigger context fires.
TriggerResult	onProcessingTime(long timestamp, 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 org.apache.flink.streaming.api.windowing.triggers.Trigger

canMerge, onMerge

Methods inherited from class java.lang.Object

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

Method Detail

onElement

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

Description copied from class: 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 class Trigger<T,W extends Window>

Parameters:

element - The element that arrived.

timestamp - The timestamp of the element that arrived.

window - The window to which the element is being added.

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

Throws:

Exception

onProcessingTime

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

Description copied from class: Trigger

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

Specified by:

onProcessingTime in class Trigger<T,W extends Window>

Parameters:

timestamp - The timestamp at which the timer fired.

window - The window for which the timer fired.

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

Throws:

Exception

onEventTime

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

Description copied from class: Trigger

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

Specified by:

onEventTime in class Trigger<T,W extends Window>

Parameters:

timestamp - The timestamp at which the timer fired.

window - The window for which the timer fired.

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

Throws:

Exception

clear

public void clear(W window,
                  Trigger.TriggerContext ctx)
           throws Exception

Description copied from class: Trigger

Clears any state that the trigger might still hold for the given window. This is called when a window is purged. Timers set using Trigger.TriggerContext.registerEventTimeTimer(long) and Trigger.TriggerContext.registerProcessingTimeTimer(long) should be deleted here as well as state acquired using Trigger.TriggerContext.getPartitionedState(StateDescriptor).

Specified by:

clear in class Trigger<T,W extends Window>

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

of

public static <T,W extends Window> ProcessingTimeoutTrigger<T,W> of(Trigger<T,W> nestedTrigger,
                                                                    java.time.Duration timeout)

Creates a new ProcessingTimeoutTrigger that fires when the inner trigger is fired or when the timeout timer fires.

For example: ProcessingTimeoutTrigger.of(CountTrigger.of(3), 100), will create a CountTrigger with timeout of 100 millis. So, if the first record arrives at time t, and the second record arrives at time t+50 , the trigger will fire when the third record arrives or when the time is {code t+100} (timeout).

Parameters:

nestedTrigger - the nested Trigger

timeout - the timeout interval

Returns:

ProcessingTimeoutTrigger with the above configuration.

of

public static <T,W extends Window> ProcessingTimeoutTrigger<T,W> of(Trigger<T,W> nestedTrigger,
                                                                    java.time.Duration timeout,
                                                                    boolean resetTimerOnNewRecord,
                                                                    boolean shouldClearOnTimeout)

Creates a new ProcessingTimeoutTrigger that fires when the inner trigger is fired or when the timeout timer fires.

For example: ProcessingTimeoutTrigger.of(CountTrigger.of(3), 100, false, true), will create a CountTrigger with timeout of 100 millis. So, if the first record arrives at time t, and the second record arrives at time t+50 , the trigger will fire when the third record arrives or when the time is {code t+100} (timeout).

Type Parameters:

T - The type of the element.

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

Parameters:

nestedTrigger - the nested Trigger

timeout - the timeout interval

resetTimerOnNewRecord - each time a new element arrives, reset the timer and start a new one

shouldClearOnTimeout - whether to call Trigger.clear(Window, TriggerContext) when the processing-time timer fires

Returns:

ProcessingTimeoutTrigger with the above configuration.