org.apache.flink.streaming.api.graph

Enum StreamConfig.InputRequirement

java.lang.Object

java.lang.Enum<StreamConfig.InputRequirement>

org.apache.flink.streaming.api.graph.StreamConfig.InputRequirement

All Implemented Interfaces:

Serializable, Comparable<StreamConfig.InputRequirement>

Enclosing class:

StreamConfig

public static enum StreamConfig.InputRequirement
extends Enum<StreamConfig.InputRequirement>

Requirements of the different inputs of an operator. Each input can have a different requirement. For all SORTED inputs, records are sorted/grouped by key and all records of a given key are passed to the operator consecutively before moving on to the next group.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PASS_THROUGH Records from PASS_THROUGH inputs are passed to the operator before passing any records from SORTED inputs.
SORTED Records from all sorted inputs are grouped (sorted) by key and are then fed to the operator one group at a time.

Method Summary

Modifier and Type	Method and Description
static StreamConfig.InputRequirement	valueOf(String name) Returns the enum constant of this type with the specified name.
static StreamConfig.InputRequirement[]	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

SORTED

public static final StreamConfig.InputRequirement SORTED

Records from all sorted inputs are grouped (sorted) by key and are then fed to the operator one group at a time. This "zig-zags" between different inputs if records for the same key arrive on multiple inputs to ensure that the operator sees all records with a key as one consecutive group.

PASS_THROUGH

public static final StreamConfig.InputRequirement PASS_THROUGH

Records from PASS_THROUGH inputs are passed to the operator before passing any records from SORTED inputs. There are no guarantees on ordering between and within the different PASS_THROUGH inputs.

Method Detail

values

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

Returns:

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

valueOf

public static StreamConfig.InputRequirement 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