Package org.apache.flink.configuration

Interface ReadableConfig

All Known Implementing Classes:

Configuration, TableConfig

@PublicEvolving
public interface ReadableConfig

Read access to a configuration object. Allows reading values described with meta information included in ConfigOption.

Method Summary

Modifier and Type	Method	Description
<T> T	get(ConfigOption<T> option)	Reads a value using the metadata included in ConfigOption.
<T> Optional<T>	getOptional(ConfigOption<T> option)	Reads a value using the metadata included in ConfigOption.
Map<String,String>	toMap()	Converts the configuration items into a map of string key-value pairs.

Method Details

get

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

Reads a value using the metadata included in ConfigOption. Returns the ConfigOption.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 in ConfigOption. In contrast to get(ConfigOption) returns Optional.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)

toMap

@Internal
Map<String,String> toMap()

Converts the configuration items into a map of string key-value pairs.

Returns:

a map containing the configuration properties, where the keys are strings and the values are the corresponding configuration values in string format.