Class MultipartConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.s3.multipart.MultipartConfiguration
-
- All Implemented Interfaces:
ToCopyableBuilder<MultipartConfiguration.Builder,MultipartConfiguration>
@SdkPublicApi public final class MultipartConfiguration extends Object implements ToCopyableBuilder<MultipartConfiguration.Builder,MultipartConfiguration>
Class that holds configuration properties related to multipart operations for aS3AsyncClient. Passing this class to theS3AsyncClientBuilder.multipartConfiguration(MultipartConfiguration)will enable automatic conversion of the following operations to their respective multipart variants:S3AsyncClient.getObject(GetObjectRequest, AsyncResponseTransformer),S3AsyncClient.putObject(PutObjectRequest, AsyncRequestBody)S3AsyncClient.copyObject(CopyObjectRequest)
Note that multipart download fetches individual parts of the object using
PartNumber. This means the S3 client will only download multiple parts if the object itself was uploaded as amultipart objectWhen performing multipart download, retry is only supported when using an
AsyncResponseTransformerimplementation that downloads the object into memory such, asAsyncResponseTransformer.toBytes()
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceMultipartConfiguration.BuilderBuilder for aMultipartConfiguration.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description LongapiCallBufferSizeInBytes()The maximum memory, in bytes, that the SDK will use to buffer requests content into memory.static MultipartConfiguration.Builderbuilder()LongminimumPartSizeInBytes()Indicated the size, in bytes, of each individual part of the part requests.LongthresholdInBytes()Indicates the value of the configured threshold, in bytes.MultipartConfiguration.BuildertoBuilder()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
builder
public static MultipartConfiguration.Builder builder()
-
toBuilder
public MultipartConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<MultipartConfiguration.Builder,MultipartConfiguration>
-
thresholdInBytes
public Long thresholdInBytes()
Indicates the value of the configured threshold, in bytes. Any request whose size is less than the configured value will not use multipart operation- Returns:
- the value of the configured threshold.
-
minimumPartSizeInBytes
public Long minimumPartSizeInBytes()
Indicated the size, in bytes, of each individual part of the part requests. The actual part size used might be bigger to conforms to the maximum number of parts allowed per multipart requests.- Returns:
- the value of the configured part size.
-
apiCallBufferSizeInBytes
public Long apiCallBufferSizeInBytes()
The maximum memory, in bytes, that the SDK will use to buffer requests content into memory.This setting does not apply if you are using an
AsyncResponseTransformerimplementation that downloads the object into memory such asAsyncResponseTransformer.toBytes()- Returns:
- the value of the configured maximum memory usage.
-
-