Package org.apache.flink.configuration

Class ClusterOptions

java.lang.Object

org.apache.flink.configuration.ClusterOptions

@PublicEvolving
public class ClusterOptions
extends Object

Options which control the cluster behaviour.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusterOptions.UncaughtExceptionHandleMode
static class	ClusterOptions.UserSystemExitMode	The mode of how to handle user code attempting to exit JVM.

Field Summary

Fields

Modifier and Type	Field	Description
static ConfigOption<Integer>	CLUSTER_IO_EXECUTOR_POOL_SIZE
static ConfigOption<java.time.Duration>	CLUSTER_SERVICES_SHUTDOWN_TIMEOUT
static ConfigOption<java.time.Duration>	ERROR_REGISTRATION_DELAY
static ConfigOption<Boolean>	EVENLY_SPREAD_OUT_SLOTS_STRATEGY	Deprecated. Please use TaskManagerOptions.TASK_MANAGER_LOAD_BALANCE_MODE instead.
static ConfigOption<Boolean>	FINE_GRAINED_SHUFFLE_MODE_ALL_BLOCKING	Deprecated. The option is unnecessary.
static ConfigOption<Boolean>	HALT_ON_FATAL_ERROR
static ConfigOption<java.time.Duration>	INITIAL_REGISTRATION_TIMEOUT
static ConfigOption<ClusterOptions.UserSystemExitMode>	INTERCEPT_USER_SYSTEM_EXIT
static ConfigOption<String>	JOB_MANAGER_PROCESS_WORKING_DIR_BASE
static ConfigOption<java.time.Duration>	MAX_REGISTRATION_TIMEOUT
static ConfigOption<String>	PROCESS_WORKING_DIR_BASE
static ConfigOption<java.time.Duration>	REFUSED_REGISTRATION_DELAY
static ConfigOption<String>	TASK_MANAGER_PROCESS_WORKING_DIR_BASE
static ConfigOption<Integer>	THREAD_DUMP_STACKTRACE_MAX_DEPTH
static ConfigOption<ClusterOptions.UncaughtExceptionHandleMode>	UNCAUGHT_EXCEPTION_HANDLING

Constructor Summary

Constructors

Constructor	Description
ClusterOptions()

Method Summary

Modifier and Type	Method	Description
static JobManagerOptions.SchedulerType	getSchedulerType(Configuration configuration)
static boolean	isAdaptiveSchedulerEnabled(Configuration configuration)
static boolean	isReactiveModeEnabled(Configuration configuration)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INITIAL_REGISTRATION_TIMEOUT

public static final ConfigOption<java.time.Duration> INITIAL_REGISTRATION_TIMEOUT

MAX_REGISTRATION_TIMEOUT

public static final ConfigOption<java.time.Duration> MAX_REGISTRATION_TIMEOUT

ERROR_REGISTRATION_DELAY

public static final ConfigOption<java.time.Duration> ERROR_REGISTRATION_DELAY

REFUSED_REGISTRATION_DELAY

public static final ConfigOption<java.time.Duration> REFUSED_REGISTRATION_DELAY

CLUSTER_SERVICES_SHUTDOWN_TIMEOUT

public static final ConfigOption<java.time.Duration> CLUSTER_SERVICES_SHUTDOWN_TIMEOUT

CLUSTER_IO_EXECUTOR_POOL_SIZE

public static final ConfigOption<Integer> CLUSTER_IO_EXECUTOR_POOL_SIZE

EVENLY_SPREAD_OUT_SLOTS_STRATEGY

@Deprecated
public static final ConfigOption<Boolean> EVENLY_SPREAD_OUT_SLOTS_STRATEGY

Deprecated.

Please use TaskManagerOptions.TASK_MANAGER_LOAD_BALANCE_MODE instead. Note: The 'taskmanager.load-balance.mode: SLOTS' is equal to 'cluster.evenly-spread-out-slots: true'. The 'taskmanager.load-balance.mode: NONE' is equal to 'cluster.evenly-spread-out-slots: false'.

HALT_ON_FATAL_ERROR

public static final ConfigOption<Boolean> HALT_ON_FATAL_ERROR

INTERCEPT_USER_SYSTEM_EXIT

public static final ConfigOption<ClusterOptions.UserSystemExitMode> INTERCEPT_USER_SYSTEM_EXIT

THREAD_DUMP_STACKTRACE_MAX_DEPTH

public static final ConfigOption<Integer> THREAD_DUMP_STACKTRACE_MAX_DEPTH

FINE_GRAINED_SHUFFLE_MODE_ALL_BLOCKING

@Deprecated
public static final ConfigOption<Boolean> FINE_GRAINED_SHUFFLE_MODE_ALL_BLOCKING

Deprecated.

The option is unnecessary. It is deprecated in 1.20 and will be removed in 2.0.

UNCAUGHT_EXCEPTION_HANDLING

public static final ConfigOption<ClusterOptions.UncaughtExceptionHandleMode> UNCAUGHT_EXCEPTION_HANDLING

PROCESS_WORKING_DIR_BASE

public static final ConfigOption<String> PROCESS_WORKING_DIR_BASE

JOB_MANAGER_PROCESS_WORKING_DIR_BASE

public static final ConfigOption<String> JOB_MANAGER_PROCESS_WORKING_DIR_BASE

TASK_MANAGER_PROCESS_WORKING_DIR_BASE

public static final ConfigOption<String> TASK_MANAGER_PROCESS_WORKING_DIR_BASE

Constructor Detail

ClusterOptions

public ClusterOptions()

Method Detail

getSchedulerType

public static JobManagerOptions.SchedulerType getSchedulerType(Configuration configuration)

isReactiveModeEnabled

public static boolean isReactiveModeEnabled(Configuration configuration)

isAdaptiveSchedulerEnabled

public static boolean isAdaptiveSchedulerEnabled(Configuration configuration)