Skip to content

Commit 532a185

Browse files
zoewanggzoewangg
authored
Rename S3TransferManager.build().maxDepth to uploadDirectoryMaxDepth, rename S3TransferManager.builder().s3AsyncClient to .s3Client (#3584)
1 parent b46b71d commit 532a185

File tree

9 files changed

+40
-56
lines changed

9 files changed

+40
-56
lines changed

‎.changes/next-release/removal-AmazonS3TransferManager-68fc4a5.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"type": "removal",
33
"category": "Amazon S3 Transfer Manager",
44
"contributor": "",
5-
"description": "Remove UploadDirectoryRequest's override configuration's `recursive` option. The same functionality can be achieved with `maxDepth(1)`."
5+
"description": "Remove UploadDirectoryRequest's override configuration's `recursive` option. The same functionality can be achieved with `UploadDirectoryRequest.builder().maxDepth(1)` or S3TransferManager.builder().maxUploadDirectoryDepth(1)."
66
}

‎services-custom/s3-transfer-manager/src/it/java/software/amazon/awssdk/transfer/s3/S3IntegrationTestBase.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public static void setUpForAllIntegTests() throws Exception {
7272
.region(DEFAULT_REGION)
7373
.build();
7474
tm = S3TransferManager.builder()
75-
.s3AsyncClient(s3CrtAsync)
75+
.s3Client(s3CrtAsync)
7676
.build();
7777
}
7878

‎services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/S3TransferManager.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ default Upload upload(Consumer<UploadRequest.Builder> request) {
253253
* recursively, and symbolic links are not followed automatically.
254254
* This behavior can be configured in at request level via
255255
* {@link UploadDirectoryRequest.Builder#followSymbolicLinks(Boolean)} } or
256-
* client level via {@link S3TransferManager.Builder#followSymbolicLinks(Boolean)}}
256+
* client level via {@link S3TransferManager.Builder#uploadDirectoryFollowSymbolicLinks(Boolean)}}
257257
* Note that request-level configuration takes precedence over client-level configuration.
258258
* <p>
259259
* By default, the prefix is an empty string and the delimiter is {@code "/"}. Assume you have a local
@@ -450,7 +450,7 @@ interface Builder {
450450
* @return Returns a reference to this object so that method calls can be chained together.
451451
* @see S3AsyncClient#crtBuilder()
452452
*/
453-
Builder s3AsyncClient(S3AsyncClient s3AsyncClient);
453+
Builder s3Client(S3AsyncClient s3AsyncClient);
454454

455455
/**
456456
* Specify the executor that {@link S3TransferManager} will use to execute background tasks before handing them off to the
@@ -472,27 +472,27 @@ interface Builder {
472472

473473
/**
474474
* Specify whether to follow symbolic links when traversing the file tree in
475-
* {@link S3TransferManager#downloadDirectory} operation
475+
* {@link S3TransferManager#uploadDirectory} operation
476476
* <p>
477477
* Default to false
478478
*
479-
* @param followSymbolicLinks whether to follow symbolic links
479+
* @param uploadDirectoryFollowSymbolicLinks whether to follow symbolic links
480480
* @return This builder for method chaining.
481481
*/
482-
Builder followSymbolicLinks(Boolean followSymbolicLinks);
482+
Builder uploadDirectoryFollowSymbolicLinks(Boolean uploadDirectoryFollowSymbolicLinks);
483483

484484
/**
485-
* Specify the maximum number of levels of directories to visit in {@link S3TransferManager#downloadDirectory} operation.
485+
* Specify the maximum number of levels of directories to visit in {@link S3TransferManager#uploadDirectory} operation.
486486
* Must be positive. 1 means only the files directly within
487487
* the provided source directory are visited.
488488
*
489489
* <p>
490490
* Default to {@code Integer.MAX_VALUE}
491491
*
492-
* @param maxDepth the maximum number of directory levels to visit
492+
* @param uploadDirectoryMaxDepth the maximum number of directory levels to visit
493493
* @return This builder for method chaining.
494494
*/
495-
Builder maxDepth(Integer maxDepth);
495+
Builder uploadDirectoryMaxDepth(Integer uploadDirectoryMaxDepth);
496496

497497
/**
498498
* Build an instance of {@link S3TransferManager} based on the settings supplied to this builder

‎services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/internal/DefaultS3TransferManager.java

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ private S3AsyncClient initializeS3CrtClient(DefaultBuilder tmBuilder) {
133133

134134
private static TransferManagerConfiguration resolveTransferManagerConfiguration(DefaultBuilder tmBuilder) {
135135
TransferManagerConfiguration.Builder transferConfigBuilder = TransferManagerConfiguration.builder();
136-
transferConfigBuilder.followSymbolicLinks(tmBuilder.followSymbolicLinks);
137-
transferConfigBuilder.maxDepth(tmBuilder.maxDepth);
136+
transferConfigBuilder.uploadDirectoryFollowSymbolicLinks(tmBuilder.uploadDirectoryFollowSymbolicLinks);
137+
transferConfigBuilder.uploadDirectoryMaxDepth(tmBuilder.uploadDirectoryMaxDepth);
138138
transferConfigBuilder.executor(tmBuilder.executor);
139139
return transferConfigBuilder.build();
140140
}
@@ -577,14 +577,14 @@ private static boolean isMrapArn(Arn arn) {
577577
private static final class DefaultBuilder implements S3TransferManager.Builder {
578578
private S3AsyncClient s3AsyncClient;
579579
private Executor executor;
580-
private Boolean followSymbolicLinks;
581-
private Integer maxDepth;
580+
private Boolean uploadDirectoryFollowSymbolicLinks;
581+
private Integer uploadDirectoryMaxDepth;
582582

583583
private DefaultBuilder() {
584584
}
585585

586586
@Override
587-
public Builder s3AsyncClient(S3AsyncClient s3AsyncClient) {
587+
public Builder s3Client(S3AsyncClient s3AsyncClient) {
588588
this.s3AsyncClient = s3AsyncClient;
589589
return this;
590590
}
@@ -596,31 +596,31 @@ public Builder executor(Executor executor) {
596596
}
597597

598598
@Override
599-
public Builder followSymbolicLinks(Boolean followSymbolicLinks) {
600-
this.followSymbolicLinks = followSymbolicLinks;
599+
public Builder uploadDirectoryFollowSymbolicLinks(Boolean uploadDirectoryFollowSymbolicLinks) {
600+
this.uploadDirectoryFollowSymbolicLinks = uploadDirectoryFollowSymbolicLinks;
601601
return this;
602602
}
603603

604-
public void setFollowSymbolicLinks(Boolean followSymbolicLinks) {
605-
followSymbolicLinks(followSymbolicLinks);
604+
public void setUploadDirectoryFollowSymbolicLinks(Boolean followSymbolicLinks) {
605+
uploadDirectoryFollowSymbolicLinks(followSymbolicLinks);
606606
}
607607

608-
public Boolean getFollowSymbolicLinks() {
609-
return followSymbolicLinks;
608+
public Boolean getUploadDirectoryFollowSymbolicLinks() {
609+
return uploadDirectoryFollowSymbolicLinks;
610610
}
611611

612612
@Override
613-
public Builder maxDepth(Integer maxDepth) {
614-
this.maxDepth = maxDepth;
613+
public Builder uploadDirectoryMaxDepth(Integer uploadDirectoryMaxDepth) {
614+
this.uploadDirectoryMaxDepth = uploadDirectoryMaxDepth;
615615
return this;
616616
}
617617

618-
public void setMaxDepth(Integer maxDepth) {
619-
maxDepth(maxDepth);
618+
public void setUploadDirectoryMaxDepth(Integer uploadDirectoryMaxDepth) {
619+
uploadDirectoryMaxDepth(uploadDirectoryMaxDepth);
620620
}
621621

622-
public Integer getMaxDepth() {
623-
return maxDepth;
622+
public Integer getUploadDirectoryMaxDepth() {
623+
return uploadDirectoryMaxDepth;
624624
}
625625

626626
@Override

‎services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/internal/TransferManagerConfiguration.java

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ public class TransferManagerConfiguration implements SdkAutoCloseable {
4141

4242
private TransferManagerConfiguration(Builder builder) {
4343
AttributeMap.Builder standardOptions = AttributeMap.builder();
44-
standardOptions.put(UPLOAD_DIRECTORY_FOLLOW_SYMBOLIC_LINKS, builder.followSymbolicLinks);
45-
standardOptions.put(UPLOAD_DIRECTORY_MAX_DEPTH, builder.maxDepth);
44+
standardOptions.put(UPLOAD_DIRECTORY_FOLLOW_SYMBOLIC_LINKS, builder.uploadDirectoryFollowSymbolicLinks);
45+
standardOptions.put(UPLOAD_DIRECTORY_MAX_DEPTH, builder.uploadDirectoryMaxDepth);
4646
finalizeExecutor(builder, standardOptions);
4747
options = standardOptions.build().merge(TRANSFER_MANAGER_DEFAULTS);
4848
}
@@ -97,37 +97,21 @@ public static Builder builder() {
9797

9898
public static final class Builder {
9999

100-
private Boolean followSymbolicLinks;
101-
private Integer maxDepth;
100+
private Boolean uploadDirectoryFollowSymbolicLinks;
101+
private Integer uploadDirectoryMaxDepth;
102102
private Executor executor;
103103

104104

105-
public Builder followSymbolicLinks(Boolean followSymbolicLinks) {
106-
this.followSymbolicLinks = followSymbolicLinks;
105+
public Builder uploadDirectoryFollowSymbolicLinks(Boolean uploadDirectoryFollowSymbolicLinks) {
106+
this.uploadDirectoryFollowSymbolicLinks = uploadDirectoryFollowSymbolicLinks;
107107
return this;
108108
}
109109

110-
public void setFollowSymbolicLinks(Boolean followSymbolicLinks) {
111-
followSymbolicLinks(followSymbolicLinks);
112-
}
113-
114-
public Boolean getFollowSymbolicLinks() {
115-
return followSymbolicLinks;
116-
}
117-
118-
public Builder maxDepth(Integer maxDepth) {
119-
this.maxDepth = maxDepth;
110+
public Builder uploadDirectoryMaxDepth(Integer uploadDirectoryMaxDepth) {
111+
this.uploadDirectoryMaxDepth = uploadDirectoryMaxDepth;
120112
return this;
121113
}
122114

123-
public void setMaxDepth(Integer maxDepth) {
124-
maxDepth(maxDepth);
125-
}
126-
127-
public Integer getMaxDepth() {
128-
return maxDepth;
129-
}
130-
131115
public Builder executor(Executor executor) {
132116
this.executor = executor;
133117
return this;

‎services-custom/s3-transfer-manager/src/test/java/software/amazon/awssdk/transfer/s3/internal/S3TransferManagerTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ void close_shouldCloseUnderlyingResources() {
344344
@Test
345345
void close_shouldNotCloseCloseS3AsyncClientPassedInBuilder_when_transferManagerClosed() {
346346
S3TransferManager transferManager =
347-
DefaultS3TransferManager.builder().s3AsyncClient(mockS3Crt).build();
347+
DefaultS3TransferManager.builder().s3Client(mockS3Crt).build();
348348
transferManager.close();
349349
verify(mockS3Crt, times(0)).close();
350350
}

‎services-custom/s3-transfer-manager/src/test/java/software/amazon/awssdk/transfer/s3/internal/TransferManagerConfigurationTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public class TransferManagerConfigurationTest {
3434
@Test
3535
public void resolveMaxDepth_requestOverride_requestOverrideShouldTakePrecedence() {
3636
transferManagerConfiguration = TransferManagerConfiguration.builder()
37-
.maxDepth(1)
37+
.uploadDirectoryMaxDepth(1)
3838
.build();
3939
UploadDirectoryRequest uploadDirectoryRequest = UploadDirectoryRequest.builder()
4040
.bucket("bucket")
@@ -47,7 +47,7 @@ public void resolveMaxDepth_requestOverride_requestOverrideShouldTakePrecedence(
4747
@Test
4848
public void resolveFollowSymlinks_requestOverride_requestOverrideShouldTakePrecedence() {
4949
transferManagerConfiguration = TransferManagerConfiguration.builder()
50-
.followSymbolicLinks(false)
50+
.uploadDirectoryFollowSymbolicLinks(false)
5151
.build();
5252
UploadDirectoryRequest uploadDirectoryRequest = UploadDirectoryRequest.builder()
5353
.bucket("bucket")

‎services-custom/s3-transfer-manager/src/test/java/software/amazon/awssdk/transfer/s3/samples/S3TransferManagerSamples.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public void customClient() {
7171

7272
S3TransferManager transferManager =
7373
S3TransferManager.builder()
74-
.s3AsyncClient(s3AsyncClient)
74+
.s3Client(s3AsyncClient)
7575
.build();
7676
// @end region=customTM
7777
}

‎test/s3-benchmarks/src/main/java/software/amazon/awssdk/s3benchmarks/BaseTransferManagerBenchmark.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public abstract class BaseTransferManagerBenchmark implements TransferManagerBen
6868
s3Sync = S3Client.builder()
6969
.build();
7070
transferManager = S3TransferManager.builder()
71-
.s3AsyncClient(s3)
71+
.s3Client(s3)
7272
.build();
7373
bucket = config.bucket();
7474
key = config.key();

0 commit comments

Comments
 (0)