ExecutionConfig (flink 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.flink.api.common.ExecutionConfig

All Implemented Interfaces:

Serializable
```
@Public
public class ExecutionConfig
extends Object
implements Serializable
```
A config to define the behavior of the program execution. It allows to define (among other options) the following settings:
- The default parallelism of the program, i.e., how many parallel tasks to use for all functions that do not define a specific value directly.
- The number of retries in the case of failed executions.
- The delay between delay between execution retries.
- The ExecutionMode of the program: Batch or Pipelined. The default execution mode is ExecutionMode.PIPELINED
- Enabling or disabling the "closure cleaner". The closure cleaner pre-processes the implementations of functions. In case they are (anonymous) inner classes, it removes unused references to the enclosing class to fix certain serialization-related problems and to reduce the size of the closure.
- The config allows to register types and serializers to increase the efficiency of handling generic types and POJOs. This is usually only needed when the functions return not only the types declared in their signature, but also subclasses of those types.
- The CodeAnalysisMode of the program: Enable hinting/optimizing or disable the "static code analyzer". The static code analyzer pre-interprets user-defined functions in order to get implementation insights for program improvements that can be printed to the log or automatically applied.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ExecutionConfig.GlobalJobParameters` Abstract class for a custom user configuration object registered at the execution config.
`static class`	`ExecutionConfig.SerializableSerializer<T extends com.esotericsoftware.kryo.Serializer<?> & Serializable>`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONFIG_KEY`
`static int`	`PARALLELISM_AUTO_MAX` The constant to use for the parallelism, if the system should use the number of currently available slots.

Constructor Summary

Constructors
Constructor and Description

ExecutionConfig()

Constructors
Constructor and Description
`ExecutionConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDefaultKryoSerializer(Class<?> type, Class<? extends com.esotericsoftware.kryo.Serializer<?>> serializerClass)` Adds a new Kryo default serializer to the Runtime.
`<T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void`	`addDefaultKryoSerializer(Class<?> type, T serializer)` Adds a new Kryo default serializer to the Runtime.
`boolean`	`canEqual(Object obj)`
`void`	`disableAutoTypeRegistration()` Control whether Flink is automatically registering all types in the user programs with Kryo.
`ExecutionConfig`	`disableClosureCleaner()` Disables the ClosureCleaner.
`void`	`disableForceAvro()`
`void`	`disableForceKryo()` Disable use of Kryo serializer for all POJOs.
`ExecutionConfig`	`disableObjectReuse()` Disables reusing objects that Flink internally uses for deserialization and passing data to user-code functions.
`ExecutionConfig`	`disableSysoutLogging()` Disables the printing of progress update messages to `System.out`
`ExecutionConfig`	`enableClosureCleaner()` Enables the ClosureCleaner.
`void`	`enableForceAvro()` Force Flink to use the AvroSerializer for POJOs.
`void`	`enableForceKryo()` Force TypeExtractor to use Kryo serializer for POJOS even though we could analyze as POJO.
`ExecutionConfig`	`enableObjectReuse()` Enables reusing objects that Flink internally uses for deserialization and passing data to user-code functions.
`ExecutionConfig`	`enableSysoutLogging()` Enables the printing of progress update messages to `System.out`
`boolean`	`equals(Object obj)`
`long`	`getAutoWatermarkInterval()` Returns the interval of the automatic watermark emission.
`CodeAnalysisMode`	`getCodeAnalysisMode()` Returns the `CodeAnalysisMode` of the program.
`LinkedHashMap<Class<?>,Class<? extends com.esotericsoftware.kryo.Serializer<?>>>`	`getDefaultKryoSerializerClasses()` Returns the registered default Kryo Serializer classes.
`LinkedHashMap<Class<?>,ExecutionConfig.SerializableSerializer<?>>`	`getDefaultKryoSerializers()` Returns the registered default Kryo Serializers.
`ExecutionMode`	`getExecutionMode()` Gets the execution mode used to execute the program.
`long`	`getExecutionRetryDelay()` Deprecated. Should no longer be used because it is subsumed by RestartStrategyConfiguration
`ExecutionConfig.GlobalJobParameters`	`getGlobalJobParameters()`
`int`	`getNumberOfExecutionRetries()` Deprecated. Should no longer be used because it is subsumed by RestartStrategyConfiguration
`int`	`getParallelism()` Gets the parallelism with which operation are executed by default.
`LinkedHashSet<Class<?>>`	`getRegisteredKryoTypes()` Returns the registered Kryo types.
`LinkedHashSet<Class<?>>`	`getRegisteredPojoTypes()` Returns the registered POJO types.
`LinkedHashMap<Class<?>,Class<? extends com.esotericsoftware.kryo.Serializer<?>>>`	`getRegisteredTypesWithKryoSerializerClasses()` Returns the registered types with their Kryo Serializer classes.
`LinkedHashMap<Class<?>,ExecutionConfig.SerializableSerializer<?>>`	`getRegisteredTypesWithKryoSerializers()` Returns the registered types with Kryo Serializers.
`RestartStrategies.RestartStrategyConfiguration`	`getRestartStrategy()` Returns the restart strategy which has been set for the current job.
`int`	`hashCode()`
`boolean`	`isAutoTypeRegistrationDisabled()`
`boolean`	`isClosureCleanerEnabled()` Returns whether the ClosureCleaner is enabled.
`boolean`	`isForceAvroEnabled()`
`boolean`	`isForceKryoEnabled()`
`boolean`	`isObjectReuseEnabled()` Returns whether object reuse has been enabled or disabled.
`boolean`	`isSysoutLoggingEnabled()` Gets whether progress update messages should be printed to `System.out`
`void`	`registerKryoType(Class<?> type)` Registers the given type with the serialization stack.
`void`	`registerPojoType(Class<?> type)` Registers the given type with the serialization stack.
`void`	`registerTypeWithKryoSerializer(Class<?> type, Class<? extends com.esotericsoftware.kryo.Serializer<?>> serializerClass)` Registers the given Serializer via its class as a serializer for the given type at the KryoSerializer
`<T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void`	`registerTypeWithKryoSerializer(Class<?> type, T serializer)` Registers the given type with a Kryo Serializer.
`ExecutionConfig`	`setAutoWatermarkInterval(long interval)` Sets the interval of the automatic watermark emission.
`void`	`setCodeAnalysisMode(CodeAnalysisMode codeAnalysisMode)` Sets the `CodeAnalysisMode` of the program.
`void`	`setExecutionMode(ExecutionMode executionMode)` Sets the execution mode to execute the program.
`ExecutionConfig`	`setExecutionRetryDelay(long executionRetryDelay)` Deprecated. This method will be replaced by `setRestartStrategy(org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration)`. The `RestartStrategies.FixedDelayRestartStrategyConfiguration` contains the delay between successive execution attempts.
`void`	`setGlobalJobParameters(ExecutionConfig.GlobalJobParameters globalJobParameters)` Register a custom, serializable user configuration object.
`ExecutionConfig`	`setNumberOfExecutionRetries(int numberOfExecutionRetries)` Deprecated. This method will be replaced by `setRestartStrategy(org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration)`. The `RestartStrategies.FixedDelayRestartStrategyConfiguration` contains the number of execution retries.
`ExecutionConfig`	`setParallelism(int parallelism)` Sets the parallelism for operations executed through this environment.
`void`	`setRestartStrategy(RestartStrategies.RestartStrategyConfiguration restartStrategyConfiguration)` Sets the restart strategy to be used for recovery.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONFIG_KEY
```
public static final String CONFIG_KEY
```
    See Also:
    
    Constant Field Values
  - PARALLELISM_AUTO_MAX
```
public static final int PARALLELISM_AUTO_MAX
```
    The constant to use for the parallelism, if the system should use the number of currently available slots.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExecutionConfig
```
public ExecutionConfig()
```
- Method Detail
  - enableClosureCleaner
```
public ExecutionConfig enableClosureCleaner()
```
    Enables the ClosureCleaner. This analyzes user code functions and sets fields to null that are not used. This will in most cases make closures or anonymous inner classes serializable that where not serializable due to some Scala or Java implementation artifact. User code must be serializable because it needs to be sent to worker nodes.
  - disableClosureCleaner
```
public ExecutionConfig disableClosureCleaner()
```
    Disables the ClosureCleaner.
    
    See Also:
    
    enableClosureCleaner()
  - isClosureCleanerEnabled
```
public boolean isClosureCleanerEnabled()
```
    Returns whether the ClosureCleaner is enabled.
    
    See Also:
    
    enableClosureCleaner()
  - setAutoWatermarkInterval
```
@PublicEvolving
public ExecutionConfig setAutoWatermarkInterval(long interval)
```
    Sets the interval of the automatic watermark emission. Watermaks are used throughout the streaming system to keep track of the progress of time. They are used, for example, for time based windowing.
    
    Parameters:
    
    interval - The interval between watermarks in milliseconds.
  - getAutoWatermarkInterval
```
@PublicEvolving
public long getAutoWatermarkInterval()
```
    Returns the interval of the automatic watermark emission.
    
    See Also:
    
    setAutoWatermarkInterval(long)
  - getParallelism
```
public int getParallelism()
```
    Gets the parallelism with which operation are executed by default. Operations can individually override this value to use a specific parallelism. Other operations may need to run with a different parallelism - for example calling a reduce operation over the entire data set will involve an operation that runs with a parallelism of one (the final reduce to the single result value).
    
    Returns:
    
    The parallelism used by operations, unless they override that value. This method returns -1, if the environment's default parallelism should be used.
  - setParallelism
```
public ExecutionConfig setParallelism(int parallelism)
```
    Sets the parallelism for operations executed through this environment. Setting a parallelism of x here will cause all operators (such as join, map, reduce) to run with x parallel instances.
    This method overrides the default parallelism for this environment. The local execution environment uses by default a value equal to the number of hardware contexts (CPU cores / threads). When executing the program via the command line client from a JAR file, the default parallelism is the one configured for that setup.
    
    Parameters:
    
    parallelism - The parallelism to use
  - setRestartStrategy
```
@PublicEvolving
public void setRestartStrategy(RestartStrategies.RestartStrategyConfiguration restartStrategyConfiguration)
```
    Sets the restart strategy to be used for recovery.
```
 ExecutionConfig config = env.getConfig();

 config.setRestartStrategy(RestartStrategies.fixedDelayRestart(
 	10,  // number of retries
 	1000 // delay between retries));
 
```
    Parameters:
    
    restartStrategyConfiguration - Configuration defining the restart strategy to use
  - getRestartStrategy
```
@PublicEvolving
public RestartStrategies.RestartStrategyConfiguration getRestartStrategy()
```
    Returns the restart strategy which has been set for the current job.
    
    Returns:
    
    The specified restart configuration
  - getNumberOfExecutionRetries
```
@Deprecated
public int getNumberOfExecutionRetries()
```
    Deprecated. Should no longer be used because it is subsumed by RestartStrategyConfiguration
    
    Gets the number of times the system will try to re-execute failed tasks. A value of -1 indicates that the system default value (as defined in the configuration) should be used.
    
    Returns:
    
    The number of times the system will try to re-execute failed tasks.
  - getExecutionRetryDelay
```
@Deprecated
public long getExecutionRetryDelay()
```
    Deprecated. Should no longer be used because it is subsumed by RestartStrategyConfiguration
    
    Returns the delay between execution retries.
    
    Returns:
    
    The delay between successive execution retries in milliseconds.
  - setNumberOfExecutionRetries
```
@Deprecated
public ExecutionConfig setNumberOfExecutionRetries(int numberOfExecutionRetries)
```
    Deprecated. This method will be replaced by setRestartStrategy(org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration). The RestartStrategies.FixedDelayRestartStrategyConfiguration contains the number of execution retries.
    
    Sets the number of times that failed tasks are re-executed. A value of zero effectively disables fault tolerance. A value of -1 indicates that the system default value (as defined in the configuration) should be used.
    
    Parameters:
    
    numberOfExecutionRetries - The number of times the system will try to re-execute failed tasks.
    
    Returns:
    
    The current execution configuration
  - setExecutionRetryDelay
```
@Deprecated
public ExecutionConfig setExecutionRetryDelay(long executionRetryDelay)
```
    Deprecated. This method will be replaced by setRestartStrategy(org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration). The RestartStrategies.FixedDelayRestartStrategyConfiguration contains the delay between successive execution attempts.
    
    Sets the delay between executions.
    
    Parameters:
    
    executionRetryDelay - The number of milliseconds the system will wait to retry.
    
    Returns:
    
    The current execution configuration
  - setExecutionMode
```
public void setExecutionMode(ExecutionMode executionMode)
```
    Sets the execution mode to execute the program. The execution mode defines whether data exchanges are performed in a batch or on a pipelined manner. The default execution mode is ExecutionMode.PIPELINED.
    
    Parameters:
    
    executionMode - The execution mode to use.
  - getExecutionMode
```
public ExecutionMode getExecutionMode()
```
    Gets the execution mode used to execute the program. The execution mode defines whether data exchanges are performed in a batch or on a pipelined manner. The default execution mode is ExecutionMode.PIPELINED.
    
    Returns:
    
    The execution mode for the program.
  - enableForceKryo
```
public void enableForceKryo()
```
    Force TypeExtractor to use Kryo serializer for POJOS even though we could analyze as POJO. In some cases this might be preferable. For example, when using interfaces with subclasses that cannot be analyzed as POJO.
  - disableForceKryo
```
public void disableForceKryo()
```
    Disable use of Kryo serializer for all POJOs.
  - isForceKryoEnabled
```
public boolean isForceKryoEnabled()
```
  - enableForceAvro
```
public void enableForceAvro()
```
    Force Flink to use the AvroSerializer for POJOs.
  - disableForceAvro
```
public void disableForceAvro()
```
  - isForceAvroEnabled
```
public boolean isForceAvroEnabled()
```
  - enableObjectReuse
```
public ExecutionConfig enableObjectReuse()
```
    Enables reusing objects that Flink internally uses for deserialization and passing data to user-code functions. Keep in mind that this can lead to bugs when the user-code function of an operation is not aware of this behaviour.
  - disableObjectReuse
```
public ExecutionConfig disableObjectReuse()
```
    Disables reusing objects that Flink internally uses for deserialization and passing data to user-code functions. @see #enableObjectReuse()
  - isObjectReuseEnabled
```
public boolean isObjectReuseEnabled()
```
    Returns whether object reuse has been enabled or disabled. @see #enableObjectReuse()
  - setCodeAnalysisMode
```
@PublicEvolving
public void setCodeAnalysisMode(CodeAnalysisMode codeAnalysisMode)
```
    Sets the CodeAnalysisMode of the program. Specifies to which extent user-defined functions are analyzed in order to give the Flink optimizer an insight of UDF internals and inform the user about common implementation mistakes. The static code analyzer pre-interprets user-defined functions in order to get implementation insights for program improvements that can be printed to the log, automatically applied, or disabled.
    
    Parameters:
    
    codeAnalysisMode - see CodeAnalysisMode
  - getCodeAnalysisMode
```
@PublicEvolving
public CodeAnalysisMode getCodeAnalysisMode()
```
    Returns the CodeAnalysisMode of the program.
  - enableSysoutLogging
```
public ExecutionConfig enableSysoutLogging()
```
    Enables the printing of progress update messages to System.out
    
    Returns:
    
    The ExecutionConfig object, to allow for function chaining.
  - disableSysoutLogging
```
public ExecutionConfig disableSysoutLogging()
```
    Disables the printing of progress update messages to System.out
    
    Returns:
    
    The ExecutionConfig object, to allow for function chaining.
  - isSysoutLoggingEnabled
```
public boolean isSysoutLoggingEnabled()
```
    Gets whether progress update messages should be printed to System.out
    
    Returns:
    
    True, if progress update messages should be printed, false otherwise.
  - getGlobalJobParameters
```
public ExecutionConfig.GlobalJobParameters getGlobalJobParameters()
```
  - setGlobalJobParameters
```
public void setGlobalJobParameters(ExecutionConfig.GlobalJobParameters globalJobParameters)
```
    Register a custom, serializable user configuration object.
    
    Parameters:
    
    globalJobParameters - Custom user configuration object
  - addDefaultKryoSerializer
```
public <T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void addDefaultKryoSerializer(Class<?> type,
                                                                                                        T serializer)
```
    Adds a new Kryo default serializer to the Runtime. Note that the serializer instance must be serializable (as defined by java.io.Serializable), because it may be distributed to the worker nodes by java serialization.
    
    Parameters:
    
    type - The class of the types serialized with the given serializer.
    
    serializer - The serializer to use.
  - addDefaultKryoSerializer
```
public void addDefaultKryoSerializer(Class<?> type,
                                     Class<? extends com.esotericsoftware.kryo.Serializer<?>> serializerClass)
```
    Adds a new Kryo default serializer to the Runtime.
    
    Parameters:
    
    type - The class of the types serialized with the given serializer.
    
    serializerClass - The class of the serializer to use.
  - registerTypeWithKryoSerializer
```
public <T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void registerTypeWithKryoSerializer(Class<?> type,
                                                                                                              T serializer)
```
    Registers the given type with a Kryo Serializer. Note that the serializer instance must be serializable (as defined by java.io.Serializable), because it may be distributed to the worker nodes by java serialization.
    
    Parameters:
    
    type - The class of the types serialized with the given serializer.
    
    serializer - The serializer to use.
  - registerTypeWithKryoSerializer
```
public void registerTypeWithKryoSerializer(Class<?> type,
                                           Class<? extends com.esotericsoftware.kryo.Serializer<?>> serializerClass)
```
    Registers the given Serializer via its class as a serializer for the given type at the KryoSerializer
    
    Parameters:
    
    type - The class of the types serialized with the given serializer.
    
    serializerClass - The class of the serializer to use.
  - registerPojoType
```
public void registerPojoType(Class<?> type)
```
    Registers the given type with the serialization stack. If the type is eventually serialized as a POJO, then the type is registered with the POJO serializer. If the type ends up being serialized with Kryo, then it will be registered at Kryo to make sure that only tags are written.
    
    Parameters:
    
    type - The class of the type to register.
  - registerKryoType
```
public void registerKryoType(Class<?> type)
```
    Registers the given type with the serialization stack. If the type is eventually serialized as a POJO, then the type is registered with the POJO serializer. If the type ends up being serialized with Kryo, then it will be registered at Kryo to make sure that only tags are written.
    
    Parameters:
    
    type - The class of the type to register.
  - getRegisteredTypesWithKryoSerializers
```
public LinkedHashMap<Class<?>,ExecutionConfig.SerializableSerializer<?>> getRegisteredTypesWithKryoSerializers()
```
    Returns the registered types with Kryo Serializers.
  - getRegisteredTypesWithKryoSerializerClasses
```
public LinkedHashMap<Class<?>,Class<? extends com.esotericsoftware.kryo.Serializer<?>>> getRegisteredTypesWithKryoSerializerClasses()
```
    Returns the registered types with their Kryo Serializer classes.
  - getDefaultKryoSerializers
```
public LinkedHashMap<Class<?>,ExecutionConfig.SerializableSerializer<?>> getDefaultKryoSerializers()
```
    Returns the registered default Kryo Serializers.
  - getDefaultKryoSerializerClasses
```
public LinkedHashMap<Class<?>,Class<? extends com.esotericsoftware.kryo.Serializer<?>>> getDefaultKryoSerializerClasses()
```
    Returns the registered default Kryo Serializer classes.
  - getRegisteredKryoTypes
```
public LinkedHashSet<Class<?>> getRegisteredKryoTypes()
```
    Returns the registered Kryo types.
  - getRegisteredPojoTypes
```
public LinkedHashSet<Class<?>> getRegisteredPojoTypes()
```
    Returns the registered POJO types.
  - isAutoTypeRegistrationDisabled
```
public boolean isAutoTypeRegistrationDisabled()
```
  - disableAutoTypeRegistration
```
public void disableAutoTypeRegistration()
```
    Control whether Flink is automatically registering all types in the user programs with Kryo.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - canEqual
```
public boolean canEqual(Object obj)
```

Back to Flink Website

Class ExecutionConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIG_KEY

PARALLELISM_AUTO_MAX

Constructor Detail

ExecutionConfig

Method Detail

enableClosureCleaner

disableClosureCleaner

isClosureCleanerEnabled

setAutoWatermarkInterval

getAutoWatermarkInterval

getParallelism

setParallelism

setRestartStrategy

getRestartStrategy

getNumberOfExecutionRetries

getExecutionRetryDelay

setNumberOfExecutionRetries

setExecutionRetryDelay

setExecutionMode

getExecutionMode

enableForceKryo

disableForceKryo

isForceKryoEnabled

enableForceAvro

disableForceAvro

isForceAvroEnabled

enableObjectReuse

disableObjectReuse

isObjectReuseEnabled

setCodeAnalysisMode

getCodeAnalysisMode

enableSysoutLogging

disableSysoutLogging

isSysoutLoggingEnabled

getGlobalJobParameters

setGlobalJobParameters

addDefaultKryoSerializer

addDefaultKryoSerializer

registerTypeWithKryoSerializer

registerTypeWithKryoSerializer

registerPojoType

registerKryoType

getRegisteredTypesWithKryoSerializers

getRegisteredTypesWithKryoSerializerClasses

getDefaultKryoSerializers

getDefaultKryoSerializerClasses

getRegisteredKryoTypes

getRegisteredPojoTypes

isAutoTypeRegistrationDisabled

disableAutoTypeRegistration

equals

hashCode

canEqual

Back to Flink Website