org.apache.beam.sdk.transforms.windowing

Class DefaultTrigger

java.lang.Object

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

org.apache.beam.sdk.transforms.windowing.DefaultTrigger

All Implemented Interfaces:

Serializable

@Experimental(value=TRIGGER)
public class DefaultTrigger
extends Trigger

A trigger that is equivalent to Repeatedly.forever(AfterWatermark.pastEndOfWindow()). See Repeatedly.forever(org.apache.beam.sdk.transforms.windowing.Trigger) and AfterWatermark.pastEndOfWindow() for more details.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.transforms.windowing.Trigger

Trigger.MergingTriggerInfo, Trigger.OnceTrigger, Trigger.OnElementContext, Trigger.OnMergeContext, Trigger.TriggerContext, Trigger.TriggerInfo

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.windowing.Trigger

subTriggers

Method Summary

Modifier and Type	Method and Description
void	clear(Trigger.TriggerContext c) Clear any state associated with this trigger in the given window.
Trigger	getContinuationTrigger(List<Trigger> continuationTriggers) Return the Trigger.getContinuationTrigger() of this Trigger.
Instant	getWatermarkThatGuaranteesFiring(BoundedWindow window) Returns a bound in watermark time by which this trigger would have fired at least once for a given window had there been input data.
boolean	isCompatible(Trigger other) Returns whether this performs the same triggering as the given Trigger.
static DefaultTrigger	of() Returns the default trigger.
void	onElement(Trigger.OnElementContext c) Called every time an element is incorporated into a window.
void	onFire(Trigger.TriggerContext context) Adjusts the state of the trigger to be ready for the next pane.
void	onMerge(Trigger.OnMergeContext c) Called immediately after windows have been merged.
boolean	shouldFire(Trigger.TriggerContext context) Returns true if the current state of the trigger indicates that its condition is satisfied and it is ready to fire.

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

equals, getContinuationTrigger, hashCode, orFinally, prefetchOnElement, prefetchOnFire, prefetchOnMerge, prefetchShouldFire, subTriggers, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static DefaultTrigger of()

Returns the default trigger.

onElement

public void onElement(Trigger.OnElementContext c)
               throws Exception

Description copied from class: Trigger

Called every time an element is incorporated into a window.

Specified by:

onElement in class Trigger

Throws:

Exception

onMerge

public void onMerge(Trigger.OnMergeContext c)
             throws Exception

Description copied from class: Trigger

Called immediately after windows have been merged.

Leaf triggers should update their state by inspecting their status and any state in the merging windows. Composite triggers should update their state by calling ExecutableTrigger.invokeOnMerge(org.apache.beam.sdk.transforms.windowing.Trigger.OnMergeContext) on their sub-triggers, and applying appropriate logic.

A trigger such as AfterWatermark.pastEndOfWindow() may no longer be finished; it is the responsibility of the trigger itself to record this fact. It is forbidden for a trigger to become finished due to Trigger.onMerge(org.apache.beam.sdk.transforms.windowing.Trigger.OnMergeContext), as it has not yet fired the pending elements that led to it being ready to fire.

The implementation does not need to clear out any state associated with the old windows.

Specified by:

onMerge in class Trigger

Throws:

Exception

clear

public void clear(Trigger.TriggerContext c)
           throws Exception

Description copied from class: Trigger

Clear any state associated with this trigger in the given window.

This is called after a trigger has indicated it will never fire again. The trigger system keeps enough information to know that the trigger is finished, so this trigger should clear all of its state.

Overrides:

clear in class Trigger

Throws:

Exception

getWatermarkThatGuaranteesFiring

public Instant getWatermarkThatGuaranteesFiring(BoundedWindow window)

Description copied from class: Trigger

Returns a bound in watermark time by which this trigger would have fired at least once for a given window had there been input data. This is a static property of a trigger that does not depend on its state.

For triggers that do not fire based on the watermark advancing, returns BoundedWindow.TIMESTAMP_MAX_VALUE.

This estimate is used to determine that there are no elements in a side-input window, which causes the default value to be used instead.

Specified by:

getWatermarkThatGuaranteesFiring in class Trigger

isCompatible

public boolean isCompatible(Trigger other)

Description copied from class: Trigger

Returns whether this performs the same triggering as the given Trigger.

Overrides:

isCompatible in class Trigger

getContinuationTrigger

public Trigger getContinuationTrigger(List<Trigger> continuationTriggers)

Description copied from class: Trigger

Return the Trigger.getContinuationTrigger() of this Trigger. For convenience, this is provided the continuation trigger of each of the sub-triggers.

Specified by:

getContinuationTrigger in class Trigger

shouldFire

public boolean shouldFire(Trigger.TriggerContext context)
                   throws Exception

Description copied from class: Trigger

Returns true if the current state of the trigger indicates that its condition is satisfied and it is ready to fire.

Specified by:

shouldFire in class Trigger

Throws:

Exception

onFire

public void onFire(Trigger.TriggerContext context)
            throws Exception

Description copied from class: Trigger

Adjusts the state of the trigger to be ready for the next pane. For example, a Repeatedly trigger will reset its inner trigger, since it has fired.

If the trigger is finished, it is the responsibility of the trigger itself to record that fact via the context.

Specified by:

onFire in class Trigger

Throws:

Exception