org.apache.beam.sdk.state

Enum TimeDomain

java.lang.Object

java.lang.Enum<TimeDomain>

org.apache.beam.sdk.state.TimeDomain

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimeDomain>

@Experimental(value=TIMERS)
public enum TimeDomain
extends java.lang.Enum<TimeDomain>

TimeDomain specifies whether an operation is based on timestamps of elements or current "real-world" time as reported while processing.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVENT_TIME The EVENT_TIME domain corresponds to the timestamps on the elements.
PROCESSING_TIME The PROCESSING_TIME domain corresponds to the current (system) time.
SYNCHRONIZED_PROCESSING_TIME For internal use only; no backwards compatibility guarantees.

Method Summary

Modifier and Type	Method and Description
static TimeDomain	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TimeDomain[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EVENT_TIME

public static final TimeDomain EVENT_TIME

The EVENT_TIME domain corresponds to the timestamps on the elements. Time advances on the system watermark advances.

PROCESSING_TIME

public static final TimeDomain PROCESSING_TIME

The PROCESSING_TIME domain corresponds to the current (system) time. This is advanced during execution of the pipeline.

SYNCHRONIZED_PROCESSING_TIME

@Internal
public static final TimeDomain SYNCHRONIZED_PROCESSING_TIME

For internal use only; no backwards compatibility guarantees.

Same as the PROCESSING_TIME domain, except it won't fire a timer set for time t until all timers from earlier stages set for a time earlier than t have fired.

Method Detail

values

public static TimeDomain[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TimeDomain c : TimeDomain.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TimeDomain valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null