org.apache.flink.api.common

Enum ExecutionMode

java.lang.Object

java.lang.Enum<ExecutionMode>

org.apache.flink.api.common.ExecutionMode

All Implemented Interfaces:

Serializable, Comparable<ExecutionMode>

@Public
public enum ExecutionMode
extends Enum<ExecutionMode>

The execution mode specifies how a batch program is executed in terms of data exchange: pipelining or batched.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BATCH This mode executes all shuffles and broadcasts in a batch fashion, while pipelining data between operations that exchange data only locally between one producer and one consumer.
BATCH_FORCED This mode executes the program in a strict batch way, including all points where data is forwarded locally from one producer to one consumer.
PIPELINED Executes the program in a pipelined fashion (including shuffles and broadcasts), except for data exchanges that are susceptible to deadlocks when pipelining.
PIPELINED_FORCED Executes the program in a pipelined fashion (including shuffles and broadcasts), including data exchanges that are susceptible to deadlocks when executed via pipelining.

Method Summary

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

Executes the program in a pipelined fashion (including shuffles and broadcasts), except for data exchanges that are susceptible to deadlocks when pipelining. These data exchanges are performed in a batch manner. An example of situations that are susceptible to deadlocks (when executed in a pipelined manner) are data flows that branch (one data set consumed by multiple operations) and re-join later:

 DataSet data = ...;
 DataSet mapped1 = data.map(new MyMapper());
 DataSet mapped2 = data.map(new AnotherMapper());
 mapped1.join(mapped2).where(...).equalTo(...);
 

PIPELINED_FORCED

public static final ExecutionMode PIPELINED_FORCED

Executes the program in a pipelined fashion (including shuffles and broadcasts), including data exchanges that are susceptible to deadlocks when executed via pipelining. Usually, PIPELINED is the preferable option, which pipelines most data exchanges and only uses batch data exchanges in situations that are susceptible to deadlocks. This option should only be used with care and only in situations where the programmer is sure that the program is safe for full pipelining and that Flink was too conservative when choosing the batch exchange at a certain point.

BATCH

public static final ExecutionMode BATCH

This mode executes all shuffles and broadcasts in a batch fashion, while pipelining data between operations that exchange data only locally between one producer and one consumer.

BATCH_FORCED

public static final ExecutionMode BATCH_FORCED

This mode executes the program in a strict batch way, including all points where data is forwarded locally from one producer to one consumer. This mode is typically more expensive to execute than the BATCH mode. It does guarantee that no successive operations are ever executed concurrently.

Method Detail

values

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

Returns:

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

valueOf

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