org.apache.flink.configuration

Class ConfigurationUtils

java.lang.Object

org.apache.flink.configuration.ConfigurationUtils

public class ConfigurationUtils
extends Object

Utility class for Configuration related helper functions.

Method Summary

Modifier and Type	Method and Description
static Configuration	createConfiguration(Properties properties) Creates a new Configuration from the given Properties.
static MemorySize	getJobManagerHeapMemory(Configuration configuration) Get job manager's heap memory.
static Time	getStandaloneClusterStartupPeriodTime(Configuration configuration)
static Optional<Time>	getSystemResourceMetricsProbingInterval(Configuration configuration)
static MemorySize	getTaskManagerHeapMemory(Configuration configuration) Get task manager's heap memory.
static String[]	parseLocalStateDirectories(Configuration configuration) Extracts the local state directories as defined by CheckpointingOptions.LOCAL_RECOVERY_TASK_MANAGER_STATE_ROOT_DIRS.
static String[]	parseTempDirectories(Configuration configuration) Extracts the task manager directories for temporary files as defined by CoreOptions.TMP_DIRS.

Methods inherited from class java.lang.Object

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

Method Detail

getJobManagerHeapMemory

public static MemorySize getJobManagerHeapMemory(Configuration configuration)

Get job manager's heap memory. This method will check the new key JobManagerOptions.JOB_MANAGER_HEAP_MEMORY and the old key JobManagerOptions.JOB_MANAGER_HEAP_MEMORY_MB for backwards compatibility.

Parameters:

configuration - the configuration object

Returns:

the memory size of job manager's heap memory.

getTaskManagerHeapMemory

public static MemorySize getTaskManagerHeapMemory(Configuration configuration)

Get task manager's heap memory. This method will check the new key TaskManagerOptions.TASK_MANAGER_HEAP_MEMORY and the old key TaskManagerOptions.TASK_MANAGER_HEAP_MEMORY_MB for backwards compatibility.

Parameters:

configuration - the configuration object

Returns:

the memory size of task manager's heap memory.

getSystemResourceMetricsProbingInterval

public static Optional<Time> getSystemResourceMetricsProbingInterval(Configuration configuration)

Returns:

extracted MetricOptions.SYSTEM_RESOURCE_METRICS_PROBING_INTERVAL or Optional.empty() if MetricOptions.SYSTEM_RESOURCE_METRICS are disabled.

parseTempDirectories

@Nonnull
public static String[] parseTempDirectories(Configuration configuration)

Extracts the task manager directories for temporary files as defined by CoreOptions.TMP_DIRS.

Parameters:

configuration - configuration object

Returns:

array of configured directories (in order)

parseLocalStateDirectories

@Nonnull
public static String[] parseLocalStateDirectories(Configuration configuration)

Extracts the local state directories as defined by CheckpointingOptions.LOCAL_RECOVERY_TASK_MANAGER_STATE_ROOT_DIRS.

Parameters:

configuration - configuration object

Returns:

array of configured directories (in order)

getStandaloneClusterStartupPeriodTime

public static Time getStandaloneClusterStartupPeriodTime(Configuration configuration)

createConfiguration

@Nonnull
public static Configuration createConfiguration(Properties properties)

Creates a new Configuration from the given Properties.

Parameters:

properties - to convert into a Configuration

Returns:

Configuration which has been populated by the values of the given Properties