Skip to content

Commit 9bbf604

Browse files
authored
Improve docs for ParallelConfiguration (#6815)
1 parent 3e21c1b commit 9bbf604

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

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

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,13 @@
2222
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
2323

2424
/**
25-
* Class that holds configuration properties related to multipart operations for a {@link S3AsyncClient}, related specifically
26-
* to non-linear, parallel operations, that is, when the {@link AsyncResponseTransformer} supports non-serial split.
25+
* Configuration for parallel multipart operations performed by a {@link S3AsyncClient}.
26+
*
27+
* <p>For uploads (putObject), this configuration applies to all multipart uploads regardless of whether the content
28+
* length is known.
29+
*
30+
* <p>For downloads (getObject), this configuration applies only when the {@link AsyncResponseTransformer} supports
31+
* parallel split.
2732
*/
2833
@SdkPublicApi
2934
public class ParallelConfiguration implements ToCopyableBuilder<ParallelConfiguration.Builder, ParallelConfiguration> {
@@ -41,9 +46,11 @@ public static Builder builder() {
4146
/**
4247
* The maximum number of concurrent part requests that are allowed for multipart operations, including both multipart
4348
* download (GetObject) and multipart upload (PutObject). This limits the number of parts that can be in flight at any
44-
* given time, preventing the client from overwhelming the HTTP connection pool when transferring large objects. For
45-
* getObject it applies only when the {@link AsyncResponseTransformer} supports parallel split.
46-
* Defaults to 50.
49+
* given time, preventing the client from overwhelming the HTTP connection pool when transferring large objects.
50+
*
51+
* <p>For getObject it applies only when the {@link AsyncResponseTransformer} supports parallel split.
52+
*
53+
* <p>Defaults to 50.
4754
*
4855
* @return The value for the maximum number of concurrent part requests.
4956
*/

0 commit comments

Comments
 (0)