org.apache.beam.sdk.util.construction

Class Timer<K>

java.lang.Object

org.apache.beam.sdk.util.construction.Timer<K>

public abstract class Timer<K>
extends java.lang.Object

A timer consists of a user key, a dynamic timer tag, a set of windows and either a bit that says that this timer should be cleared or data representing the firing timestamp, hold timestamp and pane information that should be used when producing output.

Note that this is an implementation helper specifically intended for use during execution by runners and the Java SDK harness. The API for pipeline authors is Timer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Timer.Coder<K> A Coder for timers.

Constructor Summary

Constructors

Constructor and Description
Timer()

Method Summary

Modifier and Type	Method and Description
static <K> Timer<K>	cleared(K userKey, java.lang.String dynamicTimerTag, java.util.Collection<? extends BoundedWindow> windows) Returns a cleared timer for the given userKey, dynamicTimerTag and windows.
boolean	equals(@Nullable java.lang.Object other)
abstract boolean	getClearBit() Returns whether the timer is going to be cleared.
abstract java.lang.String	getDynamicTimerTag() Returns the tag that the timer is set on.
abstract @Nullable org.joda.time.Instant	getFireTimestamp() Returns the timestamp of when the timer is scheduled to fire.
abstract @Nullable org.joda.time.Instant	getHoldTimestamp() Returns the watermark that the timer is supposed to be held.
abstract @Nullable PaneInfo	getPane() Returns the PaneInfo that is related to the timer.
abstract K	getUserKey() Returns the key that the timer is set on.
abstract java.util.Collection<? extends BoundedWindow>	getWindows() Returns the windows which are associated with the timer.
int	hashCode()
static <K> Timer<K>	of(K userKey, java.lang.String dynamicTimerTag, java.util.Collection<? extends BoundedWindow> windows, org.joda.time.Instant fireTimestamp, org.joda.time.Instant holdTimestamp, PaneInfo pane) Returns a non-cleared timer for the given userKey, dynamicTimerTag, fireTimestamp, holdTimestamp, windows and pane.

Methods inherited from class java.lang.Object

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

Constructor Detail

Timer

public Timer()

Method Detail

of

public static <K> Timer<K> of(K userKey,
                              java.lang.String dynamicTimerTag,
                              java.util.Collection<? extends BoundedWindow> windows,
                              org.joda.time.Instant fireTimestamp,
                              org.joda.time.Instant holdTimestamp,
                              PaneInfo pane)

Returns a non-cleared timer for the given userKey, dynamicTimerTag, fireTimestamp, holdTimestamp, windows and pane.

cleared

public static <K> Timer<K> cleared(K userKey,
                                   java.lang.String dynamicTimerTag,
                                   java.util.Collection<? extends BoundedWindow> windows)

Returns a cleared timer for the given userKey, dynamicTimerTag and windows.

getUserKey

public abstract K getUserKey()

Returns the key that the timer is set on.

getDynamicTimerTag

public abstract java.lang.String getDynamicTimerTag()

Returns the tag that the timer is set on. The tag is "" when the timer is for a TimerSpec.

getWindows

public abstract java.util.Collection<? extends BoundedWindow> getWindows()

Returns the windows which are associated with the timer.

getClearBit

public abstract boolean getClearBit()

Returns whether the timer is going to be cleared.

getFireTimestamp

public abstract @Nullable org.joda.time.Instant getFireTimestamp()

Returns the timestamp of when the timer is scheduled to fire. This field is nullable only when the timer is being cleared.

The time is absolute to the time domain defined in the RunnerApi.TimerFamilySpec that is associated with this timer.

getHoldTimestamp

public abstract @Nullable org.joda.time.Instant getHoldTimestamp()

Returns the watermark that the timer is supposed to be held. This field is nullable only when the timer is being cleared.

getPane

public abstract @Nullable PaneInfo getPane()

Returns the PaneInfo that is related to the timer. This field is nullable only when the timer is being cleared.

equals

public final boolean equals(@Nullable java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object