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

Enum Trigger.MergeResult

java.lang.Object

java.lang.Enum<Trigger.MergeResult>

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

All Implemented Interfaces:

Serializable, Comparable<Trigger.MergeResult>

Enclosing class:

Trigger<W extends BoundedWindow>

public static enum Trigger.MergeResult
extends Enum<Trigger.MergeResult>

TriggerResult enumerates the possible result a trigger can have when it is merged.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_FINISHED A trigger can only return ALREADY_FINISHED from onMerge, and it should only be returned if the trigger was previously finished in at least one window.
CONTINUE
FIRE
FIRE_AND_FINISH

Method Summary

Modifier and Type	Method and Description
Trigger.TriggerResult	getTriggerResult()
boolean	isFinish()
boolean	isFire()
static Trigger.MergeResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static Trigger.MergeResult[]	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

FIRE

public static final Trigger.MergeResult FIRE

CONTINUE

public static final Trigger.MergeResult CONTINUE

FIRE_AND_FINISH

public static final Trigger.MergeResult FIRE_AND_FINISH

ALREADY_FINISHED

public static final Trigger.MergeResult ALREADY_FINISHED

A trigger can only return ALREADY_FINISHED from onMerge, and it should only be returned if the trigger was previously finished in at least one window.

Returning this indicates that the sub-trigger should be treated as finished in the output window.

Method Detail

values

public static Trigger.MergeResult[] 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 (Trigger.MergeResult c : Trigger.MergeResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static Trigger.MergeResult valueOf(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:

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

NullPointerException - if the argument is null

isFire

public boolean isFire()

isFinish

public boolean isFinish()

getTriggerResult

public Trigger.TriggerResult getTriggerResult()