Package org.apache.flink.configuration
Interface ReadableConfig
-
- All Known Implementing Classes:
Configuration
,DelegatingConfiguration
,UnmodifiableConfiguration
@PublicEvolving public interface ReadableConfig
Read access to a configuration object. Allows reading values described with meta information included inConfigOption
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <T> T
get(ConfigOption<T> option)
Reads a value using the metadata included inConfigOption
.<T> Optional<T>
getOptional(ConfigOption<T> option)
Reads a value using the metadata included inConfigOption
.Map<String,String>
toMap()
Converts the configuration items into a map of string key-value pairs.
-
-
-
Method Detail
-
get
<T> T get(ConfigOption<T> option)
Reads a value using the metadata included inConfigOption
. Returns theConfigOption.defaultValue()
if value key not present in the configuration.- Type Parameters:
T
- type of the value to read- Parameters:
option
- metadata of the option to read- Returns:
- read value or
ConfigOption.defaultValue()
if not found - See Also:
getOptional(ConfigOption)
-
getOptional
<T> Optional<T> getOptional(ConfigOption<T> option)
Reads a value using the metadata included inConfigOption
. In contrast toget(ConfigOption)
returnsOptional.empty()
if value not present.- 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:
get(ConfigOption)
-
-