JobManagerOptions (Flink : 1.18-SNAPSHOT API)

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

@PublicEvolving
public class JobManagerOptions
extends Object

Configuration options for the JobManager.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JobManagerOptions.HybridPartitionDataConsumeConstraint` Constraints of upstream hybrid partition data consumption by downstream.
`static class`	`JobManagerOptions.JobStoreType` Type of job store implementation.
`static class`	`JobManagerOptions.SchedulerType` Type of scheduler implementation.

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigOption<MemorySize>`	`ADAPTIVE_BATCH_SCHEDULER_AVG_DATA_VOLUME_PER_TASK` Deprecated. Use `BatchExecutionOptions.ADAPTIVE_AUTO_PARALLELISM_AVG_DATA_VOLUME_PER_TASK`.
`static ConfigOption<Integer>`	`ADAPTIVE_BATCH_SCHEDULER_DEFAULT_SOURCE_PARALLELISM` Deprecated. Use `BatchExecutionOptions.ADAPTIVE_AUTO_PARALLELISM_DEFAULT_SOURCE_PARALLELISM`.
`static ConfigOption<Integer>`	`ADAPTIVE_BATCH_SCHEDULER_MAX_PARALLELISM` Deprecated. Use `BatchExecutionOptions.ADAPTIVE_AUTO_PARALLELISM_MAX_PARALLELISM`.
`static ConfigOption<Integer>`	`ADAPTIVE_BATCH_SCHEDULER_MIN_PARALLELISM` Deprecated. Use `BatchExecutionOptions.ADAPTIVE_AUTO_PARALLELISM_MIN_PARALLELISM`.
`static ConfigOption<String>`	`ADDRESS` The config parameter defining the network address to connect to for communication with the job manager.
`static ConfigOption<String>`	`ARCHIVE_DIR` The location where the JobManager stores the archives of completed jobs.
`static ConfigOption<String>`	`BIND_HOST` The local address of the network interface that the job manager binds to.
`static ConfigOption<Duration>`	`BLOCK_SLOW_NODE_DURATION` Deprecated. Use `BatchExecutionOptions.BLOCK_SLOW_NODE_DURATION`.
`static ConfigOption<String>`	`EXECUTION_FAILOVER_STRATEGY` This option specifies the failover strategy, i.e. how the job computation recovers from task failures.
`static ConfigOption<String>`	`FAILURE_ENRICHERS_LIST` Flag indicating whether JobManager should load available Failure Enricher plugins at startup.
`static ConfigOption<JobManagerOptions.HybridPartitionDataConsumeConstraint>`	`HYBRID_PARTITION_DATA_CONSUME_CONSTRAINT`
`static ConfigOption<Integer>`	`JOB_MANAGER_FUTURE_POOL_SIZE`
`static ConfigOption<MemorySize>`	`JOB_MANAGER_HEAP_MEMORY` Deprecated. use `TOTAL_FLINK_MEMORY` for standalone setups and `TOTAL_PROCESS_MEMORY` for containerized setups.
`static ConfigOption<Integer>`	`JOB_MANAGER_HEAP_MEMORY_MB` Deprecated. use `TOTAL_FLINK_MEMORY` for standalone setups and `TOTAL_PROCESS_MEMORY` for containerized setups.
`static ConfigOption<Integer>`	`JOB_MANAGER_IO_POOL_SIZE`
`static ConfigOption<String>`	`JOB_MANAGER_RESOURCE_ID` The JobManager's ResourceID.
`static ConfigOption<Long>`	`JOB_STORE_CACHE_SIZE` The job store cache size in bytes which is used to keep completed jobs in memory.
`static ConfigOption<Long>`	`JOB_STORE_EXPIRATION_TIME` The time in seconds after which a completed job expires and is purged from the job store.
`static ConfigOption<Integer>`	`JOB_STORE_MAX_CAPACITY` The max number of completed jobs that can be kept in the job store.
`static ConfigOption<JobManagerOptions.JobStoreType>`	`JOB_STORE_TYPE` Config parameter determining the job store implementation in session cluster.
`static ConfigOption<Boolean>`	`JVM_DIRECT_MEMORY_LIMIT_ENABLED` Off-heap Memory size for the JobManager.
`static ConfigOption<MemorySize>`	`JVM_HEAP_MEMORY` JVM Heap Memory size for the JobManager.
`static ConfigOption<MemorySize>`	`JVM_METASPACE` JVM Metaspace Size for the JobManager.
`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 JobManager.
`static ConfigOption<Integer>`	`MAX_ATTEMPTS_HISTORY_SIZE` The maximum number of historical execution attempts kept in history.
`static MemorySize`	`MIN_JVM_HEAP_SIZE`
`static ConfigOption<Integer>`	`MIN_PARALLELISM_INCREASE`
`static ConfigOption<MemorySize>`	`OFF_HEAP_MEMORY` Off-heap Memory size for the JobManager.
`static ConfigOption<Boolean>`	`PARTITION_RELEASE_DURING_JOB_EXECUTION` Config parameter controlling whether partitions should already be released during the job execution.
`static ConfigOption<Integer>`	`PORT` The config parameter defining the network port to connect to for communication with the job manager.
`static ConfigOption<Duration>`	`RESOURCE_STABILIZATION_TIMEOUT`
`static ConfigOption<Duration>`	`RESOURCE_WAIT_TIMEOUT`
`static ConfigOption<Boolean>`	`RETRIEVE_TASK_MANAGER_HOSTNAME` Flag indicating whether JobManager would retrieve canonical host name of TaskManager during registration.
`static ConfigOption<Integer>`	`RPC_BIND_PORT` The local port that the job manager binds to.
`static ConfigOption<JobManagerOptions.SchedulerType>`	`SCHEDULER` Config parameter determining the scheduler implementation.
`static ConfigOption<SchedulerExecutionMode>`	`SCHEDULER_MODE`
`static ConfigOption<Long>`	`SLOT_IDLE_TIMEOUT` The timeout in milliseconds for a idle slot in Slot Pool.
`static ConfigOption<Long>`	`SLOT_REQUEST_TIMEOUT` The timeout in milliseconds for requesting a slot from Slot Pool.
`static ConfigOption<Boolean>`	`SPECULATIVE_ENABLED` Deprecated. Use `BatchExecutionOptions.SPECULATIVE_ENABLED`.
`static ConfigOption<Integer>`	`SPECULATIVE_MAX_CONCURRENT_EXECUTIONS` Deprecated. Use `BatchExecutionOptions.SPECULATIVE_MAX_CONCURRENT_EXECUTIONS`.
`static ConfigOption<MemorySize>`	`TOTAL_FLINK_MEMORY` Total Flink Memory size for the JobManager.
`static ConfigOption<MemorySize>`	`TOTAL_PROCESS_MEMORY` Total Process Memory size for the JobManager.

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

- Field Detail
  - MIN_JVM_HEAP_SIZE
```
public static final MemorySize MIN_JVM_HEAP_SIZE
```
  - ADDRESS
```
public static final ConfigOption<String> ADDRESS
```
    The config parameter defining the network address to connect to for communication with the job manager.
    This value is only interpreted in setups where a single JobManager with static name or address exists (simple standalone setups, or container setups with dynamic service name resolution). It is not used in many high-availability setups, when a leader-election service (like ZooKeeper) is used to elect and discover the JobManager leader from potentially multiple standby JobManagers.
  - BIND_HOST
```
public static final ConfigOption<String> BIND_HOST
```
    The local address of the network interface that the job manager binds to.
  - PORT
```
public static final ConfigOption<Integer> PORT
```
    The config parameter defining the network port to connect to for communication with the job manager.
    Like ADDRESS, this value is only interpreted in setups where a single JobManager with static name/address and port exists (simple standalone setups, or container setups with dynamic service name resolution). This config option is not used in many high-availability setups, when a leader-election service (like ZooKeeper) is used to elect and discover the JobManager leader from potentially multiple standby JobManagers.
  - RPC_BIND_PORT
```
public static final ConfigOption<Integer> RPC_BIND_PORT
```
    The local port that the job manager binds to.
  - JOB_MANAGER_HEAP_MEMORY
```
@Deprecated
public static final ConfigOption<MemorySize> JOB_MANAGER_HEAP_MEMORY
```
    Deprecated. use TOTAL_FLINK_MEMORY for standalone setups and TOTAL_PROCESS_MEMORY for containerized setups.
    
    JVM heap size for the JobManager with memory size.
  - JOB_MANAGER_HEAP_MEMORY_MB
```
@Deprecated
public static final ConfigOption<Integer> JOB_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 JobManager.
  - TOTAL_PROCESS_MEMORY
```
public static final ConfigOption<MemorySize> TOTAL_PROCESS_MEMORY
```
    Total Process Memory size for the JobManager.
  - TOTAL_FLINK_MEMORY
```
public static final ConfigOption<MemorySize> TOTAL_FLINK_MEMORY
```
    Total Flink Memory size for the JobManager.
  - JVM_HEAP_MEMORY
```
public static final ConfigOption<MemorySize> JVM_HEAP_MEMORY
```
    JVM Heap Memory size for the JobManager.
  - OFF_HEAP_MEMORY
```
public static final ConfigOption<MemorySize> OFF_HEAP_MEMORY
```
    Off-heap Memory size for the JobManager.
  - JVM_DIRECT_MEMORY_LIMIT_ENABLED
```
public static final ConfigOption<Boolean> JVM_DIRECT_MEMORY_LIMIT_ENABLED
```
    Off-heap Memory size for the JobManager.
  - JVM_METASPACE
```
public static final ConfigOption<MemorySize> JVM_METASPACE
```
    JVM Metaspace Size for the JobManager.
  - JVM_OVERHEAD_MIN
```
public static final ConfigOption<MemorySize> JVM_OVERHEAD_MIN
```
    Min JVM Overhead size for the JobManager.
  - 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.
  - MAX_ATTEMPTS_HISTORY_SIZE
```
public static final ConfigOption<Integer> MAX_ATTEMPTS_HISTORY_SIZE
```
    The maximum number of historical execution attempts kept in history.
  - FAILURE_ENRICHERS_LIST
```
public static final ConfigOption<String> FAILURE_ENRICHERS_LIST
```
    Flag indicating whether JobManager should load available Failure Enricher plugins at startup. An optional list of Failure Enricher names. If empty, NO enrichers will be started. If configured, only enrichers whose name (as returned by class.getName()) matches any of the names in the list will be started.
    Example:
```
 jobmanager.failure-enrichers = org.apache.flink.test.plugin.jar.failure.TypeFailureEnricher, org.apache.flink.runtime.failure.FailureEnricherUtilsTest$TestEnricher

 
```
  - EXECUTION_FAILOVER_STRATEGY
```
public static final ConfigOption<String> EXECUTION_FAILOVER_STRATEGY
```
    This option specifies the failover strategy, i.e. how the job computation recovers from task failures.
  - ARCHIVE_DIR
```
public static final ConfigOption<String> ARCHIVE_DIR
```
    The location where the JobManager stores the archives of completed jobs.
  - JOB_STORE_CACHE_SIZE
```
public static final ConfigOption<Long> JOB_STORE_CACHE_SIZE
```
    The job store cache size in bytes which is used to keep completed jobs in memory.
  - JOB_STORE_EXPIRATION_TIME
```
public static final ConfigOption<Long> JOB_STORE_EXPIRATION_TIME
```
    The time in seconds after which a completed job expires and is purged from the job store.
  - JOB_STORE_MAX_CAPACITY
```
public static final ConfigOption<Integer> JOB_STORE_MAX_CAPACITY
```
    The max number of completed jobs that can be kept in the job store.
  - JOB_STORE_TYPE
```
public static final ConfigOption<JobManagerOptions.JobStoreType> JOB_STORE_TYPE
```
    Config parameter determining the job store implementation in session cluster.
  - RETRIEVE_TASK_MANAGER_HOSTNAME
```
public static final ConfigOption<Boolean> RETRIEVE_TASK_MANAGER_HOSTNAME
```
    Flag indicating whether JobManager would retrieve canonical host name of TaskManager during registration.
  - JOB_MANAGER_FUTURE_POOL_SIZE
```
public static final ConfigOption<Integer> JOB_MANAGER_FUTURE_POOL_SIZE
```
  - JOB_MANAGER_IO_POOL_SIZE
```
public static final ConfigOption<Integer> JOB_MANAGER_IO_POOL_SIZE
```
  - SLOT_REQUEST_TIMEOUT
```
public static final ConfigOption<Long> SLOT_REQUEST_TIMEOUT
```
    The timeout in milliseconds for requesting a slot from Slot Pool.
  - SLOT_IDLE_TIMEOUT
```
public static final ConfigOption<Long> SLOT_IDLE_TIMEOUT
```
    The timeout in milliseconds for a idle slot in Slot Pool.
  - SCHEDULER
```
public static final ConfigOption<JobManagerOptions.SchedulerType> SCHEDULER
```
    Config parameter determining the scheduler implementation.
  - SCHEDULER_MODE
```
public static final ConfigOption<SchedulerExecutionMode> SCHEDULER_MODE
```
  - MIN_PARALLELISM_INCREASE
```
public static final ConfigOption<Integer> MIN_PARALLELISM_INCREASE
```
  - RESOURCE_WAIT_TIMEOUT
```
public static final ConfigOption<Duration> RESOURCE_WAIT_TIMEOUT
```
  - RESOURCE_STABILIZATION_TIMEOUT
```
public static final ConfigOption<Duration> RESOURCE_STABILIZATION_TIMEOUT
```
  - PARTITION_RELEASE_DURING_JOB_EXECUTION
```
public static final ConfigOption<Boolean> PARTITION_RELEASE_DURING_JOB_EXECUTION
```
    Config parameter controlling whether partitions should already be released during the job execution.
  - ADAPTIVE_BATCH_SCHEDULER_MIN_PARALLELISM
```
@Deprecated
public static final ConfigOption<Integer> ADAPTIVE_BATCH_SCHEDULER_MIN_PARALLELISM
```
    Deprecated. Use BatchExecutionOptions.ADAPTIVE_AUTO_PARALLELISM_MIN_PARALLELISM.
  - ADAPTIVE_BATCH_SCHEDULER_MAX_PARALLELISM
```
@Deprecated
public static final ConfigOption<Integer> ADAPTIVE_BATCH_SCHEDULER_MAX_PARALLELISM
```
    Deprecated. Use BatchExecutionOptions.ADAPTIVE_AUTO_PARALLELISM_MAX_PARALLELISM.
  - ADAPTIVE_BATCH_SCHEDULER_AVG_DATA_VOLUME_PER_TASK
```
@Deprecated
public static final ConfigOption<MemorySize> ADAPTIVE_BATCH_SCHEDULER_AVG_DATA_VOLUME_PER_TASK
```
    Deprecated. Use BatchExecutionOptions.ADAPTIVE_AUTO_PARALLELISM_AVG_DATA_VOLUME_PER_TASK.
  - ADAPTIVE_BATCH_SCHEDULER_DEFAULT_SOURCE_PARALLELISM
```
@Deprecated
public static final ConfigOption<Integer> ADAPTIVE_BATCH_SCHEDULER_DEFAULT_SOURCE_PARALLELISM
```
    Deprecated. Use BatchExecutionOptions.ADAPTIVE_AUTO_PARALLELISM_DEFAULT_SOURCE_PARALLELISM.
  - SPECULATIVE_ENABLED
```
@Deprecated
public static final ConfigOption<Boolean> SPECULATIVE_ENABLED
```
    Deprecated. Use BatchExecutionOptions.SPECULATIVE_ENABLED.
  - SPECULATIVE_MAX_CONCURRENT_EXECUTIONS
```
@Deprecated
public static final ConfigOption<Integer> SPECULATIVE_MAX_CONCURRENT_EXECUTIONS
```
    Deprecated. Use BatchExecutionOptions.SPECULATIVE_MAX_CONCURRENT_EXECUTIONS.
  - BLOCK_SLOW_NODE_DURATION
```
@Deprecated
public static final ConfigOption<Duration> BLOCK_SLOW_NODE_DURATION
```
    Deprecated. Use BatchExecutionOptions.BLOCK_SLOW_NODE_DURATION.
  - JOB_MANAGER_RESOURCE_ID
```
public static final ConfigOption<String> JOB_MANAGER_RESOURCE_ID
```
    The JobManager's ResourceID. If not configured, the ResourceID will be generated randomly.
  - HYBRID_PARTITION_DATA_CONSUME_CONSTRAINT
```
public static final ConfigOption<JobManagerOptions.HybridPartitionDataConsumeConstraint> HYBRID_PARTITION_DATA_CONSUME_CONSTRAINT
```

Back to Flink Website

Class JobManagerOptions

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_JVM_HEAP_SIZE

ADDRESS

BIND_HOST

PORT

RPC_BIND_PORT

JOB_MANAGER_HEAP_MEMORY

JOB_MANAGER_HEAP_MEMORY_MB

TOTAL_PROCESS_MEMORY

TOTAL_FLINK_MEMORY

JVM_HEAP_MEMORY

OFF_HEAP_MEMORY

JVM_DIRECT_MEMORY_LIMIT_ENABLED

JVM_METASPACE

JVM_OVERHEAD_MIN

JVM_OVERHEAD_MAX

JVM_OVERHEAD_FRACTION

MAX_ATTEMPTS_HISTORY_SIZE

FAILURE_ENRICHERS_LIST

EXECUTION_FAILOVER_STRATEGY

ARCHIVE_DIR

JOB_STORE_CACHE_SIZE

JOB_STORE_EXPIRATION_TIME

JOB_STORE_MAX_CAPACITY

JOB_STORE_TYPE

RETRIEVE_TASK_MANAGER_HOSTNAME

JOB_MANAGER_FUTURE_POOL_SIZE

JOB_MANAGER_IO_POOL_SIZE

SLOT_REQUEST_TIMEOUT

SLOT_IDLE_TIMEOUT

SCHEDULER

SCHEDULER_MODE

MIN_PARALLELISM_INCREASE

RESOURCE_WAIT_TIMEOUT

RESOURCE_STABILIZATION_TIMEOUT

PARTITION_RELEASE_DURING_JOB_EXECUTION

ADAPTIVE_BATCH_SCHEDULER_MIN_PARALLELISM

ADAPTIVE_BATCH_SCHEDULER_MAX_PARALLELISM

ADAPTIVE_BATCH_SCHEDULER_AVG_DATA_VOLUME_PER_TASK

ADAPTIVE_BATCH_SCHEDULER_DEFAULT_SOURCE_PARALLELISM

SPECULATIVE_ENABLED

SPECULATIVE_MAX_CONCURRENT_EXECUTIONS

BLOCK_SLOW_NODE_DURATION

JOB_MANAGER_RESOURCE_ID

HYBRID_PARTITION_DATA_CONSUME_CONSTRAINT

Back to Flink Website