Package org.apache.flink.annotation.docs
package org.apache.flink.annotation.docs
-
ClassDescriptionA class that specifies a group of config options.Annotation used on classes containing config options that enables the separation of options into different tables based on key prefixes.Collection of annotations to modify the behavior of the documentation generators.Annotation used on config option fields or REST API message headers to exclude it from documentation.The execution mode the config works for.Annotation used on config option fields to override the documented default.Annotation used on config option fields to include them in specific sections.Constants for section names.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.Annotation used on table config options for adding meta data labels.Annotations for auto-generating a documentation of json payloads.This allows documenting a class that supports setting dynamic properties of a certain type.