Mark plugin API as preview (#4558)

aws · Oct 6, 2023 · f36f672 · f36f672
1 parent aa3e3ed
commit f36f672
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/RequestOverrideConfiguration.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/RequestOverrideConfiguration.java
@@ -26,6 +26,7 @@
 import java.util.TreeMap;
 import java.util.function.Consumer;
 import software.amazon.awssdk.annotations.Immutable;
+import software.amazon.awssdk.annotations.SdkPreviewApi;
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
 import software.amazon.awssdk.core.interceptor.ExecutionAttribute;
@@ -153,6 +154,7 @@ public List<MetricPublisher> metricPublishers() {
     /**
      * Return the plugins that will be used to update the configuration used by the request.
      */
+    @SdkPreviewApi
     public List<SdkPlugin> plugins() {
         return plugins;
     }
@@ -494,11 +496,13 @@ default B putRawQueryParameter(String name, String value) {
          *
          * @param plugin The plugin to add.
          */
+        @SdkPreviewApi
         B addPlugin(SdkPlugin plugin);
 
         /**
          * Returns the list of registered plugins
          */
+        @SdkPreviewApi
         List<SdkPlugin> plugins();
 
         /**

diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkPlugin.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkPlugin.java
@@ -15,6 +15,7 @@
 
 package software.amazon.awssdk.core;
 
+import software.amazon.awssdk.annotations.SdkPreviewApi;
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.utils.SdkAutoCloseable;
@@ -23,6 +24,7 @@
  * A plugin modifies a client's configuration when the client is created or at request execution
  * time.
  */
+@SdkPreviewApi
 @SdkPublicApi
 @ThreadSafe
 @FunctionalInterface

diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/client/builder/SdkClientBuilder.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/client/builder/SdkClientBuilder.java
@@ -18,6 +18,7 @@
 import java.net.URI;
 import java.util.List;
 import java.util.function.Consumer;
+import software.amazon.awssdk.annotations.SdkPreviewApi;
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.core.SdkPlugin;
 import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
@@ -82,13 +83,15 @@ default B putAuthScheme(AuthScheme<?> authScheme) {
      * Adds a plugin to the client builder. The plugins will be invoked when building the client to allow them to change the
      * configuration of the built client.
      */
+    @SdkPreviewApi
     default B addPlugin(SdkPlugin plugin) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Returns the list of  plugins configured on the client builder.
      */
+    @SdkPreviewApi
     default List<SdkPlugin> plugins() {
         throw new UnsupportedOperationException();
     }

diff --git a/...ore/src/main/java/software/amazon/awssdk/core/client/builder/SdkDefaultClientBuilder.java b/...ore/src/main/java/software/amazon/awssdk/core/client/builder/SdkDefaultClientBuilder.java
@@ -63,6 +63,7 @@
 import java.util.concurrent.ThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Supplier;
+import software.amazon.awssdk.annotations.SdkPreviewApi;
 import software.amazon.awssdk.annotations.SdkProtectedApi;
 import software.amazon.awssdk.annotations.SdkTestInternalApi;
 import software.amazon.awssdk.core.CompressionConfiguration;
@@ -409,6 +410,7 @@ private SdkClientConfiguration finalizeConfiguration(SdkClientConfiguration conf
      * By default, returns the configuration as-is. Classes extending this method will take care of running the plugins and
      * return the updated configuration if plugins are supported.
      */
+    @SdkPreviewApi
     protected SdkClientConfiguration invokePlugins(SdkClientConfiguration config) {
         return config;
     }