org.apache.hudi.common.config

Class HoodieConfig

java.lang.Object

org.apache.hudi.common.config.HoodieConfig

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConsistencyGuardConfig, FileSystemRetryConfig, FileSystemViewStorageConfig, HoodieCommonConfig, HoodieIndexingConfig, HoodieMemoryConfig, HoodieMetadataConfig, HoodieMetaserverConfig, HoodieMetricsCloudWatchConfig, HoodieMetricsConfig, HoodieMetricsDatadogConfig, HoodieMetricsGraphiteConfig, HoodieMetricsJmxConfig, HoodieMetricsM3Config, HoodieMetricsPrometheusConfig, HoodieReaderConfig, HoodieStorageConfig, HoodieTableConfig, HoodieTableServiceManagerConfig, HoodieTimeGeneratorConfig, KeyGeneratorOptions, TimestampKeyGeneratorConfig

public class HoodieConfig
extends Object
implements Serializable

This class deals with ConfigProperty and provides get/set functionalities.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONFIG_VALUES_DELIMITER
protected static int	MAX_READ_RETRIES
protected TypedProperties	props
protected static int	READ_RETRY_DELAY_MSEC

Constructor Summary

Constructors

Constructor and Description
HoodieConfig()
HoodieConfig(Properties props)
HoodieConfig(TypedProperties props)

Method Summary

Modifier and Type	Method and Description
<T> boolean	contains(ConfigProperty<T> configProperty)
Boolean	contains(String key)
<T> Boolean	getBoolean(ConfigProperty<T> configProperty)
<T> boolean	getBooleanOrDefault(ConfigProperty<T> configProperty)
<T> boolean	getBooleanOrDefault(ConfigProperty<T> configProperty, boolean defaultVal)
boolean	getBooleanOrDefault(String key, boolean defaultVal)
<T> Double	getDouble(ConfigProperty<T> configProperty)
<T> Double	getDoubleOrDefault(ConfigProperty<T> configProperty)
<T> Float	getFloat(ConfigProperty<T> configProperty)
<T> Float	getFloatOrDefault(ConfigProperty<T> configProperty)
<T> Integer	getInt(ConfigProperty<T> configProperty)
<T> Integer	getIntOrDefault(ConfigProperty<T> configProperty)
<T> Long	getLong(ConfigProperty<T> configProperty)
<T> Long	getLongOrDefault(ConfigProperty<T> configProperty)
TypedProperties	getProps()
TypedProperties	getProps(boolean includeGlobalProps)
<T> List<String>	getSplitStrings(ConfigProperty<T> configProperty)
<T> List<String>	getSplitStrings(ConfigProperty<T> configProperty, String delimiter)
<T> String	getString(ConfigProperty<T> configProperty)
String	getString(String key)
<T> String	getStringOrDefault(ConfigProperty<T> configProperty)
<T> String	getStringOrDefault(ConfigProperty<T> configProperty, String defaultVal)
<T> String	getStringOrThrow(ConfigProperty<T> configProperty, String errorMessage)
void	setAll(Properties properties)
void	setDefault(HoodieConfig config)
void	setDefaultOnCondition(boolean condition, HoodieConfig config)
protected void	setDefaults(String configClassName)
<T> void	setDefaultValue(ConfigProperty<T> configProperty) Sets the default value of a config if user does not set it already.
<T> void	setDefaultValue(ConfigProperty<T> configProperty, T defaultVal)
<T> void	setValue(ConfigProperty<T> cfg, String val)
<T> void	setValue(String key, String val)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_VALUES_DELIMITER

protected static final String CONFIG_VALUES_DELIMITER

See Also:

Constant Field Values

MAX_READ_RETRIES

protected static final int MAX_READ_RETRIES

See Also:

Constant Field Values

READ_RETRY_DELAY_MSEC

protected static final int READ_RETRY_DELAY_MSEC

See Also:

Constant Field Values

props

protected TypedProperties props

Constructor Detail

HoodieConfig

public HoodieConfig()

HoodieConfig

public HoodieConfig(Properties props)

HoodieConfig

public HoodieConfig(TypedProperties props)

Method Detail

setValue

public <T> void setValue(ConfigProperty<T> cfg,
                         String val)

setValue

public <T> void setValue(String key,
                         String val)

setAll

public void setAll(Properties properties)

setDefaultValue

public <T> void setDefaultValue(ConfigProperty<T> configProperty)

Sets the default value of a config if user does not set it already. The default value can only be set if the config property has a built-in default value or an infer function. When the infer function is present, the infer function is used first to derive the config value based on other configs. If the config value cannot be inferred, the built-in default value is used if present.

Type Parameters:

T - Data type of the config.

Parameters:

configProperty - Config to set a default value.

setDefaultValue

public <T> void setDefaultValue(ConfigProperty<T> configProperty,
                                T defaultVal)

contains

public Boolean contains(String key)

contains

public <T> boolean contains(ConfigProperty<T> configProperty)

setDefaults

protected void setDefaults(String configClassName)

getString

public <T> String getString(ConfigProperty<T> configProperty)

getSplitStrings

public <T> List<String> getSplitStrings(ConfigProperty<T> configProperty)

getSplitStrings

public <T> List<String> getSplitStrings(ConfigProperty<T> configProperty,
                                        String delimiter)

getString

public String getString(String key)

getInt

public <T> Integer getInt(ConfigProperty<T> configProperty)

getIntOrDefault

public <T> Integer getIntOrDefault(ConfigProperty<T> configProperty)

getBoolean

public <T> Boolean getBoolean(ConfigProperty<T> configProperty)

getBooleanOrDefault

public boolean getBooleanOrDefault(String key,
                                   boolean defaultVal)

getBooleanOrDefault

public <T> boolean getBooleanOrDefault(ConfigProperty<T> configProperty)

getBooleanOrDefault

public <T> boolean getBooleanOrDefault(ConfigProperty<T> configProperty,
                                       boolean defaultVal)

getLong

public <T> Long getLong(ConfigProperty<T> configProperty)

getLongOrDefault

public <T> Long getLongOrDefault(ConfigProperty<T> configProperty)

getFloat

public <T> Float getFloat(ConfigProperty<T> configProperty)

getFloatOrDefault

public <T> Float getFloatOrDefault(ConfigProperty<T> configProperty)

getDouble

public <T> Double getDouble(ConfigProperty<T> configProperty)

getDoubleOrDefault

public <T> Double getDoubleOrDefault(ConfigProperty<T> configProperty)

getStringOrDefault

public <T> String getStringOrDefault(ConfigProperty<T> configProperty)

getStringOrDefault

public <T> String getStringOrDefault(ConfigProperty<T> configProperty,
                                     String defaultVal)

getProps

public TypedProperties getProps()

getProps

public TypedProperties getProps(boolean includeGlobalProps)

setDefaultOnCondition

public void setDefaultOnCondition(boolean condition,
                                  HoodieConfig config)

setDefault

public void setDefault(HoodieConfig config)

getStringOrThrow

public <T> String getStringOrThrow(ConfigProperty<T> configProperty,
                                   String errorMessage)
                            throws HoodieException

Throws:

HoodieException