org.apache.paimon.annotation

Class Documentation

java.lang.Object

org.apache.paimon.annotation.Documentation

public final class Documentation
extends Object

Collection of annotations to modify the behavior of the documentation generators.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Documentation.ExcludeFromDocumentation Annotation used on config option fields or REST API message headers to exclude it from documentation.
static interface	Documentation.Immutable Annotation used on ConfigOption fields to exclude it from schema change.
static interface	Documentation.OverrideDefault Annotation used on config option fields to override the documented default.
static interface	Documentation.Section Annotation used on config option fields to include them in specific sections.
static interface	Documentation.SuffixOption Annotation used on config option fields or options class to mark them as a suffix-option; i.e., a config option where the key is only a suffix, with the prefix being dynamically provided at runtime.

Method Summary

Methods inherited from class java.lang.Object

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