DelegatingConfiguration (Flink : 1.17-SNAPSHOT API)

java.lang.Object
- org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters
- - org.apache.flink.configuration.Configuration
  - - org.apache.flink.configuration.DelegatingConfiguration

All Implemented Interfaces:

Serializable, Cloneable, ReadableConfig, WritableConfig, IOReadableWritable
```
public final class DelegatingConfiguration
extends Configuration
```
A configuration that manages a subset of keys with a common prefix from a given configuration.

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.apache.flink.configuration.Configuration
  confData

Constructor Summary

Constructors
Constructor and Description
`DelegatingConfiguration()` Default constructor for serialization.
`DelegatingConfiguration(Configuration backingConfig, String prefix)` Creates a new delegating configuration which stores its key/value pairs in the given configuration using the specifies key prefix.

Method Summary

All Methods Instance Methods Concrete Methods
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)`
`<T> T`	`get(ConfigOption<T> option)` Please check the java doc of `Configuration.getRawValueFromOption(ConfigOption)`.
`boolean`	`getBoolean(ConfigOption<Boolean> configOption)` Returns the value associated with the given config option as a boolean.
`boolean`	`getBoolean(ConfigOption<Boolean> configOption, boolean overrideDefault)` Returns the value associated with the given config option as a boolean.
`boolean`	`getBoolean(String key, boolean defaultValue)` Returns the value associated with the given key as a boolean.
`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)` Returns the class associated with the given key as a string.
`double`	`getDouble(ConfigOption<Double> configOption)` Returns the value associated with the given config option as a `double`.
`double`	`getDouble(ConfigOption<Double> configOption, double overrideDefault)` Returns the value associated with the given config option as a `double`.
`double`	`getDouble(String key, double defaultValue)` Returns the value associated with the given key as a double.
`<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)` Returns the value associated with the given config option as a float.
`float`	`getFloat(ConfigOption<Float> configOption, float overrideDefault)` Returns the value associated with the given config option as a float.
`float`	`getFloat(String key, float defaultValue)` Returns the value associated with the given key as a float.
`int`	`getInteger(ConfigOption<Integer> configOption)` Returns the value associated with the given config option as an integer.
`int`	`getInteger(ConfigOption<Integer> configOption, int overrideDefault)` Returns the value associated with the given config option as an integer.
`int`	`getInteger(String key, int defaultValue)` Returns the value associated with the given key as an integer.
`long`	`getLong(ConfigOption<Long> configOption)` Returns the value associated with the given config option as a long integer.
`long`	`getLong(ConfigOption<Long> configOption, long overrideDefault)` Returns the value associated with the given config option as a long integer.
`long`	`getLong(String key, long defaultValue)` Returns the value associated with the given key as a long.
`<T> Optional<T>`	`getOptional(ConfigOption<T> option)` Reads a value using the metadata included in `ConfigOption`.
`String`	`getString(ConfigOption<String> configOption)` Returns the value associated with the given config option as a string.
`String`	`getString(ConfigOption<String> configOption, String overrideDefault)` Returns the value associated with the given config option as a string.
`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)` Adds the given value to the configuration object.
`void`	`setBoolean(String key, boolean value)` Adds the given key/value pair to the configuration object.
`void`	`setBytes(String key, byte[] bytes)` Adds the given byte array to the configuration object.
`void`	`setClass(String key, Class<?> klazz)` Adds the given key/value pair to the configuration object.
`void`	`setDouble(ConfigOption<Double> key, double value)` Adds the given value to the configuration object.
`void`	`setDouble(String key, double value)` Adds the given key/value pair to the configuration object.
`void`	`setFloat(ConfigOption<Float> key, float value)` Adds the given value to the configuration object.
`void`	`setFloat(String key, float value)` Adds the given key/value pair to the configuration object.
`void`	`setInteger(ConfigOption<Integer> key, int value)` Adds the given value to the configuration object.
`void`	`setInteger(String key, int value)` Adds the given key/value pair to the configuration object.
`void`	`setLong(ConfigOption<Long> key, long value)` Adds the given value to the configuration object.
`void`	`setLong(String key, long value)` Adds the given key/value pair to the configuration object.
`void`	`setString(ConfigOption<String> key, String value)` Adds the given value to the configuration object.
`void`	`setString(String key, String value)` Adds the given key/value pair to the configuration object.
`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 org.apache.flink.configuration.Configuration
fromMap

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DelegatingConfiguration
```
public DelegatingConfiguration()
```
    Default constructor for serialization. Creates an empty delegating configuration.
  - DelegatingConfiguration
```
public DelegatingConfiguration(Configuration backingConfig,
                               String prefix)
```
    Creates a new delegating configuration which stores its key/value pairs in the given configuration using the specifies key prefix.
    
    Parameters:
    
    backingConfig - The configuration holding the actual config data.
    
    prefix - The prefix prepended to all config keys.
- Method Detail
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given key as a string.
    
    Overrides:
    
    getString in class Configuration
    
    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
```
public String getString(ConfigOption<String> configOption)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given config option as a string.
    
    Overrides:
    
    getString in class Configuration
    
    Parameters:
    
    configOption - The configuration option
    
    Returns:
    
    the (default) value associated with the given config option
  - getString
```
public String getString(ConfigOption<String> configOption,
                        String overrideDefault)
```
    Description copied from class: Configuration
    
    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.
    
    Overrides:
    
    getString in class Configuration
    
    Parameters:
    
    configOption - The configuration option
    
    Returns:
    
    the (default) value associated with the given config option
  - setString
```
public void setString(String key,
                      String value)
```
    Description copied from class: Configuration
    
    Adds the given key/value pair to the configuration object.
    
    Overrides:
    
    setString in class Configuration
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - setString
```
public void setString(ConfigOption<String> key,
                      String value)
```
    Description copied from class: Configuration
    
    Adds the given value to the configuration object. The main key of the config option will be used to map the value.
    
    Overrides:
    
    setString in class Configuration
    
    Parameters:
    
    key - the option specifying the key to be added
    
    value - the value of the key/value pair to be added
  - getClass
```
public <T> Class<T> getClass(String key,
                             Class<? extends T> defaultValue,
                             ClassLoader classLoader)
                      throws ClassNotFoundException
```
    Description copied from class: Configuration
    
    Returns the class associated with the given key as a string.
    
    Overrides:
    
    getClass in class Configuration
    
    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
```
public void setClass(String key,
                     Class<?> klazz)
```
    Description copied from class: Configuration
    
    Adds the given key/value pair to the configuration object. The class can be retrieved by invoking Configuration.getClass(String, Class, ClassLoader) if it is in the scope of the class loader on the caller.
    
    Overrides:
    
    setClass in class Configuration
    
    Parameters:
    
    key - The key of the pair to be added
    
    klazz - The value of the pair to be added
    
    See Also:
    
    Configuration.getClass(String, Class, ClassLoader)
  - getInteger
```
public int getInteger(String key,
                      int defaultValue)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given key as an integer.
    
    Overrides:
    
    getInteger in class Configuration
    
    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 int getInteger(ConfigOption<Integer> configOption)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given config option as an integer.
    
    Overrides:
    
    getInteger in class Configuration
    
    Parameters:
    
    configOption - The configuration option
    
    Returns:
    
    the (default) value associated with the given config option
  - getInteger
```
public int getInteger(ConfigOption<Integer> configOption,
                      int overrideDefault)
```
    Description copied from class: Configuration
    
    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.
    
    Overrides:
    
    getInteger in class Configuration
    
    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
```
public void setInteger(String key,
                       int value)
```
    Description copied from class: Configuration
    
    Adds the given key/value pair to the configuration object.
    
    Overrides:
    
    setInteger in class Configuration
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - setInteger
```
public void setInteger(ConfigOption<Integer> key,
                       int value)
```
    Description copied from class: Configuration
    
    Adds the given value to the configuration object. The main key of the config option will be used to map the value.
    
    Overrides:
    
    setInteger in class Configuration
    
    Parameters:
    
    key - the option specifying the key to be added
    
    value - the value of the key/value pair to be added
  - getLong
```
public long getLong(String key,
                    long defaultValue)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given key as a long.
    
    Overrides:
    
    getLong in class Configuration
    
    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 long getLong(ConfigOption<Long> configOption)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given config option as a long integer.
    
    Overrides:
    
    getLong in class Configuration
    
    Parameters:
    
    configOption - The configuration option
    
    Returns:
    
    the (default) value associated with the given config option
  - getLong
```
public long getLong(ConfigOption<Long> configOption,
                    long overrideDefault)
```
    Description copied from class: Configuration
    
    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.
    
    Overrides:
    
    getLong in class Configuration
    
    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
```
public void setLong(String key,
                    long value)
```
    Description copied from class: Configuration
    
    Adds the given key/value pair to the configuration object.
    
    Overrides:
    
    setLong in class Configuration
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - setLong
```
public void setLong(ConfigOption<Long> key,
                    long value)
```
    Description copied from class: Configuration
    
    Adds the given value to the configuration object. The main key of the config option will be used to map the value.
    
    Overrides:
    
    setLong in class Configuration
    
    Parameters:
    
    key - the option specifying the key to be added
    
    value - the value of the key/value pair to be added
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean defaultValue)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given key as a boolean.
    
    Overrides:
    
    getBoolean in class Configuration
    
    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 boolean getBoolean(ConfigOption<Boolean> configOption)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given config option as a boolean.
    
    Overrides:
    
    getBoolean in class Configuration
    
    Parameters:
    
    configOption - The configuration option
    
    Returns:
    
    the (default) value associated with the given config option
  - setBoolean
```
public void setBoolean(String key,
                       boolean value)
```
    Description copied from class: Configuration
    
    Adds the given key/value pair to the configuration object.
    
    Overrides:
    
    setBoolean in class Configuration
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - setBoolean
```
public void setBoolean(ConfigOption<Boolean> key,
                       boolean value)
```
    Description copied from class: Configuration
    
    Adds the given value to the configuration object. The main key of the config option will be used to map the value.
    
    Overrides:
    
    setBoolean in class Configuration
    
    Parameters:
    
    key - the option specifying the key to be added
    
    value - the value of the key/value pair to be added
  - getBoolean
```
public boolean getBoolean(ConfigOption<Boolean> configOption,
                          boolean overrideDefault)
```
    Description copied from class: Configuration
    
    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.
    
    Overrides:
    
    getBoolean in class Configuration
    
    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
  - getFloat
```
public float getFloat(String key,
                      float defaultValue)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given key as a float.
    
    Overrides:
    
    getFloat in class Configuration
    
    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 float getFloat(ConfigOption<Float> configOption)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given config option as a float.
    
    Overrides:
    
    getFloat in class Configuration
    
    Parameters:
    
    configOption - The configuration option
    
    Returns:
    
    the (default) value associated with the given config option
  - getFloat
```
public float getFloat(ConfigOption<Float> configOption,
                      float overrideDefault)
```
    Description copied from class: Configuration
    
    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.
    
    Overrides:
    
    getFloat in class Configuration
    
    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
```
public void setFloat(String key,
                     float value)
```
    Description copied from class: Configuration
    
    Adds the given key/value pair to the configuration object.
    
    Overrides:
    
    setFloat in class Configuration
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - setFloat
```
public void setFloat(ConfigOption<Float> key,
                     float value)
```
    Description copied from class: Configuration
    
    Adds the given value to the configuration object. The main key of the config option will be used to map the value.
    
    Overrides:
    
    setFloat in class Configuration
    
    Parameters:
    
    key - the option specifying the key to be added
    
    value - the value of the key/value pair to be added
  - getDouble
```
public double getDouble(String key,
                        double defaultValue)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given key as a double.
    
    Overrides:
    
    getDouble in class Configuration
    
    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
```
public double getDouble(ConfigOption<Double> configOption)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given config option as a double.
    
    Overrides:
    
    getDouble in class Configuration
    
    Parameters:
    
    configOption - The configuration option
    
    Returns:
    
    the (default) value associated with the given config option
  - getDouble
```
public double getDouble(ConfigOption<Double> configOption,
                        double overrideDefault)
```
    Description copied from class: Configuration
    
    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.
    
    Overrides:
    
    getDouble in class Configuration
    
    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
```
public void setDouble(String key,
                      double value)
```
    Description copied from class: Configuration
    
    Adds the given key/value pair to the configuration object.
    
    Overrides:
    
    setDouble in class Configuration
    
    Parameters:
    
    key - the key of the key/value pair to be added
    
    value - the value of the key/value pair to be added
  - setDouble
```
public void setDouble(ConfigOption<Double> key,
                      double value)
```
    Description copied from class: Configuration
    
    Adds the given value to the configuration object. The main key of the config option will be used to map the value.
    
    Overrides:
    
    setDouble in class Configuration
    
    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)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given key as a byte array.
    
    Overrides:
    
    getBytes in class Configuration
    
    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)
```
    Description copied from class: Configuration
    
    Adds the given byte array to the configuration object. If key is null then nothing is added.
    
    Overrides:
    
    setBytes in class Configuration
    
    Parameters:
    
    key - The key under which the bytes are added.
    
    bytes - The bytes to be added.
  - getValue
```
public String getValue(ConfigOption<?> configOption)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given config option as a string.
    
    Overrides:
    
    getValue in class Configuration
    
    Parameters:
    
    configOption - The configuration option
    
    Returns:
    
    the (default) value associated with the given config option
  - getEnum
```
public <T extends Enum<T>> T getEnum(Class<T> enumClass,
                                     ConfigOption<String> configOption)
```
    Description copied from class: Configuration
    
    Returns the value associated with the given config option as an enum.
    
    Overrides:
    
    getEnum in class Configuration
    
    Parameters:
    
    enumClass - The return enum class
    
    configOption - The configuration option
  - addAllToProperties
```
public void addAllToProperties(Properties props)
```
    Description copied from class: Configuration
    
    Adds all entries in this Configuration to the given Properties.
    
    Overrides:
    
    addAllToProperties in class Configuration
  - addAll
```
public void addAll(Configuration other)
```
    Overrides:
    
    addAll in class Configuration
  - addAll
```
public void addAll(Configuration other,
                   String prefix)
```
    Description copied from class: Configuration
    
    Adds all entries from the given configuration into this configuration. The keys are prepended with the given prefix.
    
    Overrides:
    
    addAll in class Configuration
    
    Parameters:
    
    other - The configuration whose entries are added to this configuration.
    
    prefix - The prefix to prepend.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Configuration
  - keySet
```
public Set<String> keySet()
```
    Description copied from class: Configuration
    
    Returns the keys of all key/value pairs stored inside this configuration object.
    
    Overrides:
    
    keySet in class Configuration
    
    Returns:
    
    the keys of all key/value pairs stored inside this configuration object
  - clone
```
public Configuration clone()
```
    Overrides:
    
    clone in class Configuration
  - 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.
    
    Overrides:
    
    toMap in class Configuration
    
    Returns:
    
    Key/Value representation of the UserConfig
  - removeConfig
```
public <T> boolean removeConfig(ConfigOption<T> configOption)
```
    Description copied from class: Configuration
    
    Removes given config option from the configuration.
    
    Overrides:
    
    removeConfig in class 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)
```
    Description copied from class: Configuration
    
    Removes given key from the configuration.
    
    Overrides:
    
    removeKey in class Configuration
    
    Parameters:
    
    key - key of a config option to remove
    
    Returns:
    
    true is config has been removed, false otherwise
  - containsKey
```
public boolean containsKey(String key)
```
    Description copied from class: Configuration
    
    Checks whether there is an entry with the specified key.
    
    Overrides:
    
    containsKey in class Configuration
    
    Parameters:
    
    key - key of entry
    
    Returns:
    
    true if the key is stored, false otherwise
  - contains
```
public boolean contains(ConfigOption<?> configOption)
```
    Description copied from class: Configuration
    
    Checks whether there is an entry for the given config option.
    
    Overrides:
    
    contains in class Configuration
    
    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)
```
    Description copied from class: Configuration
    
    Please check the java doc of Configuration.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
    
    Overrides:
    
    get in class Configuration
    
    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)
  - 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
    
    Overrides:
    
    getOptional in class Configuration
    
    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
    
    Overrides:
    
    set in class Configuration
    
    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
  - 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
    
    Overrides:
    
    read in class Configuration
    
    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
    
    Overrides:
    
    write in class Configuration
    
    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 Configuration
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Configuration

Back to Flink Website

Class DelegatingConfiguration

Field Summary

Fields inherited from class org.apache.flink.configuration.Configuration

Constructor Summary

Method Summary

Methods inherited from class org.apache.flink.configuration.Configuration

Methods inherited from class java.lang.Object

Constructor Detail

DelegatingConfiguration

DelegatingConfiguration

Method Detail

getString

getString

getString

setString

setString

getClass

setClass

getInteger

getInteger

getInteger

setInteger

setInteger

getLong

getLong

getLong

setLong

setLong

getBoolean

getBoolean

setBoolean

setBoolean

getBoolean

getFloat

getFloat

getFloat

setFloat

setFloat

getDouble

getDouble

getDouble

setDouble

setDouble

getBytes

setBytes

getValue

getEnum

addAllToProperties

addAll

addAll

toString

keySet

clone

toMap

removeConfig

removeKey

containsKey

contains

get

getOptional

set

read

write

hashCode

equals

Back to Flink Website