org.apache.flink.configuration

Class GlobalConfiguration

java.lang.Object

org.apache.flink.configuration.GlobalConfiguration

@Internal
public final class GlobalConfiguration
extends Object

Global configuration object for Flink. Similar to Java properties configuration objects it includes key-value pairs which represent the framework's configuration.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	getBoolean(String key, boolean defaultValue) Returns the value associated with the given key as a boolean.
static Configuration	getConfiguration() Gets a Configuration object with the values of this GlobalConfiguration
static float	getFloat(String key, float defaultValue) Returns the value associated with the given key as a float.
static int	getInteger(String key, int defaultValue) Returns the value associated with the given key as an integer.
static long	getLong(String key, long defaultValue) Returns the value associated with the given key as a long integer.
static String	getString(String key, String defaultValue) Returns the value associated with the given key as a string.
static void	includeConfiguration(Configuration conf) Merges the given Configuration object into the global configuration.
static void	loadConfiguration(String configDir) Loads the configuration files from the specified directory.

Methods inherited from class java.lang.Object

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

Method Detail

getString

public static String getString(String key,
               String defaultValue)

Returns the value associated with the given key as a string.

Parameters:

key - the key pointing to the associated value

defaultValue - the default value which is returned in case there is no value associated with the given key

Returns:

the (default) value associated with the given key

getLong

public static long getLong(String key,
           long defaultValue)

Returns the value associated with the given key as a long integer.

Parameters:

key - the key pointing to the associated value

defaultValue - the default value which is returned in case there is no value associated with the given key

Returns:

the (default) value associated with the given key

getInteger

public static int getInteger(String key,
             int defaultValue)

Returns the value associated with the given key as an integer.

Parameters:

key - the key pointing to the associated value

defaultValue - the default value which is returned in case there is no value associated with the given key

Returns:

the (default) value associated with the given key

getFloat

public static float getFloat(String key,
             float defaultValue)

Returns the value associated with the given key as a float.

Parameters:

key - the key pointing to the associated value

defaultValue - the default value which is returned in case there is no value associated with the given key

Returns:

the (default) value associated with the given key

getBoolean

public static boolean getBoolean(String key,
                 boolean defaultValue)

Returns the value associated with the given key as a boolean.

Parameters:

key - the key pointing to the associated value

defaultValue - the default value which is returned in case there is no value associated with the given key

Returns:

the (default) value associated with the given key

loadConfiguration

public static void loadConfiguration(String configDir)

Loads the configuration files from the specified directory.

XML and YAML are supported as configuration files. If both XML and YAML files exist in the configuration directory, keys from YAML will overwrite keys from XML.

Parameters:

configDir - the directory which contains the configuration files

getConfiguration

public static Configuration getConfiguration()

Gets a Configuration object with the values of this GlobalConfiguration

Returns:

the Configuration object including the key/value pairs

includeConfiguration

public static void includeConfiguration(Configuration conf)

Merges the given Configuration object into the global configuration. If a key/value pair with an identical already exists in the global configuration, it is overwritten by the pair of the Configuration object.

Parameters:

conf - the Configuration object to merge into the global configuration