org.apache.flink.streaming.api.transformations

Enum ShuffleMode

java.lang.Object

java.lang.Enum<ShuffleMode>

org.apache.flink.streaming.api.transformations.ShuffleMode

All Implemented Interfaces:

Serializable, Comparable<ShuffleMode>

@PublicEvolving
public enum ShuffleMode
extends Enum<ShuffleMode>

The shuffle mode defines the data exchange mode between operators.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BATCH The producer first produces its entire result and finishes.
PIPELINED Producer and consumer are online at the same time.
UNDEFINED The shuffle mode is undefined.

Method Summary

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

PIPELINED

public static final ShuffleMode PIPELINED

Producer and consumer are online at the same time. Produced data is received by consumer immediately.

BATCH

public static final ShuffleMode BATCH

The producer first produces its entire result and finishes. After that, the consumer is started and may consume the data.

UNDEFINED

public static final ShuffleMode UNDEFINED

The shuffle mode is undefined. It leaves it up to the framework to decide the shuffle mode. The framework will pick one of BATCH or PIPELINED in the end.

Method Detail

values

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

Returns:

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

valueOf

public static ShuffleMode 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