Package org.apache.flink.streaming.api.transformations

Enum StreamExchangeMode

java.lang.Object

java.lang.Enum<StreamExchangeMode>

org.apache.flink.streaming.api.transformations.StreamExchangeMode

All Implemented Interfaces:

Serializable, Comparable<StreamExchangeMode>

@Internal
public enum StreamExchangeMode
extends Enum<StreamExchangeMode>

The data exchange mode between operators during StreamGraph generation.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BATCH	The producer first produces its entire result and finishes.
HYBRID_FULL	The consumer can start consuming data anytime as long as the producer has started producing.
HYBRID_SELECTIVE	The consumer can start consuming data anytime as long as the producer has started producing.
PIPELINED	Producer and consumer are online at the same time.
UNDEFINED	The exchange mode is undefined.

Method Summary

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

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

BATCH

public static final StreamExchangeMode BATCH

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

HYBRID_FULL

public static final StreamExchangeMode HYBRID_FULL

The consumer can start consuming data anytime as long as the producer has started producing.

This exchange mode is re-consumable.

HYBRID_SELECTIVE

public static final StreamExchangeMode HYBRID_SELECTIVE

The consumer can start consuming data anytime as long as the producer has started producing.

This exchange mode is not re-consumable.

UNDEFINED

public static final StreamExchangeMode UNDEFINED

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

Method Detail

values

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

Returns:

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

valueOf

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