org.apache.hudi.common.config

Annotation Type EnumDescription

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface EnumDescription

For any enum that is going to be used as a config value, add this annotation by adding @EnumDescription("Your description here.") directly above the enum class declaration. Then in your config property add .withDocumentation(YourEnum.class) see EnumFieldDescription.java

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Element Detail

value

public abstract String value