Update javadocs

Author: davidh44

services/s3/src/main/java/software/amazon/awssdk/services/s3/multipart/MultipartConfiguration.java

@@ -18,6 +18,7 @@
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.core.async.AsyncRequestBody;
 import software.amazon.awssdk.core.async.AsyncResponseTransformer;
+import software.amazon.awssdk.core.internal.async.ByteArrayAsyncResponseTransformer;
 import software.amazon.awssdk.services.s3.S3AsyncClient;
 import software.amazon.awssdk.services.s3.S3AsyncClientBuilder;
 import software.amazon.awssdk.services.s3.model.CopyObjectRequest;
@@ -28,15 +29,21 @@
 import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
 
 /**
- * Class that hold configuration properties related to multipart operation for a {@link S3AsyncClient}. Passing this class to the
- * {@link S3AsyncClientBuilder#multipartConfiguration(MultipartConfiguration)} will enable automatic conversion of
- * {@link S3AsyncClient#getObject(GetObjectRequest, AsyncResponseTransformer)},
- * {@link S3AsyncClient#putObject(PutObjectRequest, AsyncRequestBody)} and
- * {@link S3AsyncClient#copyObject(CopyObjectRequest)} to their respective multipart operation.
+ * Class that holds configuration properties related to multipart operations for a {@link S3AsyncClient}. Passing this class to
+ * the {@link S3AsyncClientBuilder#multipartConfiguration(MultipartConfiguration)} will enable automatic conversion of the
+ * following operations to their respective multipart variants:
+ * <ul>
+ * <li>{@link S3AsyncClient#getObject(GetObjectRequest, AsyncResponseTransformer)},
+ * <li>{@link S3AsyncClient#putObject(PutObjectRequest, AsyncRequestBody)}
+ * <li>{@link S3AsyncClient#copyObject(CopyObjectRequest)}
+ * </ul>
  * <p>
- * Note that multipart download fetch individual part of the object using {@link GetObjectRequest#partNumber() part number}, this
- * means it will only download multiple parts if the
- * object itself was uploaded as a {@link S3AsyncClient#createMultipartUpload(CreateMultipartUploadRequest) multipart object}
+ * Note that multipart download fetches individual parts of the object using {@link GetObjectRequest#partNumber() PartNumber}.
+ * This means the S3 client will only download multiple parts if the object itself was uploaded as a
+ * {@link S3AsyncClient#createMultipartUpload(CreateMultipartUploadRequest) multipart object}
+ * <p>
+ * When performing multipart download, retry is only supported for downloading to byte array, i.e., when providing a
+ * {@link ByteArrayAsyncResponseTransformer}
  */
 @SdkPublicApi
 public final class MultipartConfiguration implements ToCopyableBuilder<MultipartConfiguration.Builder, MultipartConfiguration> {
@@ -83,6 +90,10 @@ public Long minimumPartSizeInBytes() {
 
     /**
      * The maximum memory, in bytes, that the SDK will use to buffer requests content into memory.
+     * <p>
+     * This setting is not supported and will be ignored when downloading to a byte array, i.e., when providing a
+     * {@link ByteArrayAsyncResponseTransformer}.
+     *
      * @return the value of the configured maximum memory usage.
      */
     public Long apiCallBufferSizeInBytes() {
@@ -152,6 +163,9 @@ public interface Builder extends CopyableBuilder<Builder, MultipartConfiguration
          * Increasing this value may lead to better performance at the cost of using more memory.
          * <p>
          * Default value: If not specified, the SDK will use the equivalent of four parts worth of memory, so 32 Mib by default.
+         * <p>
+         * This setting is not supported and will be ignored when downloading to a byte array, i.e., when providing a
+         * {@link ByteArrayAsyncResponseTransformer}.
          *
          * @param apiCallBufferSizeInBytes the value of the maximum memory usage.
          * @return an instance of this builder.
@@ -170,20 +184,24 @@ private static class DefaultMultipartConfigBuilder implements Builder {
         private Long minimumPartSizeInBytes;
         private Long apiCallBufferSizeInBytes;
 
+        @Override
         public Builder thresholdInBytes(Long thresholdInBytes) {
             this.thresholdInBytes = thresholdInBytes;
             return this;
         }
 
+        @Override
         public Long thresholdInBytes() {
             return this.thresholdInBytes;
         }
 
+        @Override
         public Builder minimumPartSizeInBytes(Long minimumPartSizeInBytes) {
             this.minimumPartSizeInBytes = minimumPartSizeInBytes;
             return this;
         }
 
+        @Override
         public Long minimumPartSizeInBytes() {
             return this.minimumPartSizeInBytes;
         }

services/s3/src/main/resources/codegen-resources/customization.config

@@ -289,8 +289,8 @@
   "useS3ExpressSessionAuth": true,
   "multipartCustomization": {
     "multipartConfigurationClass": "software.amazon.awssdk.services.s3.multipart.MultipartConfiguration",
-    "multipartConfigMethodDoc": "Configuration for multipart operation of this client.",
-    "multipartEnableMethodDoc": "Enables automatic conversion of GET, PUT and COPY methods to their equivalent multipart operation. CRC32 checksum will be enabled for PUT, unless the checksum is specified or checksum validation is disabled.",
+    "multipartConfigMethodDoc": "Configuration for multipart operation of this client.<p>When performing multipart download, retry is only supported for downloading to byte array, i.e., when providing a {@code ByteArrayAsyncResponseTransformer}",
+    "multipartEnableMethodDoc": "Enables automatic conversion of GET, PUT and COPY methods to their equivalent multipart operation. CRC32 checksum will be enabled for PUT, unless the checksum is specified or checksum validation is disabled.<p>When performing multipart download, retry is only supported for downloading to byte array, i.e., when providing a {@code ByteArrayAsyncResponseTransformer}",
     "contextParamEnabledKey": "S3AsyncClientDecorator.MULTIPART_ENABLED_KEY",
     "contextParamConfigKey": "S3AsyncClientDecorator.MULTIPART_CONFIGURATION_KEY"
   },