org.apache.hudi.common.config

Annotation Type EnumFieldDescription

@Documented
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface EnumFieldDescription

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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Element Detail

value

public abstract String value