Package org.apache.flink.python

Class PythonConfig

java.lang.Object

org.apache.flink.python.PythonConfig

All Implemented Interfaces:

ReadableConfig

@Internal
public class PythonConfig
extends Object
implements ReadableConfig

Configurations for the Python job which are used at run time.

Constructor Summary

Constructors

Constructor	Description
PythonConfig(ReadableConfig configuration, ReadableConfig pythonDependencyConfiguration)

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.
Configuration	toConfiguration()
Map<String,String>	toMap()	Converts the configuration items into a map of string key-value pairs.

Methods inherited from class java.lang.Object

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

Constructor Detail

PythonConfig

public PythonConfig(ReadableConfig configuration,
                    ReadableConfig pythonDependencyConfiguration)

Method Detail

get

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

Description copied from interface: ReadableConfig

Reads a value using the metadata included in ConfigOption. Returns the ConfigOption.defaultValue() if value key not present in the configuration.

Specified by:

get in interface ReadableConfig

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:

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

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)

toMap

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

Description copied from interface: ReadableConfig

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

Specified by:

toMap in interface ReadableConfig

Returns:

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

toConfiguration

public Configuration toConfiguration()