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

Class Trigger.TriggerContext

java.lang.Object

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

Direct Known Subclasses:

Trigger.OnElementContext, Trigger.OnMergeContext, Trigger.OnTimerContext

Enclosing class:

Trigger<W extends BoundedWindow>

public abstract class Trigger.TriggerContext
extends Object

Information accessible to all of the callbacks that are executed on a Trigger.

Constructor Summary

Constructors

Constructor and Description
TriggerContext()

Method Summary

Modifier and Type	Method and Description
abstract boolean	areAllSubtriggersFinished() Returns true if all the sub-triggers of the current trigger are marked finished.
abstract org.joda.time.Instant	currentProcessingTime() Returns the current processing time.
abstract void	deleteTimer(com.google.cloud.dataflow.sdk.util.TimerManager.TimeDomain timeDomain) Removes the timer set in this trigger context for the given window and timeDomain.
abstract com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>	firstUnfinishedSubTrigger() Returns the first unfinished sub-trigger.
abstract Trigger.TriggerContext	forTrigger(com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W> trigger) Create a TriggerContext for executing the given trigger.
abstract boolean	isFinished() Returns true if the current trigger is marked finished.
abstract <T> Map<W,T>	lookup(CodedTupleTag<T> tag, Iterable<W> windows) Lookup the value stored for a given tag in a bunch of windows.
abstract <T> T	lookup(CodedTupleTag<T> tag, W window) Lookup the value stored for the given tag and window.
abstract <T> void	remove(CodedTupleTag<T> tag, W window) Removes the keyed state associated with the given tag and window.
abstract void	resetTree() Clears all keyed state for triggers in the current sub-tree and unsets all the associated finished bits.
abstract void	setFinished(boolean finished) Sets the finished bit for the current trigger.
abstract void	setTimer(org.joda.time.Instant timestamp, com.google.cloud.dataflow.sdk.util.TimerManager.TimeDomain timeDomain) Sets a timer to fire when the watermark or processing time is beyond the given timestamp.
abstract <T> void	store(CodedTupleTag<T> tag, W window, T value) Updates the value stored in keyed state for the given tag and window.
abstract com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>	subTrigger(int subtriggerIndex) Access the executable version of the specified sub-trigger.
abstract Iterable<com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>>	subTriggers() Access the executable versions of the sub-triggers of the current trigger.
abstract Iterable<com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>>	unfinishedSubTriggers() Returns an iterable over the unfinished sub-triggers of the current trigger.
abstract W	window() The window that the current context is executing in.

Methods inherited from class java.lang.Object

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

Constructor Detail

TriggerContext

public TriggerContext()

Method Detail

setTimer

public abstract void setTimer(org.joda.time.Instant timestamp,
                              com.google.cloud.dataflow.sdk.util.TimerManager.TimeDomain timeDomain)
                       throws IOException

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

Each trigger can have a single timer in per timeDomain and window. If the trigger has already set a timer for a given domain and window, then setting overwrites it.

Parameters:

timestamp - the time at which the trigger’s Trigger.onTimer(com.google.cloud.dataflow.sdk.transforms.windowing.Trigger<W>.OnTimerContext) callback should execute

timeDomain - the domain that the timestamp applies to

Throws:

IOException

deleteTimer

public abstract void deleteTimer(com.google.cloud.dataflow.sdk.util.TimerManager.TimeDomain timeDomain)
                          throws IOException

Removes the timer set in this trigger context for the given window and timeDomain.

Throws:

IOException

currentProcessingTime

public abstract org.joda.time.Instant currentProcessingTime()

Returns the current processing time.

store

public abstract <T> void store(CodedTupleTag<T> tag,
                               W window,
                               T value)
                        throws IOException

Updates the value stored in keyed state for the given tag and window.

Throws:

IOException

remove

public abstract <T> void remove(CodedTupleTag<T> tag,
                                W window)
                         throws IOException

Removes the keyed state associated with the given tag and window.

Throws:

IOException

lookup

public abstract <T> T lookup(CodedTupleTag<T> tag,
                             W window)
                      throws IOException

Lookup the value stored for the given tag and window.

Throws:

IOException

lookup

public abstract <T> Map<W,T> lookup(CodedTupleTag<T> tag,
                                    Iterable<W> windows)
                             throws IOException

Lookup the value stored for a given tag in a bunch of windows.

Throws:

IOException

forTrigger

public abstract Trigger.TriggerContext forTrigger(com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W> trigger)

Create a TriggerContext for executing the given trigger.

subTriggers

public abstract Iterable<com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>> subTriggers()

Access the executable versions of the sub-triggers of the current trigger.

subTrigger

public abstract com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W> subTrigger(int subtriggerIndex)

Access the executable version of the specified sub-trigger.

isFinished

public abstract boolean isFinished()

Returns true if the current trigger is marked finished.

areAllSubtriggersFinished

public abstract boolean areAllSubtriggersFinished()

Returns true if all the sub-triggers of the current trigger are marked finished.

unfinishedSubTriggers

public abstract Iterable<com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W>> unfinishedSubTriggers()

Returns an iterable over the unfinished sub-triggers of the current trigger.

firstUnfinishedSubTrigger

public abstract com.google.cloud.dataflow.sdk.util.ExecutableTrigger<W> firstUnfinishedSubTrigger()

Returns the first unfinished sub-trigger.

resetTree

public abstract void resetTree()
                        throws Exception

Clears all keyed state for triggers in the current sub-tree and unsets all the associated finished bits.

Throws:

Exception

setFinished

public abstract void setFinished(boolean finished)

Sets the finished bit for the current trigger.

window

public abstract W window()

The window that the current context is executing in.