org.apache.hudi.common.config

Class ConfigProperty<T>

java.lang.Object

org.apache.hudi.common.config.ConfigProperty<T>

Type Parameters:

T - The type of the default value.

All Implemented Interfaces:

Serializable

public class ConfigProperty<T>
extends Object
implements Serializable

ConfigProperty describes a configuration property. It contains the configuration key, deprecated older versions of the key, and an optional default value for the configuration, configuration descriptions and also an inferring mechanism to infer the configuration value based on other configurations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigProperty.PropertyBuilder The PropertyBuilder is used to build the ConfigProperty.

Method Summary

Modifier and Type	Method and Description
void	checkValues(String value)
T	defaultValue()
ConfigProperty<T>	deprecatedAfter(String deprecatedVersion)
String	doc()
List<String>	getAlternatives()
Option<String>	getDeprecatedVersion()
String	getDocOnDefaultValue()
Option<String>	getSinceVersion()
boolean	hasDefaultValue()
boolean	hasInferFunction()
boolean	isAdvanced()
String	key()
static ConfigProperty.PropertyBuilder	key(String key) Create a OptionBuilder with key.
ConfigProperty<T>	markAdvanced() Marks the config as an advanced config.
ConfigProperty<T>	sinceVersion(String sinceVersion)
String	toString()
ConfigProperty<T>	withAlternatives(String... alternatives)
<U extends Enum<U>> ConfigProperty<T>	withDocumentation(Class<U> e)
<U extends Enum<U>> ConfigProperty<T>	withDocumentation(Class<U> e, String doc)
ConfigProperty<T>	withDocumentation(String doc)
ConfigProperty<T>	withInferFunction(Function<HoodieConfig,Option<T>> inferFunction)
ConfigProperty<T>	withValidValues(String... validValues)

Methods inherited from class java.lang.Object

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

Method Detail

key

public String key()

defaultValue

public T defaultValue()

hasDefaultValue

public boolean hasDefaultValue()

getDocOnDefaultValue

public String getDocOnDefaultValue()

doc

public String doc()

getSinceVersion

public Option<String> getSinceVersion()

getDeprecatedVersion

public Option<String> getDeprecatedVersion()

hasInferFunction

public boolean hasInferFunction()

checkValues

public void checkValues(String value)

getAlternatives

public List<String> getAlternatives()

isAdvanced

public boolean isAdvanced()

withDocumentation

public ConfigProperty<T> withDocumentation(String doc)

withDocumentation

public <U extends Enum<U>> ConfigProperty<T> withDocumentation(Class<U> e)

withDocumentation

public <U extends Enum<U>> ConfigProperty<T> withDocumentation(Class<U> e,
                                                               String doc)

withValidValues

public ConfigProperty<T> withValidValues(String... validValues)

withAlternatives

public ConfigProperty<T> withAlternatives(String... alternatives)

sinceVersion

public ConfigProperty<T> sinceVersion(String sinceVersion)

deprecatedAfter

public ConfigProperty<T> deprecatedAfter(String deprecatedVersion)

withInferFunction

public ConfigProperty<T> withInferFunction(Function<HoodieConfig,Option<T>> inferFunction)

markAdvanced

public ConfigProperty<T> markAdvanced()

Marks the config as an advanced config.

key

public static ConfigProperty.PropertyBuilder key(String key)

Create a OptionBuilder with key.

Parameters:

key - The key of the option

Returns:

Return a OptionBuilder.

toString

public String toString()

Overrides:

toString in class Object