Update docs + AdditionalMetadata use builder + change all name methods to just name.

alextwoods · alextwoods · commit d5097c46dcba · 2025-06-11T12:13:37.000-07:00
diff --git a/core/aws-core/src/main/java/software/amazon/awssdk/awscore/internal/AwsExecutionContextBuilder.java b/core/aws-core/src/main/java/software/amazon/awssdk/awscore/internal/AwsExecutionContextBuilder.java
@@ -51,8 +51,8 @@
 import software.amazon.awssdk.core.internal.InternalCoreExecutionAttribute;
 import software.amazon.awssdk.core.internal.util.HttpChecksumResolver;
 import software.amazon.awssdk.core.signer.Signer;
+import software.amazon.awssdk.core.useragent.AdditionalMetadata;
 import software.amazon.awssdk.core.useragent.BusinessMetricCollection;
-import software.amazon.awssdk.core.useragent.UserAgentMetadata;
 import software.amazon.awssdk.endpoints.EndpointProvider;
 import software.amazon.awssdk.http.auth.scheme.NoAuthAuthScheme;
 import software.amazon.awssdk.http.auth.spi.scheme.AuthScheme;
@@ -175,34 +175,39 @@ private AwsExecutionContextBuilder() {
 
     private static <InputT extends SdkRequest, OutputT extends SdkResponse> void putStreamingInputOutputTypesMetadata(
         ExecutionAttributes executionAttributes, ClientExecutionParams<InputT, OutputT> executionParams) {
-        List<UserAgentMetadata> userAgentMetadata = new ArrayList<>();
+        List<AdditionalMetadata> userAgentMetadata = new ArrayList<>();
 
         if (executionParams.getRequestBody() != null) {
-            userAgentMetadata.add(new UserAgentMetadata(
-                "RequestBody",
-                executionParams.getRequestBody().contentStreamProvider().streamName()
-            ));
+            userAgentMetadata.add(AdditionalMetadata
+                                      .builder()
+                                      .name("rb")
+                                      .value(executionParams.getRequestBody().contentStreamProvider().name())
+                                      .build());
         }
 
         if (executionParams.getAsyncRequestBody() != null) {
-            userAgentMetadata.add(new UserAgentMetadata(
-                "AsyncRequestBody",
-                executionParams.getAsyncRequestBody().bodyName()
-            ));
+            userAgentMetadata.add(AdditionalMetadata
+                                      .builder()
+                                      .name("rb")
+                                      .value(executionParams.getAsyncRequestBody().body())
+                                      .build());
         }
 
         if (executionParams.getResponseTransformer() != null) {
-            userAgentMetadata.add(new UserAgentMetadata(
-                "ResponseTransformer",
-                executionParams.getResponseTransformer().transformerName()
-            ));
+            userAgentMetadata.add(AdditionalMetadata
+                                      .builder()
+                                      .name("rt")
+                                      .value(executionParams.getResponseTransformer().name())
+                                      .build());
         }
 
         if (executionParams.getAsyncResponseTransformer() != null) {
-            userAgentMetadata.add(new UserAgentMetadata(
-                "AsyncResponseTransformer",
-                executionParams.getAsyncResponseTransformer().transformerName()
-            ));
+            userAgentMetadata.add(AdditionalMetadata
+                                      .builder()
+                                      .name("rt")
+                                      .value(executionParams.getAsyncResponseTransformer().name())
+                                      .build());
+
         }
 
         executionAttributes.putAttribute(SdkInternalExecutionAttribute.USER_AGENT_METADATA, userAgentMetadata);
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/AsyncRequestBody.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/AsyncRequestBody.java
@@ -80,7 +80,7 @@ default String contentType() {
      *
      * @return String containing the identifying name of this AsyncRequestBody implementation.
      */
-    default String bodyName() {
+    default String body() {
         return "UNKNOWN";
     }
 
@@ -108,7 +108,7 @@ public void subscribe(Subscriber<? super ByteBuffer> s) {
             }
 
             @Override
-            public String bodyName() {
+            public String body() {
                 return "Publisher";
             }
         };
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/AsyncResponseTransformer.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/AsyncResponseTransformer.java
@@ -164,7 +164,7 @@ default SplitResult<ResponseT, ResultT> split(Consumer<SplittingTransformerConfi
      *
      * @return String containing the identifying name of this AsyncRequestTransformer.
      */
-    default String transformerName() {
+    default String name() {
         return "UNKNOWN";
     }
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/BlockingInputStreamAsyncRequestBody.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/BlockingInputStreamAsyncRequestBody.java
@@ -121,7 +121,7 @@ public void subscribe(Subscriber<? super ByteBuffer> s) {
     }
 
     @Override
-    public String bodyName() {
+    public String body() {
         return "Stream";
     }
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/BlockingOutputStreamAsyncRequestBody.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/BlockingOutputStreamAsyncRequestBody.java
@@ -93,7 +93,7 @@ public void subscribe(Subscriber<? super ByteBuffer> s) {
     }
 
     @Override
-    public String bodyName() {
+    public String body() {
         return "Stream";
     }
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/listener/AsyncResponseTransformerListener.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/async/listener/AsyncResponseTransformerListener.java
@@ -104,8 +104,8 @@ public void exceptionOccurred(Throwable error) {
         }
 
         @Override
-        public String transformerName() {
-            return delegate.transformerName();
+        public String name() {
+            return delegate.name();
         }
 
         static void invoke(Runnable runnable, String callbackName) {
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/interceptor/SdkInternalExecutionAttribute.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/interceptor/SdkInternalExecutionAttribute.java
@@ -29,8 +29,8 @@
 import software.amazon.awssdk.core.interceptor.trait.HttpChecksum;
 import software.amazon.awssdk.core.interceptor.trait.HttpChecksumRequired;
 import software.amazon.awssdk.core.internal.interceptor.trait.RequestCompression;
+import software.amazon.awssdk.core.useragent.AdditionalMetadata;
 import software.amazon.awssdk.core.useragent.BusinessMetricCollection;
-import software.amazon.awssdk.core.useragent.UserAgentMetadata;
 import software.amazon.awssdk.endpoints.Endpoint;
 import software.amazon.awssdk.endpoints.EndpointProvider;
 import software.amazon.awssdk.http.SdkHttpExecutionAttributes;
@@ -57,7 +57,10 @@ public final class SdkInternalExecutionAttribute extends SdkExecutionAttribute {
     public static final ExecutionAttribute<BusinessMetricCollection> BUSINESS_METRICS =
         new ExecutionAttribute<>("BusinessMetricsCollection");
 
-    public static final ExecutionAttribute<List<UserAgentMetadata>> USER_AGENT_METADATA =
+    /**
+     * A collection of metadata to be added to the UserAgent.
+     */
+    public static final ExecutionAttribute<List<AdditionalMetadata>> USER_AGENT_METADATA =
         new ExecutionAttribute<>("UserAgentMetadata");
 
     /**
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/ByteArrayAsyncResponseTransformer.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/ByteArrayAsyncResponseTransformer.java
@@ -66,7 +66,7 @@ public void exceptionOccurred(Throwable throwable) {
     }
 
     @Override
-    public String transformerName() {
+    public String name() {
         return "Bytes";
     }
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/ByteBuffersAsyncRequestBody.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/ByteBuffersAsyncRequestBody.java
@@ -119,7 +119,7 @@ public void cancel() {
     }
 
     @Override
-    public String bodyName() {
+    public String body() {
         return "Bytes";
     }
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/FileAsyncRequestBody.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/FileAsyncRequestBody.java
@@ -142,7 +142,7 @@ public void subscribe(Subscriber<? super ByteBuffer> s) {
     }
 
     @Override
-    public String bodyName() {
+    public String body() {
         return "File";
     }
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/FileAsyncResponseTransformer.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/FileAsyncResponseTransformer.java
@@ -170,7 +170,7 @@ public void exceptionOccurred(Throwable throwable) {
     }
 
     @Override
-    public String transformerName() {
+    public String name() {
         return "File";
     }
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/InputStreamResponseTransformer.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/InputStreamResponseTransformer.java
@@ -61,7 +61,7 @@ public void exceptionOccurred(Throwable error) {
     }
 
     @Override
-    public String transformerName() {
+    public String name() {
         return "Stream";
     }
 }
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/InputStreamWithExecutorAsyncRequestBody.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/InputStreamWithExecutorAsyncRequestBody.java
@@ -87,7 +87,7 @@ public void subscribe(Subscriber<? super ByteBuffer> s) {
     }
 
     @Override
-    public String bodyName() {
+    public String body() {
         return "Stream";
     }
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/PublisherAsyncResponseTransformer.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/async/PublisherAsyncResponseTransformer.java
@@ -59,7 +59,7 @@ public void exceptionOccurred(Throwable error) {
     }
 
     @Override
-    public String transformerName() {
+    public String name() {
         return "Publisher";
     }
 }
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/http/pipeline/stages/ApplyUserAgentStage.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/http/pipeline/stages/ApplyUserAgentStage.java
@@ -41,8 +41,8 @@
 import software.amazon.awssdk.core.internal.http.RequestExecutionContext;
 import software.amazon.awssdk.core.internal.http.pipeline.MutableRequestToRequestPipeline;
 import software.amazon.awssdk.core.internal.useragent.IdentityProviderNameMapping;
+import software.amazon.awssdk.core.useragent.AdditionalMetadata;
 import software.amazon.awssdk.core.useragent.BusinessMetricCollection;
-import software.amazon.awssdk.core.useragent.UserAgentMetadata;
 import software.amazon.awssdk.http.SdkHttpFullRequest;
 import software.amazon.awssdk.identity.spi.Identity;
 import software.amazon.awssdk.utils.CollectionUtils;
@@ -112,7 +112,7 @@ private String finalizeUserAgent(RequestExecutionContext context) {
         javaUserAgent.append(clientUserAgent);
 
         //add useragent metadata from execution context
-        List<UserAgentMetadata> userAgentMetadata =
+        List<AdditionalMetadata> userAgentMetadata =
             context.executionAttributes().getAttribute(SdkInternalExecutionAttribute.USER_AGENT_METADATA);
         if (userAgentMetadata != null) {
             userAgentMetadata.forEach(s -> javaUserAgent.append(SPACE).append(s));
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/sync/BufferingContentStreamProvider.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/sync/BufferingContentStreamProvider.java
@@ -62,7 +62,7 @@ public InputStream newStream() {
     }
 
     @Override
-    public String streamName() {
+    public String name() {
         return "Buffering";
     }
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/sync/FileContentStreamProvider.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/sync/FileContentStreamProvider.java
@@ -43,7 +43,7 @@ public InputStream newStream() {
     }
 
     @Override
-    public String streamName() {
+    public String name() {
         return "File";
     }
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/sync/RequestBody.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/sync/RequestBody.java
@@ -147,7 +147,7 @@ public InputStream newStream() {
             }
 
             @Override
-            public String streamName() {
+            public String name() {
                 return "Stream";
             }
         };
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/sync/ResponseTransformer.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/sync/ResponseTransformer.java
@@ -99,7 +99,7 @@ default boolean needsConnectionLeftOpen() {
      *
      * @return String containing the identifying name of this RequestTransformer.
      */
-    default String transformerName() {
+    default String name() {
         return "UNKNOWN";
     }
 
@@ -146,7 +146,7 @@ public ResponseT transform(ResponseT response, AbortableInputStream inputStream)
             }
 
             @Override
-            public String transformerName() {
+            public String name() {
                 return "File";
             }
         };
@@ -193,7 +193,7 @@ public ResponseT transform(ResponseT response, AbortableInputStream inputStream)
             }
 
             @Override
-            public String transformerName() {
+            public String name() {
                 return "Stream";
             }
         };
@@ -219,7 +219,7 @@ public ResponseBytes<ResponseT> transform(ResponseT response, AbortableInputStre
             }
 
             @Override
-            public String transformerName() {
+            public String name() {
                 return "Bytes";
             }
         };
@@ -244,7 +244,7 @@ public ResponseInputStream<ResponseT> transform(ResponseT response, AbortableInp
             }
 
             @Override
-            public String transformerName() {
+            public String name() {
                 return "Stream";
             }
         });
@@ -274,8 +274,8 @@ public boolean needsConnectionLeftOpen() {
             }
 
             @Override
-            public String transformerName() {
-                return transformer.transformerName();
+            public String name() {
+                return transformer.name();
             }
         };
 
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/useragent/AdditionalMetadata.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/useragent/AdditionalMetadata.java
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/useragent/UserAgentMetadata.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/useragent/UserAgentMetadata.java
diff --git a/http-client-spi/src/main/java/software/amazon/awssdk/http/ContentStreamProvider.java b/http-client-spi/src/main/java/software/amazon/awssdk/http/ContentStreamProvider.java

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ default String contentType() {`
`80`	`80`	`*`
`81`	`81`	`* @return String containing the identifying name of this AsyncRequestBody implementation.`
`82`	`82`	`*/`
`83`		`- default String bodyName() {`
	`83`	`+ default String body() {`
`84`	`84`	`return "UNKNOWN";`
`85`	`85`	`}`
`86`	`86`
`@@ -108,7 +108,7 @@ public void subscribe(Subscriber<? super ByteBuffer> s) {`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`@Override`
`111`		`- public String bodyName() {`
	`111`	`+ public String body() {`
`112`	`112`	`return "Publisher";`
`113`	`113`	`}`
`114`	`114`	`};`
Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,7 @@ default SplitResult<ResponseT, ResultT> split(Consumer<SplittingTransformerConfi`
`164`	`164`	`*`
`165`	`165`	`* @return String containing the identifying name of this AsyncRequestTransformer.`
`166`	`166`	`*/`
`167`		`- default String transformerName() {`
	`167`	`+ default String name() {`
`168`	`168`	`return "UNKNOWN";`
`169`	`169`	`}`
`170`	`170`
Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ public void subscribe(Subscriber<? super ByteBuffer> s) {`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`@Override`
`124`		`- public String bodyName() {`
	`124`	`+ public String body() {`
`125`	`125`	`return "Stream";`
`126`	`126`	`}`
`127`	`127`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ public void subscribe(Subscriber<? super ByteBuffer> s) {`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`@Override`
`96`		`- public String bodyName() {`
	`96`	`+ public String body() {`
`97`	`97`	`return "Stream";`
`98`	`98`	`}`
`99`	`99`
Original file line number	Diff line number	Diff line change
`@@ -104,8 +104,8 @@ public void exceptionOccurred(Throwable error) {`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`@Override`
`107`		`- public String transformerName() {`
`108`		`- return delegate.transformerName();`
	`107`	`+ public String name() {`
	`108`	`+ return delegate.name();`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`static void invoke(Runnable runnable, String callbackName) {`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public void exceptionOccurred(Throwable throwable) {`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`@Override`
`69`		`- public String transformerName() {`
	`69`	`+ public String name() {`
`70`	`70`	`return "Bytes";`
`71`	`71`	`}`
`72`	`72`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ public void cancel() {`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`@Override`
`122`		`- public String bodyName() {`
	`122`	`+ public String body() {`
`123`	`123`	`return "Bytes";`
`124`	`124`	`}`
`125`	`125`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ public void subscribe(Subscriber<? super ByteBuffer> s) {`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`@Override`
`145`		`- public String bodyName() {`
	`145`	`+ public String body() {`
`146`	`146`	`return "File";`
`147`	`147`	`}`
`148`	`148`