org.apache.beam.sdk.transforms.windowing

Class AfterProcessingTime

java.lang.Object

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

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

org.apache.beam.sdk.transforms.windowing.AfterProcessingTime

All Implemented Interfaces:

java.io.Serializable

@Experimental(value=TRIGGER)
public class AfterProcessingTime
extends Trigger.OnceTrigger

A Trigger trigger that fires at a specified point in processing time, relative to when input first arrives.

See Also:

Serialized Form

Nested Class Summary

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

Trigger.OnceTrigger

Field Summary

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

subTriggers

Method Summary

Modifier and Type	Method and Description
AfterProcessingTime	alignedTo(Duration period) Aligns the time to be the smallest multiple of period greater than the epoch boundary (aka new Instant(0)).
AfterProcessingTime	alignedTo(Duration period, Instant offset) Aligns timestamps to the smallest multiple of period since the offset greater than the timestamp.
boolean	equals(java.lang.Object obj)
protected Trigger	getContinuationTrigger(java.util.List<Trigger> continuationTriggers) Subclasses should override this to return the Trigger.getContinuationTrigger() of this Trigger.
java.util.List<TimestampTransform>	getTimestampTransforms() The transforms applied to the arrival time of an element to determine when this trigger allows output.
Instant	getWatermarkThatGuaranteesFiring(BoundedWindow window) For internal use only; no backwards-compatibility guarantees.
int	hashCode()
boolean	isCompatible(Trigger other) For internal use only; no backwards-compatibility guarantees.
static AfterProcessingTime	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.
AfterProcessingTime	plusDelayOf(Duration delay) Adds some delay to the original target time.
java.lang.String	toString()

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

getContinuationTrigger, mayFinish

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

orFinally, subTriggers

Methods inherited from class java.lang.Object

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

Method Detail

pastFirstElementInPane

public static AfterProcessingTime 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.

getTimestampTransforms

public java.util.List<TimestampTransform> getTimestampTransforms()

The transforms applied to the arrival time of an element to determine when this trigger allows output.

plusDelayOf

public AfterProcessingTime plusDelayOf(Duration delay)

Adds some delay to the original target time.

Parameters:

delay - the delay to add

Returns:

An updated time trigger that will wait the additional time before firing.

alignedTo

public AfterProcessingTime alignedTo(Duration period,
                                     Instant offset)

Aligns timestamps to the smallest multiple of period since the offset greater than the timestamp.

alignedTo

public AfterProcessingTime alignedTo(Duration period)

Aligns the time to be the smallest multiple of period greater than the epoch boundary (aka new Instant(0)).

isCompatible

public boolean isCompatible(Trigger other)

Description copied from class: Trigger

For internal use only; no backwards-compatibility guarantees.

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

Overrides:

isCompatible in class Trigger

getWatermarkThatGuaranteesFiring

public Instant getWatermarkThatGuaranteesFiring(BoundedWindow window)

Description copied from class: Trigger

For internal use only; no backwards-compatibility guarantees.

Returns a bound in event time by which this trigger would have fired at least once for a given window had there been input data.

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

This estimate may be used, for example, 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

getContinuationTrigger

protected Trigger getContinuationTrigger(java.util.List<Trigger> continuationTriggers)

Description copied from class: Trigger

Subclasses should override this to return the Trigger.getContinuationTrigger() of this Trigger. For convenience, this is provided the continuation trigger of each of the sub-triggers in the same order as Trigger.subTriggers.

Specified by:

getContinuationTrigger in class Trigger

Parameters:

continuationTriggers - null if Trigger.subTriggers is null, otherwise contains the result of Trigger.getContinuationTrigger() on each of the subTriggers in the same order.

toString

public java.lang.String toString()

Overrides:

toString in class Trigger

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Trigger

hashCode

public int hashCode()

Overrides:

hashCode in class Trigger