org.apache.hudi.common.config

Annotation Type ConfigClassProperty

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface ConfigClassProperty

Annotation for superclasses of HoodieConfig that includes the human-readable name of the config class, the config group (ConfigGroups) it belongs to (e.g., spark/ flink/ write), optional sub-group (ConfigGroups), and the description of the config class.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description
ConfigGroups.Names	groupName
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	areCommonConfigs
ConfigGroups.SubGroupNames	subGroupName

Element Detail

name

public abstract String name

groupName

public abstract ConfigGroups.Names groupName

description

public abstract String description

subGroupName

public abstract ConfigGroups.SubGroupNames subGroupName

Default:

org.apache.hudi.common.config.ConfigGroups.SubGroupNames.NONE

areCommonConfigs

public abstract boolean areCommonConfigs

Default:

false