DescribedEnum (Flink : Core 2.0.0 API)

All Known Implementing Classes:

BatchShuffleMode, CheckpointType, ClusterOptions.UserSystemExitMode, ExecutionConfig.ClosureCleanerLevel, ExternalizedCheckpointRetention, JobManagerOptions.SchedulerType, MetricOptions.JobStatusMetrics, RecoveryClaimMode, SavepointFormatType
```
@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
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method 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.