Skip to content

Commit 896fb11

Browse files
committed
Update CRT_MEMORY_BUFFER_DISABLED javadoc
1 parent ad8fa7c commit 896fb11

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

core/sdk-core/src/main/java/software/amazon/awssdk/core/client/config/SdkAdvancedAsyncClientOption.java

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,14 @@ public final class SdkAdvancedAsyncClientOption<T> extends ClientOption<T> {
5656
new SdkAdvancedAsyncClientOption<>(Executor.class);
5757

5858
/**
59-
* Advanced configuration for the native S3CrtAsyncClient which only applies for multipart uploads. When set to true,
60-
* the client will skip buffering the part in native memory before sending the request. Default to false on small objects,
61-
* and true when the object size exceed a certain threshold. When set to true, the client will also skip
62-
* buffering for small objects.
59+
* Advanced configuration for the native S3CrtAsyncClient, which only applies for file-based multipart uploads.
60+
* By default, the S3CrtAsyncClient will skip buffering parts in memory for large objects.
61+
* <p>
62+
* When set to false, the client will not buffer parts for large object, but will buffer parts for smaller objects .
63+
* When set to true, the client will skip buffering parts even for small objects.
64+
* Parts for large objects are never buffered.
65+
* <p>
66+
* Default to {@code false}.
6367
*/
6468
public static final SdkAdvancedAsyncClientOption<Boolean> CRT_MEMORY_BUFFER_DISABLED =
6569
new SdkAdvancedAsyncClientOption<>(Boolean.class);

0 commit comments

Comments
 (0)