org.apache.flink.table.planner.plan.nodes.exec

Class ExecNodeConfig

java.lang.Object

org.apache.flink.table.planner.plan.nodes.exec.ExecNodeConfig

All Implemented Interfaces:

ReadableConfig

@Internal
public final class ExecNodeConfig
extends Object
implements ReadableConfig

Configuration view which is used combine the PlannerBase.getTableConfig() with the ExecNodeBase.getPersistedConfig() configuration. The persisted configuration of the ExecNode which is deserialized from the JSON plan has precedence over the PlannerBase.getTableConfig().

This class is intended to contain additional context information for ExecNode translation such as shouldSetUid() or helper methods for accessing configuration such as getStateRetentionTime().

Method Summary

Modifier and Type	Method and 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.
long	getStateRetentionTime()
boolean	isCompiled()
static ExecNodeConfig	ofNodeConfig(ReadableConfig nodeConfig, boolean isCompiled)
static ExecNodeConfig	ofTableConfig(TableConfig tableConfig, boolean isCompiled)
boolean	shouldSetUid()
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

Method Detail

ofNodeConfig

public static ExecNodeConfig ofNodeConfig(ReadableConfig nodeConfig,
                                          boolean isCompiled)

ofTableConfig

@VisibleForTesting
public static ExecNodeConfig ofTableConfig(TableConfig tableConfig,
                                                              boolean isCompiled)

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.

getStateRetentionTime

public long getStateRetentionTime()

Returns:

The duration until state which was not updated will be retained.

isCompiled

public boolean isCompiled()

Returns:

Whether the ExecNode translation happens as part of a plan compilation.

shouldSetUid

public boolean shouldSetUid()

Returns:

Whether transformations should set a UID.