org.apache.beam.sdk.transforms.windowing

Class Trigger.OnElementContext

java.lang.Object

org.apache.beam.sdk.transforms.windowing.Trigger.TriggerContext

org.apache.beam.sdk.transforms.windowing.Trigger.OnElementContext

Enclosing class:

Trigger

public abstract class Trigger.OnElementContext
extends Trigger.TriggerContext

Extended Trigger.TriggerContext containing information accessible to the Trigger.onElement(org.apache.beam.sdk.transforms.windowing.Trigger.OnElementContext) operational hook.

Constructor Summary

Constructors

Constructor and Description
OnElementContext()

Method Summary

Modifier and Type	Method and Description
abstract Instant	eventTimestamp() The event timestamp of the element currently being processed.
abstract Trigger.OnElementContext	forTrigger(org.apache.beam.sdk.util.ExecutableTrigger trigger) Create an OnElementContext for executing the given trigger.
abstract void	setTimer(Instant timestamp, org.apache.beam.sdk.util.TimeDomain domain) Sets a timer to fire when the watermark or processing time is beyond the given timestamp.

Methods inherited from class org.apache.beam.sdk.transforms.windowing.Trigger.TriggerContext

currentEventTime, currentProcessingTime, currentSynchronizedProcessingTime, deleteTimer, state, trigger, window

Methods inherited from class java.lang.Object

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

Constructor Detail

OnElementContext

public OnElementContext()

Method Detail

eventTimestamp

public abstract Instant eventTimestamp()

The event timestamp of the element currently being processed.

setTimer

public abstract void setTimer(Instant timestamp,
                              org.apache.beam.sdk.util.TimeDomain domain)

Sets a timer to fire when the watermark or processing time is beyond the given timestamp. Timers are not guaranteed to fire immediately, but will be delivered at some time afterwards.

As with Trigger.TriggerContext.state(), timers are implicitly scoped to the current window. All timer firings for a window will be received, but the implementation should choose to ignore those that are not applicable.

Parameters:

timestamp - the time at which the trigger should be re-evaluated

domain - the domain that the timestamp applies to

forTrigger

public abstract Trigger.OnElementContext forTrigger(org.apache.beam.sdk.util.ExecutableTrigger trigger)

Create an OnElementContext for executing the given trigger.

Specified by:

forTrigger in class Trigger.TriggerContext