org.apache.flink.configuration

Class Configuration

java.lang.Object

org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters

org.apache.flink.configuration.Configuration

All Implemented Interfaces:

Serializable, Cloneable, ReadableConfig, WritableConfig, IOReadableWritable

Direct Known Subclasses:

DelegatingConfiguration, UnmodifiableConfiguration

@Public
public class Configuration
extends ExecutionConfig.GlobalJobParameters
implements IOReadableWritable, Serializable, Cloneable, ReadableConfig, WritableConfig

Lightweight configuration object which stores key/value pairs.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,Object>	confData Stores the concrete key/value pairs of this configuration object.
protected boolean	standardYaml

Constructor Summary

Constructors

Constructor and Description
Configuration() Creates a new empty configuration.
Configuration(boolean standardYaml)
Configuration(Configuration other) Creates a new configuration with the copy of the given configuration.

Method Summary

Modifier and Type	Method and Description
void	addAll(Configuration other)
void	addAll(Configuration other, String prefix) Adds all entries from the given configuration into this configuration.
void	addAllToProperties(Properties props) Adds all entries in this Configuration to the given Properties.
Configuration	clone()
boolean	contains(ConfigOption<?> configOption) Checks whether there is an entry for the given config option.
boolean	containsKey(String key) Checks whether there is an entry with the specified key.
boolean	equals(Object obj)
static Configuration	fromMap(Map<String,String> map) Creates a new configuration that is initialized with the options of the given map.
<T> T	get(ConfigOption<T> option) Please check the java doc of getRawValueFromOption(ConfigOption).
<T> T	get(ConfigOption<T> configOption, T overrideDefault) Returns the value associated with the given config option as a T.
boolean	getBoolean(ConfigOption<Boolean> configOption) Deprecated. use get(ConfigOption) or getOptional(ConfigOption)
boolean	getBoolean(ConfigOption<Boolean> configOption, boolean overrideDefault) Deprecated. use get(ConfigOption, Object)
boolean	getBoolean(String key, boolean defaultValue) Deprecated. use get(ConfigOption), get(ConfigOption, Object) or getOptional(ConfigOption)
byte[]	getBytes(String key, byte[] defaultValue) Returns the value associated with the given key as a byte array.
<T> Class<T>	getClass(String key, Class<? extends T> defaultValue, ClassLoader classLoader) Deprecated.
double	getDouble(ConfigOption<Double> configOption) Deprecated. use get(ConfigOption) or getOptional(ConfigOption)
double	getDouble(ConfigOption<Double> configOption, double overrideDefault) Deprecated. use get(ConfigOption, Object)
double	getDouble(String key, double defaultValue) Deprecated. use get(ConfigOption), get(ConfigOption, Object) or getOptional(ConfigOption)
<T extends Enum<T>> T	getEnum(Class<T> enumClass, ConfigOption<String> configOption) Returns the value associated with the given config option as an enum.
float	getFloat(ConfigOption<Float> configOption) Deprecated. use get(ConfigOption) or getOptional(ConfigOption)
float	getFloat(ConfigOption<Float> configOption, float overrideDefault) Deprecated. use get(ConfigOption, Object)
float	getFloat(String key, float defaultValue) Deprecated. use get(ConfigOption), get(ConfigOption, Object) or getOptional(ConfigOption)
int	getInteger(ConfigOption<Integer> configOption) Deprecated. use get(ConfigOption) or getOptional(ConfigOption)
int	getInteger(ConfigOption<Integer> configOption, int overrideDefault) Deprecated. use get(ConfigOption, Object)
int	getInteger(String key, int defaultValue) Deprecated. use get(ConfigOption), get(ConfigOption, Object) or getOptional(ConfigOption)
long	getLong(ConfigOption<Long> configOption) Deprecated. use get(ConfigOption) or getOptional(ConfigOption)
long	getLong(ConfigOption<Long> configOption, long overrideDefault) Deprecated. use get(ConfigOption, Object)
long	getLong(String key, long defaultValue) Deprecated. use get(ConfigOption), get(ConfigOption, Object) or getOptional(ConfigOption)
<T> Optional<T>	getOptional(ConfigOption<T> option) Reads a value using the metadata included in ConfigOption.
String	getString(ConfigOption<String> configOption) Deprecated. use get(ConfigOption) or getOptional(ConfigOption)
String	getString(ConfigOption<String> configOption, String overrideDefault) Deprecated. use get(ConfigOption, Object)
String	getString(String key, String defaultValue) Returns the value associated with the given key as a string.
String	getValue(ConfigOption<?> configOption) Returns the value associated with the given config option as a string.
int	hashCode()
Set<String>	keySet() Returns the keys of all key/value pairs stored inside this configuration object.
void	read(DataInputView in) Reads the object's internal data from the given data input view.
<T> boolean	removeConfig(ConfigOption<T> configOption) Removes given config option from the configuration.
boolean	removeKey(String key) Removes given key from the configuration.
<T> Configuration	set(ConfigOption<T> option, T value) Stores a given value using the metadata included in the ConfigOption.
void	setBoolean(ConfigOption<Boolean> key, boolean value) Deprecated. use set(ConfigOption, Object)
void	setBoolean(String key, boolean value) Deprecated. use set(ConfigOption, Object)
void	setBytes(String key, byte[] bytes) Adds the given byte array to the configuration object.
void	setClass(String key, Class<?> klazz) Deprecated.
void	setDouble(ConfigOption<Double> key, double value) Deprecated. use set(ConfigOption, Object)
void	setDouble(String key, double value) Deprecated. use set(ConfigOption, Object)
void	setFloat(ConfigOption<Float> key, float value) Deprecated. use set(ConfigOption, Object)
void	setFloat(String key, float value) Deprecated. use set(ConfigOption, Object)
void	setInteger(ConfigOption<Integer> key, int value) Deprecated. use set(ConfigOption, Object)
void	setInteger(String key, int value) Deprecated. use set(ConfigOption, Object)
void	setLong(ConfigOption<Long> key, long value) Deprecated. use set(ConfigOption, Object)
void	setLong(String key, long value) Deprecated. use set(ConfigOption, Object)
void	setString(ConfigOption<String> key, String value) Deprecated. use set(ConfigOption, Object)
void	setString(String key, String value) Adds the given key/value pair to the configuration object.
Map<String,String>	toFileWritableMap() Convert Config into a Map<String, String> representation.
Map<String,String>	toMap() Convert UserConfig into a Map<String, String> representation.
String	toString()
void	write(DataOutputView out) Writes the object's internal data to the given data output view.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

confData

protected final HashMap<String,Object> confData

Stores the concrete key/value pairs of this configuration object.

NOTE: This map stores the values that are actually used, and does not include any escaping that is required by the standard YAML syntax.

standardYaml

protected final boolean standardYaml

Constructor Detail

Configuration

public Configuration()

Creates a new empty configuration.

Configuration

@VisibleForTesting
 @Internal
public Configuration(boolean standardYaml)

Configuration

public Configuration(Configuration other)

Creates a new configuration with the copy of the given configuration.

Parameters:

other - The configuration to copy the entries from.

Method Detail

fromMap

public static Configuration fromMap(Map<String,String> map)

Creates a new configuration that is initialized with the options of the given map.

getClass

@Deprecated
public <T> Class<T> getClass(String key,
                                         Class<? extends T> defaultValue,
                                         ClassLoader classLoader)
                                  throws ClassNotFoundException

Deprecated.

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

Type Parameters:

T - The type of the class to return.

Parameters:

key - The key pointing to the associated value

defaultValue - The optional default value returned if no entry exists

classLoader - The class loader used to resolve the class.

Returns:

The value associated with the given key, or the default value, if to entry for the key exists.

Throws:

ClassNotFoundException

setClass

@Deprecated
public void setClass(String key,
                                 Class<?> klazz)

Deprecated.

Adds the given key/value pair to the configuration object. The class can be retrieved by invoking getClass(String, Class, ClassLoader) if it is in the scope of the class loader on the caller.

Parameters:

key - The key of the pair to be added

klazz - The value of the pair to be added

See Also:

getClass(String, Class, ClassLoader)

getString

public String getString(String key,
                        String defaultValue)

Returns the value associated with the given key as a string. We encourage users and developers to always use ConfigOption for getting the configurations if possible, for its rich description, type, default-value and other supports. The string-key-based getter should only be used when ConfigOption is not applicable, e.g., the key is programmatically generated in runtime.

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

getString

@Deprecated
 @PublicEvolving
public String getString(ConfigOption<String> configOption)

Deprecated. use get(ConfigOption) or getOptional(ConfigOption)

Returns the value associated with the given config option as a string.

Parameters:

configOption - The configuration option

Returns:

the (default) value associated with the given config option

getString

@Deprecated
 @PublicEvolving
public String getString(ConfigOption<String> configOption,
                                                     String overrideDefault)

Deprecated. use get(ConfigOption, Object)

Returns the value associated with the given config option as a string. If no value is mapped under any key of the option, it returns the specified default instead of the option's default value.

Parameters:

configOption - The configuration option

Returns:

the (default) value associated with the given config option

setString

public void setString(String key,
                      String value)

Adds the given key/value pair to the configuration object. We encourage users and developers to always use ConfigOption for setting the configurations if possible, for its rich description, type, default-value and other supports. The string-key-based setter should only be used when ConfigOption is not applicable, e.g., the key is programmatically generated in runtime.

Parameters:

key - the key of the key/value pair to be added

value - the value of the key/value pair to be added

setString

@Deprecated
 @PublicEvolving
public void setString(ConfigOption<String> key,
                                                   String value)

Deprecated. use set(ConfigOption, Object)

Adds the given value to the configuration object. The main key of the config option will be used to map the value.

Parameters:

key - the option specifying the key to be added

value - the value of the key/value pair to be added

getInteger

@Deprecated
public int getInteger(String key,
                                  int defaultValue)

Deprecated. use get(ConfigOption), get(ConfigOption, Object) or getOptional(ConfigOption)

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

getInteger

@Deprecated
 @PublicEvolving
public int getInteger(ConfigOption<Integer> configOption)

Deprecated. use get(ConfigOption) or getOptional(ConfigOption)

Returns the value associated with the given config option as an integer.

Parameters:

configOption - The configuration option

Returns:

the (default) value associated with the given config option

getInteger

@Deprecated
 @PublicEvolving
public int getInteger(ConfigOption<Integer> configOption,
                                                   int overrideDefault)

Deprecated. use get(ConfigOption, Object)

Returns the value associated with the given config option as an integer. If no value is mapped under any key of the option, it returns the specified default instead of the option's default value.

Parameters:

configOption - The configuration option

overrideDefault - The value to return if no value was mapper for any key of the option

Returns:

the configured value associated with the given config option, or the overrideDefault

setInteger

@Deprecated
public void setInteger(String key,
                                   int value)

Deprecated. use set(ConfigOption, Object)

Adds the given key/value pair to the configuration object.

Parameters:

key - the key of the key/value pair to be added

value - the value of the key/value pair to be added

setInteger

@Deprecated
 @PublicEvolving
public void setInteger(ConfigOption<Integer> key,
                                                    int value)

Deprecated. use set(ConfigOption, Object)

Adds the given value to the configuration object. The main key of the config option will be used to map the value.

Parameters:

key - the option specifying the key to be added

value - the value of the key/value pair to be added

getLong

@Deprecated
public long getLong(String key,
                                long defaultValue)

Deprecated. use get(ConfigOption), get(ConfigOption, Object) or getOptional(ConfigOption)

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

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

@Deprecated
 @PublicEvolving
public long getLong(ConfigOption<Long> configOption)

Deprecated. use get(ConfigOption) or getOptional(ConfigOption)

Returns the value associated with the given config option as a long integer.

Parameters:

configOption - The configuration option

Returns:

the (default) value associated with the given config option

getLong

@Deprecated
 @PublicEvolving
public long getLong(ConfigOption<Long> configOption,
                                                 long overrideDefault)

Deprecated. use get(ConfigOption, Object)

Returns the value associated with the given config option as a long integer. If no value is mapped under any key of the option, it returns the specified default instead of the option's default value.

Parameters:

configOption - The configuration option

overrideDefault - The value to return if no value was mapper for any key of the option

Returns:

the configured value associated with the given config option, or the overrideDefault

setLong

@Deprecated
public void setLong(String key,
                                long value)

Deprecated. use set(ConfigOption, Object)

Adds the given key/value pair to the configuration object.

Parameters:

key - the key of the key/value pair to be added

value - the value of the key/value pair to be added

setLong

@Deprecated
 @PublicEvolving
public void setLong(ConfigOption<Long> key,
                                                 long value)

Deprecated. use set(ConfigOption, Object)

Adds the given value to the configuration object. The main key of the config option will be used to map the value.

Parameters:

key - the option specifying the key to be added

value - the value of the key/value pair to be added

getBoolean

@Deprecated
public boolean getBoolean(String key,
                                      boolean defaultValue)

Deprecated. use get(ConfigOption), get(ConfigOption, Object) or getOptional(ConfigOption)

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

getBoolean

@Deprecated
 @PublicEvolving
public boolean getBoolean(ConfigOption<Boolean> configOption)

Deprecated. use get(ConfigOption) or getOptional(ConfigOption)

Returns the value associated with the given config option as a boolean.

Parameters:

configOption - The configuration option

Returns:

the (default) value associated with the given config option

getBoolean

@Deprecated
 @PublicEvolving
public boolean getBoolean(ConfigOption<Boolean> configOption,
                                                       boolean overrideDefault)

Deprecated. use get(ConfigOption, Object)

Returns the value associated with the given config option as a boolean. If no value is mapped under any key of the option, it returns the specified default instead of the option's default value.

Parameters:

configOption - The configuration option

overrideDefault - The value to return if no value was mapper for any key of the option

Returns:

the configured value associated with the given config option, or the overrideDefault

setBoolean

@Deprecated
public void setBoolean(String key,
                                   boolean value)

Deprecated. use set(ConfigOption, Object)

Adds the given key/value pair to the configuration object.

Parameters:

key - the key of the key/value pair to be added

value - the value of the key/value pair to be added

setBoolean

@Deprecated
 @PublicEvolving
public void setBoolean(ConfigOption<Boolean> key,
                                                    boolean value)

Deprecated. use set(ConfigOption, Object)

Adds the given value to the configuration object. The main key of the config option will be used to map the value.

Parameters:

key - the option specifying the key to be added

value - the value of the key/value pair to be added

getFloat

@Deprecated
public float getFloat(String key,
                                  float defaultValue)

Deprecated. use get(ConfigOption), get(ConfigOption, Object) or getOptional(ConfigOption)

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

getFloat

@Deprecated
 @PublicEvolving
public float getFloat(ConfigOption<Float> configOption)

Deprecated. use get(ConfigOption) or getOptional(ConfigOption)

Returns the value associated with the given config option as a float.

Parameters:

configOption - The configuration option

Returns:

the (default) value associated with the given config option

getFloat

@Deprecated
 @PublicEvolving
public float getFloat(ConfigOption<Float> configOption,
                                                   float overrideDefault)

Deprecated. use get(ConfigOption, Object)

Returns the value associated with the given config option as a float. If no value is mapped under any key of the option, it returns the specified default instead of the option's default value.

Parameters:

configOption - The configuration option

overrideDefault - The value to return if no value was mapper for any key of the option

Returns:

the configured value associated with the given config option, or the overrideDefault

setFloat

@Deprecated
public void setFloat(String key,
                                 float value)

Deprecated. use set(ConfigOption, Object)

Adds the given key/value pair to the configuration object.

Parameters:

key - the key of the key/value pair to be added

value - the value of the key/value pair to be added

setFloat

@Deprecated
 @PublicEvolving
public void setFloat(ConfigOption<Float> key,
                                                  float value)

Deprecated. use set(ConfigOption, Object)

Adds the given value to the configuration object. The main key of the config option will be used to map the value.

Parameters:

key - the option specifying the key to be added

value - the value of the key/value pair to be added

getDouble

@Deprecated
public double getDouble(String key,
                                    double defaultValue)

Deprecated. use get(ConfigOption), get(ConfigOption, Object) or getOptional(ConfigOption)

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

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

getDouble

@Deprecated
 @PublicEvolving
public double getDouble(ConfigOption<Double> configOption)

Deprecated. use get(ConfigOption) or getOptional(ConfigOption)

Returns the value associated with the given config option as a double.

Parameters:

configOption - The configuration option

Returns:

the (default) value associated with the given config option

getDouble

@Deprecated
 @PublicEvolving
public double getDouble(ConfigOption<Double> configOption,
                                                     double overrideDefault)

Deprecated. use get(ConfigOption, Object)

Returns the value associated with the given config option as a double. If no value is mapped under any key of the option, it returns the specified default instead of the option's default value.

Parameters:

configOption - The configuration option

overrideDefault - The value to return if no value was mapper for any key of the option

Returns:

the configured value associated with the given config option, or the overrideDefault

setDouble

@Deprecated
public void setDouble(String key,
                                  double value)

Deprecated. use set(ConfigOption, Object)

Adds the given key/value pair to the configuration object.

Parameters:

key - the key of the key/value pair to be added

value - the value of the key/value pair to be added

setDouble

@Deprecated
 @PublicEvolving
public void setDouble(ConfigOption<Double> key,
                                                   double value)

Deprecated. use set(ConfigOption, Object)

Adds the given value to the configuration object. The main key of the config option will be used to map the value.

Parameters:

key - the option specifying the key to be added

value - the value of the key/value pair to be added

getBytes

public byte[] getBytes(String key,
                       byte[] defaultValue)

Returns the value associated with the given key as a byte array.

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.

setBytes

public void setBytes(String key,
                     byte[] bytes)

Adds the given byte array to the configuration object. If key is null then nothing is added.

Parameters:

key - The key under which the bytes are added.

bytes - The bytes to be added.

getValue

@PublicEvolving
public String getValue(ConfigOption<?> configOption)

Returns the value associated with the given config option as a string.

Parameters:

configOption - The configuration option

Returns:

the (default) value associated with the given config option

getEnum

@PublicEvolving
public <T extends Enum<T>> T getEnum(Class<T> enumClass,
                                                     ConfigOption<String> configOption)

Returns the value associated with the given config option as an enum.

Parameters:

enumClass - The return enum class

configOption - The configuration option

Throws:

IllegalArgumentException - If the string associated with the given config option cannot be parsed as a value of the provided enum class.

keySet

public Set<String> keySet()

Returns the keys of all key/value pairs stored inside this configuration object.

Returns:

the keys of all key/value pairs stored inside this configuration object

addAllToProperties

public void addAllToProperties(Properties props)

Adds all entries in this Configuration to the given Properties.

addAll

public void addAll(Configuration other)

addAll

public void addAll(Configuration other,
                   String prefix)

Adds all entries from the given configuration into this configuration. The keys are prepended with the given prefix.

Parameters:

other - The configuration whose entries are added to this configuration.

prefix - The prefix to prepend.

clone

public Configuration clone()

Overrides:

clone in class Object

containsKey

public boolean containsKey(String key)

Checks whether there is an entry with the specified key.

Parameters:

key - key of entry

Returns:

true if the key is stored, false otherwise

contains

@PublicEvolving
public boolean contains(ConfigOption<?> configOption)

Checks whether there is an entry for the given config option.

Parameters:

configOption - The configuration option

Returns:

true if a valid (current or deprecated) key of the config option is stored, false otherwise

get

public <T> T get(ConfigOption<T> option)

Please check the java doc of getRawValueFromOption(ConfigOption). If no keys are found in Configuration, default value of the given option will return. Please make sure there will be at least one value available. Otherwise, a NPE will be thrown by Flink when the value is used.

NOTE: current logic is not able to get the default value of the fallback key's ConfigOption, in case the given ConfigOption has no default value. If you want to use fallback key, please make sure its value could be found in Configuration at runtime.

Specified by:

get in interface ReadableConfig

Type Parameters:

T - type of the value to read

Parameters:

option - metadata of the option to read

Returns:

the value of the given option

See Also:

ReadableConfig.getOptional(ConfigOption)

get

@PublicEvolving
public <T> T get(ConfigOption<T> configOption,
                                 T overrideDefault)

Returns the value associated with the given config option as a T. If no value is mapped under any key of the option, it returns the specified default instead of the option's default value.

Parameters:

configOption - The configuration option

overrideDefault - The value to return if no value was mapper for any key of the option

Returns:

the configured value associated with the given config option, or the overrideDefault

getOptional

public <T> Optional<T> getOptional(ConfigOption<T> option)

Description copied from interface: ReadableConfig

Reads a value using the metadata included in ConfigOption. In contrast to ReadableConfig.get(ConfigOption) returns Optional.empty() if value not present.

Specified by:

getOptional in interface ReadableConfig

Type Parameters:

T - type of the value to read

Parameters:

option - metadata of the option to read

Returns:

read value or Optional.empty() if not found

See Also:

ReadableConfig.get(ConfigOption)

set

public <T> Configuration set(ConfigOption<T> option,
                             T value)

Description copied from interface: WritableConfig

Stores a given value using the metadata included in the ConfigOption. The value should be readable back through ReadableConfig.

Specified by:

set in interface WritableConfig

Type Parameters:

T - type of the value to be stored

Parameters:

option - metadata information

value - value to be stored

Returns:

instance of this configuration for fluent API

toMap

public Map<String,String> toMap()

Description copied from class: ExecutionConfig.GlobalJobParameters

Convert UserConfig into a Map<String, String> representation. This can be used by the runtime, for example for presenting the user config in the web frontend.

Specified by:

toMap in interface ReadableConfig

Overrides:

toMap in class ExecutionConfig.GlobalJobParameters

Returns:

Key/Value representation of the UserConfig

toFileWritableMap

@Internal
public Map<String,String> toFileWritableMap()

Convert Config into a Map<String, String> representation.

NOTE: This method is extracted from the toMap() method and should be called when Config needs to be written to a file.

This method ensures the value is properly escaped when writing the key-value pair to a standard YAML file.

removeConfig

public <T> boolean removeConfig(ConfigOption<T> configOption)

Removes given config option from the configuration.

Type Parameters:

T - Type of the config option

Parameters:

configOption - config option to remove

Returns:

true is config has been removed, false otherwise

removeKey

public boolean removeKey(String key)

Removes given key from the configuration.

Parameters:

key - key of a config option to remove

Returns:

true is config has been removed, false otherwise

read

public void read(DataInputView in)
          throws IOException

Description copied from interface: IOReadableWritable

Reads the object's internal data from the given data input view.

Specified by:

read in interface IOReadableWritable

Parameters:

in - the input view to read the data from

Throws:

IOException - thrown if any error occurs while reading from the input stream

write

public void write(DataOutputView out)
           throws IOException

Description copied from interface: IOReadableWritable

Writes the object's internal data to the given data output view.

Specified by:

write in interface IOReadableWritable

Parameters:

out - the output view to receive the data.

Throws:

IOException - thrown if any error occurs while writing to the output stream

hashCode

public int hashCode()

Overrides:

hashCode in class ExecutionConfig.GlobalJobParameters

equals

public boolean equals(Object obj)

Overrides:

equals in class ExecutionConfig.GlobalJobParameters

toString

public String toString()

Overrides:

toString in class Object