com.google.cloud.dataflow.sdk.transforms.windowing

Class AfterProcessingTime<W extends BoundedWindow>

java.lang.Object

com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>

com.google.cloud.dataflow.sdk.transforms.windowing.Trigger.OnceTrigger<W>

com.google.cloud.dataflow.sdk.transforms.windowing.TimeTrigger<W>

com.google.cloud.dataflow.sdk.transforms.windowing.AfterProcessingTime<W>

Type Parameters:

W - BoundedWindow subclass used to represent the windows used

All Implemented Interfaces:

TriggerBuilder<W>, Serializable

@Experimental(value=TRIGGER)
public class AfterProcessingTime<W extends BoundedWindow>
extends TimeTrigger<W>

AfterProcessingTime triggers fire based on the current processing time. They operate in the real-time domain.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.cloud.dataflow.sdk.transforms.windowing.Trigger

Trigger.MergeResult, Trigger.MergingTriggerInfo<W extends BoundedWindow>, Trigger.OnceTrigger<W extends BoundedWindow>, Trigger.OnElementContext, Trigger.OnMergeContext, Trigger.OnTimerContext, Trigger.TriggerContext, Trigger.TriggerInfo<W extends BoundedWindow>, Trigger.TriggerResult

Field Summary

Fields inherited from class com.google.cloud.dataflow.sdk.transforms.windowing.TimeTrigger

DELAYED_UNTIL_TAG, IDENTITY, timestampMappers

Fields inherited from class com.google.cloud.dataflow.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.
boolean	equals(Object obj)
protected Trigger<W>	getContinuationTrigger(List<Trigger<W>> continuationTriggers) Return the Trigger.getContinuationTrigger() of this Trigger.
org.joda.time.Instant	getWatermarkThatGuaranteesFiring(W 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.
int	hashCode()
protected AfterProcessingTime<W>	newWith(List<SerializableFunction<org.joda.time.Instant,org.joda.time.Instant>> transforms) Method to create an updated version of this TimeTrigger modified to use the specified transform.
Trigger.TriggerResult	onElement(Trigger.OnElementContext c) Called immediately after an element is first incorporated into a window.
Trigger.MergeResult	onMerge(Trigger.OnMergeContext c) Called immediately after windows have been merged.
Trigger.TriggerResult	onTimer(Trigger.OnTimerContext c) Called when a timer has fired for the current window.
static <W extends BoundedWindow> AfterProcessingTime<W>	pastFirstElementInPane() Creates a trigger that fires when the current processing time passes the processing time at which this trigger saw the first element in a pane.
void	prefetchOnElement(com.google.cloud.dataflow.sdk.util.ReduceFn.StateContext state) Called to allow the trigger to prefetch any state it will likely need to read from during an Trigger.onElement(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnElementContext) call.
void	prefetchOnMerge(com.google.cloud.dataflow.sdk.util.ReduceFn.MergingStateContext state) Called to allow the trigger to prefetch any state it will likely need to read from during an Trigger.onMerge(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnMergeContext) call.
void	prefetchOnTimer(com.google.cloud.dataflow.sdk.util.ReduceFn.StateContext state) Called to allow the trigger to prefetch any state it will likely need to read from during an Trigger.onTimer(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnTimerContext) call.
String	toString()

Methods inherited from class com.google.cloud.dataflow.sdk.transforms.windowing.TimeTrigger

alignedTo, alignedTo, computeTargetTimestamp, isCompatible, mappedTo, plusDelayOf

Methods inherited from class com.google.cloud.dataflow.sdk.transforms.windowing.Trigger.OnceTrigger

getContinuationTrigger

Methods inherited from class com.google.cloud.dataflow.sdk.transforms.windowing.Trigger

buildTrigger, orFinally, subTriggers

Methods inherited from class java.lang.Object

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

Method Detail

pastFirstElementInPane

public static <W extends BoundedWindow> AfterProcessingTime<W> pastFirstElementInPane()

Creates a trigger that fires when the current processing time passes the processing time at which this trigger saw the first element in a pane.

newWith

protected AfterProcessingTime<W> newWith(List<SerializableFunction<org.joda.time.Instant,org.joda.time.Instant>> transforms)

Description copied from class: TimeTrigger

Method to create an updated version of this TimeTrigger modified to use the specified transform.

Specified by:

newWith in class TimeTrigger<W extends BoundedWindow>

Parameters:

transforms - The new transform to apply to target times.

Returns:

a new TimeTrigger.

onElement

public Trigger.TriggerResult onElement(Trigger.OnElementContext c)
                                throws Exception

Description copied from class: Trigger

Called immediately after an element is first incorporated into a window.

Specified by:

onElement in class Trigger<W extends BoundedWindow>

Throws:

Exception

onMerge

public Trigger.MergeResult onMerge(Trigger.OnMergeContext c)
                            throws Exception

Description copied from class: Trigger

Called immediately after windows have been merged.

Leaf triggers should determine their result by inspecting their status and any state in the merging windows. Composite triggers should determine their result by calling ExecutableTrigger.invokeMerge(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnMergeContext) on their sub-triggers, and applying appropriate logic.

A trigger can only return Trigger.MergeResult.ALREADY_FINISHED if it is marked as finished in at least one of the windows being merged.

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

Specified by:

onMerge in class Trigger<W extends BoundedWindow>

Throws:

Exception

onTimer

public Trigger.TriggerResult onTimer(Trigger.OnTimerContext c)
                              throws Exception

Description copied from class: Trigger

Called when a timer has fired for the current window. Composite triggers should pass the event to all sub-triggers. Triggers that set timers should verify the timer matches what they set before processing the firing.

Specified by:

onTimer in class Trigger<W extends BoundedWindow>

Throws:

Exception

prefetchOnElement

public void prefetchOnElement(com.google.cloud.dataflow.sdk.util.ReduceFn.StateContext state)

Description copied from class: Trigger

Called to allow the trigger to prefetch any state it will likely need to read from during an Trigger.onElement(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnElementContext) call.

Overrides:

prefetchOnElement in class Trigger<W extends BoundedWindow>

Parameters:

state - StateContext to prefetch from.

prefetchOnMerge

public void prefetchOnMerge(com.google.cloud.dataflow.sdk.util.ReduceFn.MergingStateContext state)

Description copied from class: Trigger

Called to allow the trigger to prefetch any state it will likely need to read from during an Trigger.onMerge(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnMergeContext) call.

Overrides:

prefetchOnMerge in class Trigger<W extends BoundedWindow>

Parameters:

state - StateContext to prefetch from.

prefetchOnTimer

public void prefetchOnTimer(com.google.cloud.dataflow.sdk.util.ReduceFn.StateContext state)

Description copied from class: Trigger

Called to allow the trigger to prefetch any state it will likely need to read from during an Trigger.onTimer(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnTimerContext) call.

Overrides:

prefetchOnTimer in class Trigger<W extends BoundedWindow>

Parameters:

state - StateContext to prefetch from.

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<W extends BoundedWindow>

Throws:

Exception

getWatermarkThatGuaranteesFiring

public org.joda.time.Instant getWatermarkThatGuaranteesFiring(W 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<W extends BoundedWindow>

getContinuationTrigger

protected Trigger<W> getContinuationTrigger(List<Trigger<W>> 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<W extends BoundedWindow>

toString

public String toString()

Overrides:

toString in class Trigger<W extends BoundedWindow>

equals

public boolean equals(Object obj)

Overrides:

equals in class Trigger<W extends BoundedWindow>

hashCode

public int hashCode()

Overrides:

hashCode in class Trigger<W extends BoundedWindow>