org.apache.flink.configuration

Interface DescribedEnum

All Known Implementing Classes:

AvroFormatOptions.AvroEncoding, BatchShuffleMode, CheckpointConfig.ExternalizedCheckpointCleanup, CheckpointType, ClusterOptions.UserSystemExitMode, DeliveryGuarantee, EmbeddedRocksDBStateBackend.PriorityQueueStateType, ExecutionConfig.ClosureCleanerLevel, ExecutionConfigOptions.LegacyCastBehaviour, ExecutionConfigOptions.NotNullEnforcer, ExecutionConfigOptions.RowtimeInserter, ExecutionConfigOptions.TypeLengthEnforcer, ExecutionConfigOptions.UidGeneration, FileSystemConnectorOptions.FileStatisticsType, FileSystemConnectorOptions.PartitionCommitTriggerType, HiveOptions.PartitionOrder, JobManagerOptions.SchedulerType, MetricOptions.JobStatusMetrics, RestoreMode, ResultMode, SavepointFormatType, TableConfigOptions.CatalogPlanCompilation, TableConfigOptions.CatalogPlanRestore, TableConfigOptions.ColumnExpansionStrategy, YarnConfigOptions.UserJarInclusion

@PublicEvolving
public interface DescribedEnum

Describe enum constants used in ConfigOptions.

For enums used as config options, this interface can be implemented to provide a Description for each enum constant. This will be used when generating documentation for config options to include a list of available values alongside their respective descriptions.

More precisely, only an InlineElement can be returned as block elements cannot be nested into a list.

Method Summary

Modifier and Type	Method and Description
InlineElement	getDescription() Returns the description for the enum constant.

Method Detail

getDescription

InlineElement getDescription()

Returns the description for the enum constant.

If you want to include links or code blocks, use TextElement.wrap(InlineElement...) to wrap multiple inline elements into a single one.