TaskManagerOptions (Flink : 1.18-SNAPSHOT API)

java.lang.Object
- org.apache.flink.configuration.TaskManagerOptions

```
@PublicEvolving
public class TaskManagerOptions
extends Object
```
The set of configuration options relating to TaskManager and Task settings.

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigOption<String>`	`BIND_HOST` The local address of the network interface that the task manager binds to.
`static ConfigOption<Boolean>`	`BUFFER_DEBLOAT_ENABLED`
`static ConfigOption<Duration>`	`BUFFER_DEBLOAT_PERIOD` The period between recalculation the relevant size of the buffer.
`static ConfigOption<Integer>`	`BUFFER_DEBLOAT_SAMPLES` The number of samples requires for the buffer size adjustment.
`static ConfigOption<Duration>`	`BUFFER_DEBLOAT_TARGET` The total time for which automated adjusted buffers should be fully consumed.
`static ConfigOption<Integer>`	`BUFFER_DEBLOAT_THRESHOLD_PERCENTAGES` Difference between the new and the old buffer size for applying the new value(in percent).
`static ConfigOption<Double>`	`CPU_CORES` This config option describes number of cpu cores of task executors.
`static ConfigOption<Boolean>`	`DEBUG_MEMORY_LOG`
`static ConfigOption<Long>`	`DEBUG_MEMORY_USAGE_LOG_INTERVAL_MS`
`static ConfigOption<Boolean>`	`EXIT_ON_FATAL_AKKA_ERROR` Deprecated.
`static ConfigOption<MemorySize>`	`FRAMEWORK_HEAP_MEMORY` Framework Heap Memory size for TaskExecutors.
`static ConfigOption<MemorySize>`	`FRAMEWORK_OFF_HEAP_MEMORY` Framework Off-Heap Memory size for TaskExecutors.
`static ConfigOption<String>`	`HOST` The external address of the network interface where the TaskManager is exposed.
`static ConfigOption<String>`	`HOST_BIND_POLICY` The config parameter for automatically defining the TaskManager's binding address, if `HOST` configuration option is not set.
`static ConfigOption<Duration>`	`INITIAL_REGISTRATION_BACKOFF` Deprecated. use `ClusterOptions.INITIAL_REGISTRATION_TIMEOUT` instead
`static ConfigOption<MemorySize>`	`JVM_METASPACE` JVM Metaspace Size for the TaskExecutors.
`static ConfigOption<Float>`	`JVM_OVERHEAD_FRACTION` Fraction of Total Process Memory to be reserved for JVM Overhead.
`static ConfigOption<MemorySize>`	`JVM_OVERHEAD_MAX` Max JVM Overhead size for the TaskExecutors.
`static ConfigOption<MemorySize>`	`JVM_OVERHEAD_MIN` Min JVM Overhead size for the TaskExecutors.
`static ConfigOption<Boolean>`	`KILL_ON_OUT_OF_MEMORY` Whether to kill the TaskManager when the task thread throws an OutOfMemoryError.
`static String`	`MANAGED_MEMORY_CONSUMER_NAME_DATAPROC` Deprecated. use `MANAGED_MEMORY_CONSUMER_NAME_OPERATOR` and `MANAGED_MEMORY_CONSUMER_NAME_STATE_BACKEND` instead
`static String`	`MANAGED_MEMORY_CONSUMER_NAME_OPERATOR`
`static String`	`MANAGED_MEMORY_CONSUMER_NAME_PYTHON`
`static String`	`MANAGED_MEMORY_CONSUMER_NAME_STATE_BACKEND`
`static ConfigOption<Map<String,String>>`	`MANAGED_MEMORY_CONSUMER_WEIGHTS` Weights of managed memory consumers.
`static ConfigOption<Float>`	`MANAGED_MEMORY_FRACTION` Fraction of Total Flink Memory to be used as Managed Memory, if `MANAGED_MEMORY_SIZE` is not specified.
`static ConfigOption<MemorySize>`	`MANAGED_MEMORY_SIZE` Managed Memory size for TaskExecutors.
`static ConfigOption<MemorySize>`	`MEMORY_SEGMENT_SIZE` Size of memory buffers used by the network stack and the memory manager.
`static ConfigOption<MemorySize>`	`MIN_MEMORY_SEGMENT_SIZE` Minimum possible size of memory buffers used by the network stack and the memory manager.
`static ConfigOption<MemorySize>`	`NETWORK_BATCH_SHUFFLE_READ_MEMORY` Size of direct memory used by batch shuffle for shuffle data read (currently only used by sort-shuffle and hybrid shuffle).
`static ConfigOption<Float>`	`NETWORK_MEMORY_FRACTION` Fraction of Total Flink Memory to be used as Network Memory.
`static ConfigOption<MemorySize>`	`NETWORK_MEMORY_MAX` Max Network Memory size for TaskExecutors.
`static ConfigOption<MemorySize>`	`NETWORK_MEMORY_MIN` Min Network Memory size for TaskExecutors.
`static ConfigOption<Integer>`	`NUM_TASK_SLOTS` The config parameter defining the number of task slots of a task manager.
`static ConfigOption<Duration>`	`REFUSED_REGISTRATION_BACKOFF` Deprecated. use `ClusterOptions.REFUSED_REGISTRATION_DELAY` instead
`static ConfigOption<Duration>`	`REGISTRATION_MAX_BACKOFF` Deprecated. use `ClusterOptions.MAX_REGISTRATION_TIMEOUT` instead
`static ConfigOption<Duration>`	`REGISTRATION_TIMEOUT` Defines the timeout it can take for the TaskManager registration.
`static ConfigOption<Integer>`	`RPC_BIND_PORT` The local port that the task manager binds to.
`static ConfigOption<String>`	`RPC_PORT` The default network port range the task manager expects incoming IPC connections.
`static ConfigOption<Duration>`	`SLOT_TIMEOUT` Timeout for identifying inactive slots.
`static ConfigOption<Long>`	`TASK_CANCELLATION_INTERVAL` Time interval in milliseconds between two successive task cancellation attempts.
`static ConfigOption<Long>`	`TASK_CANCELLATION_TIMEOUT` Timeout in milliseconds after which a task cancellation times out and leads to a fatal TaskManager error.
`static ConfigOption<Long>`	`TASK_CANCELLATION_TIMEOUT_TIMERS` This configures how long we wait for the timers in milliseconds to finish all pending timer threads when the stream task is cancelled.
`static ConfigOption<MemorySize>`	`TASK_HEAP_MEMORY` Task Heap Memory size for TaskExecutors.
`static ConfigOption<MemorySize>`	`TASK_MANAGER_HEAP_MEMORY` Deprecated. use `TOTAL_FLINK_MEMORY` for standalone setups and `TOTAL_PROCESS_MEMORY` for containerized setups.
`static ConfigOption<Integer>`	`TASK_MANAGER_HEAP_MEMORY_MB` Deprecated. use `TOTAL_FLINK_MEMORY` for standalone setups and `TOTAL_PROCESS_MEMORY` for containerized setups.
`static ConfigOption<String>`	`TASK_MANAGER_RESOURCE_ID` The TaskManager's ResourceID.
`static ConfigOption<MemorySize>`	`TASK_OFF_HEAP_MEMORY` Task Off-Heap Memory size for TaskExecutors.
`static ConfigOption<MemorySize>`	`TOTAL_FLINK_MEMORY` Total Flink Memory size for the TaskExecutors.
`static ConfigOption<MemorySize>`	`TOTAL_PROCESS_MEMORY` Total Process Memory size for the TaskExecutors.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MANAGED_MEMORY_CONSUMER_NAME_DATAPROC
```
@Deprecated
public static final String MANAGED_MEMORY_CONSUMER_NAME_DATAPROC
```
    Deprecated. use MANAGED_MEMORY_CONSUMER_NAME_OPERATOR and MANAGED_MEMORY_CONSUMER_NAME_STATE_BACKEND instead
    
    See Also:
    
    Constant Field Values
  - MANAGED_MEMORY_CONSUMER_NAME_OPERATOR
```
public static final String MANAGED_MEMORY_CONSUMER_NAME_OPERATOR
```
    See Also:
    
    Constant Field Values
  - MANAGED_MEMORY_CONSUMER_NAME_STATE_BACKEND
```
public static final String MANAGED_MEMORY_CONSUMER_NAME_STATE_BACKEND
```
    See Also:
    
    Constant Field Values
  - MANAGED_MEMORY_CONSUMER_NAME_PYTHON
```
public static final String MANAGED_MEMORY_CONSUMER_NAME_PYTHON
```
    See Also:
    
    Constant Field Values
  - TASK_MANAGER_HEAP_MEMORY
```
@Deprecated
public static final ConfigOption<MemorySize> TASK_MANAGER_HEAP_MEMORY
```
    Deprecated. use TOTAL_FLINK_MEMORY for standalone setups and TOTAL_PROCESS_MEMORY for containerized setups.
    
    JVM heap size for the TaskManagers with memory size.
  - TASK_MANAGER_HEAP_MEMORY_MB
```
@Deprecated
public static final ConfigOption<Integer> TASK_MANAGER_HEAP_MEMORY_MB
```
    Deprecated. use TOTAL_FLINK_MEMORY for standalone setups and TOTAL_PROCESS_MEMORY for containerized setups.
    
    JVM heap size (in megabytes) for the TaskManagers.
  - KILL_ON_OUT_OF_MEMORY
```
public static final ConfigOption<Boolean> KILL_ON_OUT_OF_MEMORY
```
    Whether to kill the TaskManager when the task thread throws an OutOfMemoryError.
  - EXIT_ON_FATAL_AKKA_ERROR
```
@Deprecated
public static final ConfigOption<Boolean> EXIT_ON_FATAL_AKKA_ERROR
```
    Deprecated.
    
    Whether the quarantine monitor for task managers shall be started. The quarantine monitor shuts down the actor system if it detects that it has quarantined another actor system or if it has been quarantined by another actor system.
  - HOST
```
public static final ConfigOption<String> HOST
```
    The external address of the network interface where the TaskManager is exposed. Overrides HOST_BIND_POLICY automatic address binding.
  - BIND_HOST
```
public static final ConfigOption<String> BIND_HOST
```
    The local address of the network interface that the task manager binds to.
  - RPC_PORT
```
public static final ConfigOption<String> RPC_PORT
```
    The default network port range the task manager expects incoming IPC connections. The "0" means that the TaskManager searches for a free port.
  - RPC_BIND_PORT
```
public static final ConfigOption<Integer> RPC_BIND_PORT
```
    The local port that the task manager binds to.
  - INITIAL_REGISTRATION_BACKOFF
```
@Deprecated
public static final ConfigOption<Duration> INITIAL_REGISTRATION_BACKOFF
```
    Deprecated. use ClusterOptions.INITIAL_REGISTRATION_TIMEOUT instead
    
    The initial registration backoff between two consecutive registration attempts. The backoff is doubled for each new registration attempt until it reaches the maximum registration backoff.
  - REGISTRATION_MAX_BACKOFF
```
@Deprecated
public static final ConfigOption<Duration> REGISTRATION_MAX_BACKOFF
```
    Deprecated. use ClusterOptions.MAX_REGISTRATION_TIMEOUT instead
    
    The maximum registration backoff between two consecutive registration attempts.
  - REFUSED_REGISTRATION_BACKOFF
```
@Deprecated
public static final ConfigOption<Duration> REFUSED_REGISTRATION_BACKOFF
```
    Deprecated. use ClusterOptions.REFUSED_REGISTRATION_DELAY instead
    
    The backoff after a registration has been refused by the job manager before retrying to connect.
  - REGISTRATION_TIMEOUT
```
public static final ConfigOption<Duration> REGISTRATION_TIMEOUT
```
    Defines the timeout it can take for the TaskManager registration. If the duration is exceeded without a successful registration, then the TaskManager terminates.
  - NUM_TASK_SLOTS
```
public static final ConfigOption<Integer> NUM_TASK_SLOTS
```
    The config parameter defining the number of task slots of a task manager.
  - SLOT_TIMEOUT
```
public static final ConfigOption<Duration> SLOT_TIMEOUT
```
    Timeout for identifying inactive slots.
  - DEBUG_MEMORY_LOG
```
public static final ConfigOption<Boolean> DEBUG_MEMORY_LOG
```
  - DEBUG_MEMORY_USAGE_LOG_INTERVAL_MS
```
public static final ConfigOption<Long> DEBUG_MEMORY_USAGE_LOG_INTERVAL_MS
```
  - MEMORY_SEGMENT_SIZE
```
public static final ConfigOption<MemorySize> MEMORY_SEGMENT_SIZE
```
    Size of memory buffers used by the network stack and the memory manager.
  - MIN_MEMORY_SEGMENT_SIZE
```
public static final ConfigOption<MemorySize> MIN_MEMORY_SEGMENT_SIZE
```
    Minimum possible size of memory buffers used by the network stack and the memory manager.
  - HOST_BIND_POLICY
```
public static final ConfigOption<String> HOST_BIND_POLICY
```
    The config parameter for automatically defining the TaskManager's binding address, if HOST configuration option is not set.
  - TASK_MANAGER_RESOURCE_ID
```
public static final ConfigOption<String> TASK_MANAGER_RESOURCE_ID
```
    The TaskManager's ResourceID. If not configured, the ResourceID will be generated with the RpcAddress:RpcPort and a 6-character random string. Notice that this option is not valid in Yarn and Native Kubernetes mode.
  - CPU_CORES
```
public static final ConfigOption<Double> CPU_CORES
```
    This config option describes number of cpu cores of task executors. In case of Yarn / Kubernetes, it is used to launch a container for the task executor.
    DO NOT USE THIS CONFIG OPTION. This config option is currently only used internally, for passing cpu cores into task executors for dynamic fine grained slot resource management. The feature is not completed at the moment, and the config option is experimental and might be changed / removed in the future. Thus, we do not expose this config option to users.
    For configuring the cpu cores of container on Yarn / Kubernetes, please use YarnConfigOptions#VCORES and KubernetesConfigOptions#TASK_MANAGER_CPU.
  - TOTAL_PROCESS_MEMORY
```
public static final ConfigOption<MemorySize> TOTAL_PROCESS_MEMORY
```
    Total Process Memory size for the TaskExecutors.
  - TOTAL_FLINK_MEMORY
```
public static final ConfigOption<MemorySize> TOTAL_FLINK_MEMORY
```
    Total Flink Memory size for the TaskExecutors.
  - FRAMEWORK_HEAP_MEMORY
```
public static final ConfigOption<MemorySize> FRAMEWORK_HEAP_MEMORY
```
    Framework Heap Memory size for TaskExecutors.
  - FRAMEWORK_OFF_HEAP_MEMORY
```
public static final ConfigOption<MemorySize> FRAMEWORK_OFF_HEAP_MEMORY
```
    Framework Off-Heap Memory size for TaskExecutors.
  - TASK_HEAP_MEMORY
```
public static final ConfigOption<MemorySize> TASK_HEAP_MEMORY
```
    Task Heap Memory size for TaskExecutors.
  - TASK_OFF_HEAP_MEMORY
```
public static final ConfigOption<MemorySize> TASK_OFF_HEAP_MEMORY
```
    Task Off-Heap Memory size for TaskExecutors.
  - MANAGED_MEMORY_SIZE
```
public static final ConfigOption<MemorySize> MANAGED_MEMORY_SIZE
```
    Managed Memory size for TaskExecutors.
  - MANAGED_MEMORY_FRACTION
```
public static final ConfigOption<Float> MANAGED_MEMORY_FRACTION
```
    Fraction of Total Flink Memory to be used as Managed Memory, if MANAGED_MEMORY_SIZE is not specified.
  - MANAGED_MEMORY_CONSUMER_WEIGHTS
```
public static final ConfigOption<Map<String,String>> MANAGED_MEMORY_CONSUMER_WEIGHTS
```
    Weights of managed memory consumers.
  - NETWORK_MEMORY_MIN
```
public static final ConfigOption<MemorySize> NETWORK_MEMORY_MIN
```
    Min Network Memory size for TaskExecutors.
  - NETWORK_MEMORY_MAX
```
public static final ConfigOption<MemorySize> NETWORK_MEMORY_MAX
```
    Max Network Memory size for TaskExecutors.
  - NETWORK_MEMORY_FRACTION
```
public static final ConfigOption<Float> NETWORK_MEMORY_FRACTION
```
    Fraction of Total Flink Memory to be used as Network Memory.
  - BUFFER_DEBLOAT_PERIOD
```
public static final ConfigOption<Duration> BUFFER_DEBLOAT_PERIOD
```
    The period between recalculation the relevant size of the buffer.
  - BUFFER_DEBLOAT_SAMPLES
```
public static final ConfigOption<Integer> BUFFER_DEBLOAT_SAMPLES
```
    The number of samples requires for the buffer size adjustment.
  - BUFFER_DEBLOAT_TARGET
```
public static final ConfigOption<Duration> BUFFER_DEBLOAT_TARGET
```
    The total time for which automated adjusted buffers should be fully consumed.
  - BUFFER_DEBLOAT_ENABLED
```
public static final ConfigOption<Boolean> BUFFER_DEBLOAT_ENABLED
```
  - BUFFER_DEBLOAT_THRESHOLD_PERCENTAGES
```
public static final ConfigOption<Integer> BUFFER_DEBLOAT_THRESHOLD_PERCENTAGES
```
    Difference between the new and the old buffer size for applying the new value(in percent).
  - NETWORK_BATCH_SHUFFLE_READ_MEMORY
```
public static final ConfigOption<MemorySize> NETWORK_BATCH_SHUFFLE_READ_MEMORY
```
    Size of direct memory used by batch shuffle for shuffle data read (currently only used by sort-shuffle and hybrid shuffle).
  - JVM_METASPACE
```
public static final ConfigOption<MemorySize> JVM_METASPACE
```
    JVM Metaspace Size for the TaskExecutors.
  - JVM_OVERHEAD_MIN
```
public static final ConfigOption<MemorySize> JVM_OVERHEAD_MIN
```
    Min JVM Overhead size for the TaskExecutors.
  - JVM_OVERHEAD_MAX
```
public static final ConfigOption<MemorySize> JVM_OVERHEAD_MAX
```
    Max JVM Overhead size for the TaskExecutors.
  - JVM_OVERHEAD_FRACTION
```
public static final ConfigOption<Float> JVM_OVERHEAD_FRACTION
```
    Fraction of Total Process Memory to be reserved for JVM Overhead.
  - TASK_CANCELLATION_INTERVAL
```
public static final ConfigOption<Long> TASK_CANCELLATION_INTERVAL
```
    Time interval in milliseconds between two successive task cancellation attempts.
  - TASK_CANCELLATION_TIMEOUT
```
public static final ConfigOption<Long> TASK_CANCELLATION_TIMEOUT
```
    Timeout in milliseconds after which a task cancellation times out and leads to a fatal TaskManager error. A value of 0 deactivates the watch dog. Notice that a task cancellation is different from both a task failure and a clean shutdown. Task cancellation timeout only applies to task cancellation and does not apply to task closing/clean-up caused by a task failure or a clean shutdown.
  - TASK_CANCELLATION_TIMEOUT_TIMERS
```
public static final ConfigOption<Long> TASK_CANCELLATION_TIMEOUT_TIMERS
```
    This configures how long we wait for the timers in milliseconds to finish all pending timer threads when the stream task is cancelled.

Back to Flink Website

Class TaskManagerOptions

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MANAGED_MEMORY_CONSUMER_NAME_DATAPROC

MANAGED_MEMORY_CONSUMER_NAME_OPERATOR

MANAGED_MEMORY_CONSUMER_NAME_STATE_BACKEND

MANAGED_MEMORY_CONSUMER_NAME_PYTHON

TASK_MANAGER_HEAP_MEMORY

TASK_MANAGER_HEAP_MEMORY_MB

KILL_ON_OUT_OF_MEMORY

EXIT_ON_FATAL_AKKA_ERROR

HOST

BIND_HOST

RPC_PORT

RPC_BIND_PORT

INITIAL_REGISTRATION_BACKOFF

REGISTRATION_MAX_BACKOFF

REFUSED_REGISTRATION_BACKOFF

REGISTRATION_TIMEOUT

NUM_TASK_SLOTS

SLOT_TIMEOUT

DEBUG_MEMORY_LOG

DEBUG_MEMORY_USAGE_LOG_INTERVAL_MS

MEMORY_SEGMENT_SIZE

MIN_MEMORY_SEGMENT_SIZE

HOST_BIND_POLICY

TASK_MANAGER_RESOURCE_ID

CPU_CORES

TOTAL_PROCESS_MEMORY

TOTAL_FLINK_MEMORY

FRAMEWORK_HEAP_MEMORY

FRAMEWORK_OFF_HEAP_MEMORY

TASK_HEAP_MEMORY

TASK_OFF_HEAP_MEMORY

MANAGED_MEMORY_SIZE

MANAGED_MEMORY_FRACTION

MANAGED_MEMORY_CONSUMER_WEIGHTS

NETWORK_MEMORY_MIN

NETWORK_MEMORY_MAX

NETWORK_MEMORY_FRACTION

BUFFER_DEBLOAT_PERIOD

BUFFER_DEBLOAT_SAMPLES

BUFFER_DEBLOAT_TARGET

BUFFER_DEBLOAT_ENABLED

BUFFER_DEBLOAT_THRESHOLD_PERCENTAGES

NETWORK_BATCH_SHUFFLE_READ_MEMORY

JVM_METASPACE

JVM_OVERHEAD_MIN

JVM_OVERHEAD_MAX

JVM_OVERHEAD_FRACTION

TASK_CANCELLATION_INTERVAL

TASK_CANCELLATION_TIMEOUT

TASK_CANCELLATION_TIMEOUT_TIMERS

Back to Flink Website