TaskManagerOptions (flink 1.5-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<Integer>`	`DATA_PORT` The default network port the task manager expects to receive transfer envelopes on.
`static ConfigOption<Boolean>`	`DATA_SSL_ENABLED` Config parameter to override SSL support for taskmanager's data transport.
`static ConfigOption<Boolean>`	`DEBUG_MEMORY_LOG`
`static ConfigOption<Long>`	`DEBUG_MEMORY_USAGE_LOG_INTERVAL_MS`
`static ConfigOption<Boolean>`	`EXIT_ON_FATAL_AKKA_ERROR` Whether the quarantine monitor for task managers shall be started.
`static ConfigOption<String>`	`HOST` The config parameter defining the task manager's hostname.
`static ConfigOption<String>`	`INITIAL_REGISTRATION_BACKOFF` The initial registration backoff between two consecutive registration attempts.
`static ConfigOption<Boolean>`	`KILL_ON_OUT_OF_MEMORY` Whether to kill the TaskManager when the task thread throws an OutOfMemoryError.
`static ConfigOption<Float>`	`MANAGED_MEMORY_FRACTION` Fraction of free memory allocated by the memory manager if `MANAGED_MEMORY_SIZE` is not set.
`static ConfigOption<Boolean>`	`MANAGED_MEMORY_PRE_ALLOCATE` Whether TaskManager managed memory should be pre-allocated when the TaskManager is starting.
`static ConfigOption<Long>`	`MANAGED_MEMORY_SIZE` Amount of memory to be allocated by the task manager's memory manager (in megabytes).
`static ConfigOption<Boolean>`	`MEMORY_OFF_HEAP` Memory allocation method (JVM heap or off-heap), used for managed memory of the TaskManager as well as the network buffers.
`static ConfigOption<Integer>`	`MEMORY_SEGMENT_SIZE` Size of memory buffers used by the network stack and the memory manager (in bytes).
`static ConfigOption<Float>`	`NETWORK_BUFFERS_MEMORY_FRACTION` Fraction of JVM memory to use for network buffers.
`static ConfigOption<Long>`	`NETWORK_BUFFERS_MEMORY_MAX` Maximum memory size for network buffers (in bytes).
`static ConfigOption<Long>`	`NETWORK_BUFFERS_MEMORY_MIN` Minimum memory size for network buffers (in bytes).
`static ConfigOption<Integer>`	`NETWORK_BUFFERS_PER_CHANNEL` Number of network buffers to use for each outgoing/incoming channel (subpartition/input channel).
`static ConfigOption<Boolean>`	`NETWORK_CREDIT_MODEL` Deprecated. Will be removed for Flink 1.6 when the old code will be dropped in favour of credit-based flow control.
`static ConfigOption<Boolean>`	`NETWORK_DETAILED_METRICS` Boolean flag to enable/disable more detailed metrics about inbound/outbound network queue lengths.
`static ConfigOption<Integer>`	`NETWORK_EXTRA_BUFFERS_PER_GATE` Number of extra network buffers to use for each outgoing/incoming gate (result partition/input gate).
`static ConfigOption<Integer>`	`NETWORK_NUM_BUFFERS` Deprecated. use `NETWORK_BUFFERS_MEMORY_FRACTION`, `NETWORK_BUFFERS_MEMORY_MIN`, and `NETWORK_BUFFERS_MEMORY_MAX` instead
`static ConfigOption<Integer>`	`NETWORK_REQUEST_BACKOFF_INITIAL` Minimum backoff for partition requests of input channels.
`static ConfigOption<Integer>`	`NETWORK_REQUEST_BACKOFF_MAX` Maximum backoff for partition requests of input channels.
`static ConfigOption<Integer>`	`NUM_TASK_SLOTS` The config parameter defining the number of task slots of a task manager.
`static ConfigOption<String>`	`REFUSED_REGISTRATION_BACKOFF` The backoff after a registration has been refused by the job manager before retrying to connect.
`static ConfigOption<String>`	`REGISTRATION_MAX_BACKOFF` The maximum registration backoff between two consecutive registration attempts.
`static ConfigOption<String>`	`REGISTRATION_TIMEOUT` Defines the timeout it can take for the TaskManager registration.
`static ConfigOption<String>`	`RPC_PORT` The default network port range the task manager expects incoming IPC connections.
`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 to finish all pending timer threads when the stream task is cancelled .
`static ConfigOption<Long>`	`TASK_CHECKPOINT_ALIGNMENT_BYTES_LIMIT` The maximum number of bytes that a checkpoint alignment may buffer.
`static ConfigOption<Integer>`	`TASK_MANAGER_HEAP_MEMORY` JVM heap size (in megabytes) for the TaskManagers.

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

- Field Detail
  - TASK_MANAGER_HEAP_MEMORY
```
public static final ConfigOption<Integer> TASK_MANAGER_HEAP_MEMORY
```
    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
```
public static final ConfigOption<Boolean> EXIT_ON_FATAL_AKKA_ERROR
```
    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 config parameter defining the task manager's hostname.
  - 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.
  - DATA_PORT
```
public static final ConfigOption<Integer> DATA_PORT
```
    The default network port the task manager expects to receive transfer envelopes on. The 0 means that the TaskManager searches for a free port.
  - DATA_SSL_ENABLED
```
public static final ConfigOption<Boolean> DATA_SSL_ENABLED
```
    Config parameter to override SSL support for taskmanager's data transport.
  - INITIAL_REGISTRATION_BACKOFF
```
public static final ConfigOption<String> INITIAL_REGISTRATION_BACKOFF
```
    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
```
public static final ConfigOption<String> REGISTRATION_MAX_BACKOFF
```
    The maximum registration backoff between two consecutive registration attempts.
  - REFUSED_REGISTRATION_BACKOFF
```
public static final ConfigOption<String> REFUSED_REGISTRATION_BACKOFF
```
    The backoff after a registration has been refused by the job manager before retrying to connect.
  - REGISTRATION_TIMEOUT
```
public static final ConfigOption<String> 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.
  - 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<Integer> MEMORY_SEGMENT_SIZE
```
    Size of memory buffers used by the network stack and the memory manager (in bytes).
  - MANAGED_MEMORY_SIZE
```
public static final ConfigOption<Long> MANAGED_MEMORY_SIZE
```
    Amount of memory to be allocated by the task manager's memory manager (in megabytes). If not set, a relative fraction will be allocated, as defined by MANAGED_MEMORY_FRACTION.
  - MANAGED_MEMORY_FRACTION
```
public static final ConfigOption<Float> MANAGED_MEMORY_FRACTION
```
    Fraction of free memory allocated by the memory manager if MANAGED_MEMORY_SIZE is not set.
  - MEMORY_OFF_HEAP
```
public static final ConfigOption<Boolean> MEMORY_OFF_HEAP
```
    Memory allocation method (JVM heap or off-heap), used for managed memory of the TaskManager as well as the network buffers.
  - MANAGED_MEMORY_PRE_ALLOCATE
```
public static final ConfigOption<Boolean> MANAGED_MEMORY_PRE_ALLOCATE
```
    Whether TaskManager managed memory should be pre-allocated when the TaskManager is starting.
  - NETWORK_NUM_BUFFERS
```
@Deprecated
public static final ConfigOption<Integer> NETWORK_NUM_BUFFERS
```
    Deprecated. use NETWORK_BUFFERS_MEMORY_FRACTION, NETWORK_BUFFERS_MEMORY_MIN, and NETWORK_BUFFERS_MEMORY_MAX instead
    
    Number of buffers used in the network stack. This defines the number of possible tasks and shuffles.
  - NETWORK_BUFFERS_MEMORY_FRACTION
```
public static final ConfigOption<Float> NETWORK_BUFFERS_MEMORY_FRACTION
```
    Fraction of JVM memory to use for network buffers.
  - NETWORK_BUFFERS_MEMORY_MIN
```
public static final ConfigOption<Long> NETWORK_BUFFERS_MEMORY_MIN
```
    Minimum memory size for network buffers (in bytes).
  - NETWORK_BUFFERS_MEMORY_MAX
```
public static final ConfigOption<Long> NETWORK_BUFFERS_MEMORY_MAX
```
    Maximum memory size for network buffers (in bytes).
  - NETWORK_BUFFERS_PER_CHANNEL
```
public static final ConfigOption<Integer> NETWORK_BUFFERS_PER_CHANNEL
```
    Number of network buffers to use for each outgoing/incoming channel (subpartition/input channel).
    Reasoning: 1 buffer for in-flight data in the subpartition + 1 buffer for parallel serialization.
  - NETWORK_EXTRA_BUFFERS_PER_GATE
```
public static final ConfigOption<Integer> NETWORK_EXTRA_BUFFERS_PER_GATE
```
    Number of extra network buffers to use for each outgoing/incoming gate (result partition/input gate).
  - NETWORK_REQUEST_BACKOFF_INITIAL
```
public static final ConfigOption<Integer> NETWORK_REQUEST_BACKOFF_INITIAL
```
    Minimum backoff for partition requests of input channels.
  - NETWORK_REQUEST_BACKOFF_MAX
```
public static final ConfigOption<Integer> NETWORK_REQUEST_BACKOFF_MAX
```
    Maximum backoff for partition requests of input channels.
  - NETWORK_DETAILED_METRICS
```
public static final ConfigOption<Boolean> NETWORK_DETAILED_METRICS
```
    Boolean flag to enable/disable more detailed metrics about inbound/outbound network queue lengths.
  - NETWORK_CREDIT_MODEL
```
@Deprecated
public static final ConfigOption<Boolean> NETWORK_CREDIT_MODEL
```
    Deprecated. Will be removed for Flink 1.6 when the old code will be dropped in favour of credit-based flow control.
    
    Boolean flag to enable/disable network credit-based flow control.
  - 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.
  - TASK_CANCELLATION_TIMEOUT_TIMERS
```
public static final ConfigOption<Long> TASK_CANCELLATION_TIMEOUT_TIMERS
```
    This configures how long we wait for the timers to finish all pending timer threads when the stream task is cancelled .
  - TASK_CHECKPOINT_ALIGNMENT_BYTES_LIMIT
```
public static final ConfigOption<Long> TASK_CHECKPOINT_ALIGNMENT_BYTES_LIMIT
```
    The maximum number of bytes that a checkpoint alignment may buffer. If the checkpoint alignment buffers more than the configured amount of data, the checkpoint is aborted (skipped).
    The default value of -1 indicates that there is no limit.

Back to Flink Website

Class TaskManagerOptions

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TASK_MANAGER_HEAP_MEMORY

KILL_ON_OUT_OF_MEMORY

EXIT_ON_FATAL_AKKA_ERROR

HOST

RPC_PORT

DATA_PORT

DATA_SSL_ENABLED

INITIAL_REGISTRATION_BACKOFF

REGISTRATION_MAX_BACKOFF

REFUSED_REGISTRATION_BACKOFF

REGISTRATION_TIMEOUT

NUM_TASK_SLOTS

DEBUG_MEMORY_LOG

DEBUG_MEMORY_USAGE_LOG_INTERVAL_MS

MEMORY_SEGMENT_SIZE

MANAGED_MEMORY_SIZE

MANAGED_MEMORY_FRACTION

MEMORY_OFF_HEAP

MANAGED_MEMORY_PRE_ALLOCATE

NETWORK_NUM_BUFFERS

NETWORK_BUFFERS_MEMORY_FRACTION

NETWORK_BUFFERS_MEMORY_MIN

NETWORK_BUFFERS_MEMORY_MAX

NETWORK_BUFFERS_PER_CHANNEL

NETWORK_EXTRA_BUFFERS_PER_GATE

NETWORK_REQUEST_BACKOFF_INITIAL

NETWORK_REQUEST_BACKOFF_MAX

NETWORK_DETAILED_METRICS

NETWORK_CREDIT_MODEL

TASK_CANCELLATION_INTERVAL

TASK_CANCELLATION_TIMEOUT

TASK_CANCELLATION_TIMEOUT_TIMERS

TASK_CHECKPOINT_ALIGNMENT_BYTES_LIMIT

Back to Flink Website