Hong Liang Teoh created FLINK-32619:
---------------------------------------

             Summary: ConfigOptions to support fallback configuration
                 Key: FLINK-32619
                 URL: https://issues.apache.org/jira/browse/FLINK-32619
             Project: Flink
          Issue Type: Technical Debt
          Components: Runtime / Configuration
    Affects Versions: 1.17.1, 1.16.2
            Reporter: Hong Liang Teoh


ConfigOptions has no option to specify a "fallback configuration" as the 
default.

 

For example, if we want {{rest.cache.checkpoint-statistics.timeout}} to 
fallback to web.refresh-interval instead of a static default value, we have to 
specify

 
{code:java}
@Documentation.OverrideDefault("web.refresh-interval")
@Documentation.Section(Documentation.Sections.EXPERT_REST)
public static final ConfigOption<Duration> CACHE_CHECKPOINT_STATISTICS_TIMEOUT =
        key("rest.cache.checkpoint-statistics.timeout")
                .durationType()
                .noDefaultValue()
                .withDescription(
                        "....");
 {code}
 

 

The {{.noDefault()}} is misleading as it actually has a default.

 

We should introduce a {{.fallbackConfiguration()}} that is handled gracefully 
by doc generators.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to