[FLINK-35359][config] Annotate the ConfigOptions that missing annotation

Gerrrr · May 23, 2024 · 51da2d0 · 51da2d0
1 parent 9ccfb65
commit 51da2d0
Show file tree

Hide file tree

Showing 14 changed files with 29 additions and 2 deletions.
diff --git a/flink-clients/src/main/java/org/apache/flink/client/cli/ArtifactFetchOptions.java b/flink-clients/src/main/java/org/apache/flink/client/cli/ArtifactFetchOptions.java
@@ -18,6 +18,7 @@
 
 package org.apache.flink.client.cli;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.configuration.ConfigOption;
 import org.apache.flink.configuration.ConfigOptions;
 
@@ -27,6 +28,7 @@
 import static org.apache.flink.configuration.ConfigOptions.key;
 
 /** Artifact Fetch options. */
+@PublicEvolving
 public class ArtifactFetchOptions {
 
     public static final ConfigOption<String> BASE_DIR =

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/AlgorithmOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/AlgorithmOptions.java
@@ -18,9 +18,12 @@
 
 package org.apache.flink.configuration;
 
+import org.apache.flink.annotation.PublicEvolving;
+
 import static org.apache.flink.configuration.ConfigOptions.key;
 
 /** Configuration parameters for join/sort algorithms. */
+@PublicEvolving
 public class AlgorithmOptions {
 
     public static final ConfigOption<Boolean> HASH_JOIN_BLOOM_FILTERS =

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/CheckpointingOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/CheckpointingOptions.java
@@ -19,11 +19,13 @@
 package org.apache.flink.configuration;
 
 import org.apache.flink.annotation.Experimental;
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.annotation.docs.Documentation;
 import org.apache.flink.configuration.description.Description;
 import org.apache.flink.configuration.description.TextElement;
 
 /** A collection of all configuration options that relate to checkpoints and savepoints. */
+@PublicEvolving
 public class CheckpointingOptions {
 
     // ------------------------------------------------------------------------

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java
@@ -18,6 +18,7 @@
 
 package org.apache.flink.configuration;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.annotation.docs.Documentation;
 import org.apache.flink.configuration.description.Description;
 import org.apache.flink.configuration.description.TextElement;
@@ -30,6 +31,7 @@
 import static org.apache.flink.configuration.description.TextElement.text;
 
 /** The set of configuration options relating to high-availability settings. */
+@PublicEvolving
 public class HighAvailabilityOptions {
 
     // ------------------------------------------------------------------------

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/RestOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/RestOptions.java
@@ -18,7 +18,7 @@
 
 package org.apache.flink.configuration;
 
-import org.apache.flink.annotation.Internal;
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.annotation.docs.Documentation;
 import org.apache.flink.configuration.description.Description;
 
@@ -29,7 +29,7 @@
 import static org.apache.flink.configuration.description.TextElement.text;
 
 /** Configuration parameters for REST communication. */
-@Internal
+@PublicEvolving
 public class RestOptions {
 
     private static final String REST_PORT_KEY = "rest.port";

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/SecurityOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/SecurityOptions.java
@@ -19,6 +19,7 @@
 package org.apache.flink.configuration;
 
 import org.apache.flink.annotation.Experimental;
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.annotation.docs.Documentation;
 import org.apache.flink.configuration.description.Description;
 import org.apache.flink.core.security.token.DelegationTokenProvider;
@@ -34,6 +35,7 @@
 import static org.apache.flink.util.Preconditions.checkNotNull;
 
 /** The set of configuration options relating to security. */
+@PublicEvolving
 public class SecurityOptions {
 
     public static final String DELEGATION_TOKEN_PROVIDER_PREFIX =

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/SlowTaskDetectorOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/SlowTaskDetectorOptions.java
@@ -18,13 +18,15 @@
 
 package org.apache.flink.configuration;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.annotation.docs.Documentation;
 
 import java.time.Duration;
 
 import static org.apache.flink.configuration.ConfigOptions.key;
 
 /** Configuration options to detect slow tasks. */
+@PublicEvolving
 public class SlowTaskDetectorOptions {
 
     @Documentation.Section(Documentation.Sections.EXPERT_SCHEDULING)

diff --git a/...libraries/flink-cep/src/main/java/org/apache/flink/cep/configuration/CEPCacheOptions.java b/...libraries/flink-cep/src/main/java/org/apache/flink/cep/configuration/CEPCacheOptions.java
@@ -18,13 +18,15 @@
 
 package org.apache.flink.cep.configuration;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.configuration.ConfigOption;
 import org.apache.flink.configuration.ConfigOptions;
 import org.apache.flink.util.TimeUtils;
 
 import java.time.Duration;
 
 /** CEP Cache Options. */
+@PublicEvolving
 public class CEPCacheOptions {
 
     private CEPCacheOptions() {}

diff --git a/...ics-influxdb/src/main/java/org/apache/flink/metrics/influxdb/InfluxdbReporterOptions.java b/...ics-influxdb/src/main/java/org/apache/flink/metrics/influxdb/InfluxdbReporterOptions.java
@@ -18,6 +18,7 @@
 
 package org.apache.flink.metrics.influxdb;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.annotation.docs.Documentation;
 import org.apache.flink.configuration.ConfigConstants;
 import org.apache.flink.configuration.ConfigOption;
@@ -29,6 +30,7 @@
 import org.influxdb.InfluxDB;
 
 /** Config options for {@link InfluxdbReporter}. */
+@PublicEvolving
 @Documentation.SuffixOption(ConfigConstants.METRICS_REPORTER_PREFIX + "influxdb")
 public class InfluxdbReporterOptions {
 

diff --git a/...c/main/java/org/apache/flink/metrics/prometheus/PrometheusPushGatewayReporterOptions.java b/...c/main/java/org/apache/flink/metrics/prometheus/PrometheusPushGatewayReporterOptions.java
@@ -18,6 +18,7 @@
 
 package org.apache.flink.metrics.prometheus;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.annotation.docs.Documentation;
 import org.apache.flink.configuration.ConfigConstants;
 import org.apache.flink.configuration.ConfigOption;
@@ -27,6 +28,7 @@
 import org.apache.flink.configuration.description.TextElement;
 
 /** Config options for the {@link PrometheusPushGatewayReporter}. */
+@PublicEvolving
 @Documentation.SuffixOption(ConfigConstants.METRICS_REPORTER_PREFIX + "prometheus")
 public class PrometheusPushGatewayReporterOptions {
 

diff --git a/...untime/src/main/java/org/apache/flink/runtime/highavailability/JobResultStoreOptions.java b/...untime/src/main/java/org/apache/flink/runtime/highavailability/JobResultStoreOptions.java
@@ -18,6 +18,7 @@
 
 package org.apache.flink.runtime.highavailability;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.annotation.docs.Documentation;
 import org.apache.flink.configuration.ConfigOption;
 import org.apache.flink.configuration.ConfigOptions;
@@ -26,6 +27,7 @@
 import org.apache.flink.configuration.description.TextElement;
 
 /** The set of configuration options relating to the Job Result Store. */
+@PublicEvolving
 public class JobResultStoreOptions {
     @Documentation.Section(Documentation.Sections.COMMON_HIGH_AVAILABILITY_JOB_RESULT_STORE)
     public static final ConfigOption<String> STORAGE_PATH =

diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/shuffle/ShuffleServiceOptions.java b/flink-runtime/src/main/java/org/apache/flink/runtime/shuffle/ShuffleServiceOptions.java
@@ -18,10 +18,12 @@
 
 package org.apache.flink.runtime.shuffle;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.configuration.ConfigOption;
 import org.apache.flink.configuration.ConfigOptions;
 
 /** Options to configure shuffle service. */
+@PublicEvolving
 @SuppressWarnings("WeakerAccess")
 public class ShuffleServiceOptions {
 

diff --git a/...flink-sql-client/src/main/java/org/apache/flink/table/client/config/SqlClientOptions.java b/...flink-sql-client/src/main/java/org/apache/flink/table/client/config/SqlClientOptions.java
@@ -18,13 +18,15 @@
 
 package org.apache.flink.table.client.config;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.annotation.docs.Documentation;
 import org.apache.flink.configuration.ConfigOption;
 import org.apache.flink.configuration.ConfigOptions;
 import org.apache.flink.table.api.config.TableConfigOptions;
 import org.apache.flink.table.client.cli.parser.SyntaxHighlightStyle;
 
 /** Options used in sql client. */
+@PublicEvolving
 public class SqlClientOptions {
     private SqlClientOptions() {}
 

diff --git a/flink-yarn/src/main/java/org/apache/flink/yarn/configuration/YarnConfigOptions.java b/flink-yarn/src/main/java/org/apache/flink/yarn/configuration/YarnConfigOptions.java
@@ -18,6 +18,7 @@
 
 package org.apache.flink.yarn.configuration;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.configuration.ConfigOption;
 import org.apache.flink.configuration.DescribedEnum;
 import org.apache.flink.configuration.ExternalResourceOptions;
@@ -38,6 +39,7 @@
  *
  * <p>These options are not expected to be ever configured by users explicitly.
  */
+@PublicEvolving
 public class YarnConfigOptions {
 
     /** The vcores used by YARN application master. */