Skip to content

Commit 961e069

Browse files
zoewanggzoewangg
committed
Various renaming
1 parent 6502313 commit 961e069

File tree

10 files changed

+68
-64
lines changed

10 files changed

+68
-64
lines changed

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public Path destination() {
7272
return destination;
7373
}
7474

75-
public GetObjectRequest toApiRequest() {
75+
public GetObjectRequest toGetObjectRequest() {
7676
return getObjectRequest;
7777
}
7878

@@ -88,14 +88,13 @@ public interface Builder extends TransferRequest.Builder<DownloadRequest, Builde
8888
*/
8989
Builder destination(Path destination);
9090

91-
9291
/**
93-
* The {@link GetObjectRequest} request
92+
* The {@link GetObjectRequest} request that should be used for the download
9493
*
9594
* @param getObjectRequest the getObject request
9695
* @return a reference to this object so that method calls can be chained together.
9796
*/
98-
Builder apiRequest(GetObjectRequest getObjectRequest);
97+
Builder getObjectRequest(GetObjectRequest getObjectRequest);
9998

10099
/**
101100
* @return The built request.
@@ -131,7 +130,7 @@ public Builder key(String key) {
131130
}
132131

133132
@Override
134-
public Builder apiRequest(GetObjectRequest getObjectRequest) {
133+
public Builder getObjectRequest(GetObjectRequest getObjectRequest) {
135134
this.getObjectRequest = getObjectRequest;
136135
return this;
137136
}

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ public final class S3ClientConfiguration implements ToCopyableBuilder<S3ClientCo
3434
private final AwsCredentialsProvider credentialsProvider;
3535
private final Region region;
3636
private final Long partSizeBytes;
37-
private final Double targetThroughputGbps;
37+
private final Double targetThroughputInGbps;
3838
private final Integer maxConcurrency;
3939

4040
private S3ClientConfiguration(DefaultBuilder builder) {
4141
this.credentialsProvider = builder.credentialsProvider;
4242
this.region = builder.region;
4343
this.partSizeBytes = builder.partSizeBytes;
44-
this.targetThroughputGbps = builder.targetThroughputGbps;
44+
this.targetThroughputInGbps = builder.targetThroughputInGbps;
4545
this.maxConcurrency = builder.maxConcurrency;
4646
}
4747

@@ -69,8 +69,8 @@ public Optional<Long> minimumPartSizeInBytes() {
6969
/**
7070
* @return the optional target throughput
7171
*/
72-
public Optional<Double> targetThroughputGbps() {
73-
return Optional.ofNullable(targetThroughputGbps);
72+
public Optional<Double> targetThroughputInGbps() {
73+
return Optional.ofNullable(targetThroughputInGbps);
7474
}
7575

7676
/**
@@ -135,10 +135,10 @@ public interface Builder extends CopyableBuilder<Builder, S3ClientConfiguration>
135135
* <p>
136136
* By default, it is 5Gbps
137137
*
138-
* @param targetThroughputGbps the target throughput Gbps
138+
* @param targetThroughputInGbps the target throughput in Gbps
139139
* @return this builder for method chaining.
140140
*/
141-
Builder targetThroughputGbps(Double targetThroughputGbps);
141+
Builder targetThroughputInGbps(Double targetThroughputInGbps);
142142

143143
/**
144144
* Specifies the maximum number of concurrent Amazon S3 transfer requests that can run at the same time.
@@ -153,7 +153,7 @@ private static final class DefaultBuilder implements Builder {
153153
private AwsCredentialsProvider credentialsProvider;
154154
private Region region;
155155
private Long partSizeBytes;
156-
private Double targetThroughputGbps;
156+
private Double targetThroughputInGbps;
157157
private Integer maxConcurrency;
158158

159159
private DefaultBuilder() {
@@ -163,7 +163,7 @@ private DefaultBuilder(S3ClientConfiguration configuration) {
163163
this.credentialsProvider = configuration.credentialsProvider;
164164
this.region = configuration.region;
165165
this.partSizeBytes = configuration.partSizeBytes;
166-
this.targetThroughputGbps = configuration.targetThroughputGbps;
166+
this.targetThroughputInGbps = configuration.targetThroughputInGbps;
167167
this.maxConcurrency = configuration.maxConcurrency;
168168
}
169169

@@ -186,8 +186,8 @@ public Builder minimumPartSizeInBytes(Long partSizeBytes) {
186186
}
187187

188188
@Override
189-
public Builder targetThroughputGbps(Double targetThroughputGbps) {
190-
this.targetThroughputGbps = targetThroughputGbps;
189+
public Builder targetThroughputInGbps(Double targetThroughputInGbps) {
190+
this.targetThroughputInGbps = targetThroughputInGbps;
191191
return this;
192192
}
193193

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

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,36 +27,36 @@
2727
*/
2828
@SdkPublicApi
2929
public final class UploadRequest implements TransferRequest, ToCopyableBuilder<UploadRequest.Builder, UploadRequest> {
30-
private final PutObjectRequest apiRequest;
30+
private final PutObjectRequest putObjectRequest;
3131
private final Path source;
3232

3333
private UploadRequest(BuilderImpl builder) {
3434
Validate.isTrue(bucketKeyPairProvided(builder) ^ apiRequestProvided(builder),
3535
"Exactly one of a bucket, key pair or API request must be provided.");
3636

3737
if (bucketKeyPairProvided(builder)) {
38-
this.apiRequest = PutObjectRequest.builder()
39-
.bucket(builder.bucket)
40-
.key(builder.key)
41-
.build();
38+
this.putObjectRequest = PutObjectRequest.builder()
39+
.bucket(builder.bucket)
40+
.key(builder.key)
41+
.build();
4242
} else {
43-
apiRequest = builder.apiRequest;
43+
putObjectRequest = builder.putObjectRequest;
4444
}
4545
this.source = builder.source;
4646
}
4747

4848
@Override
4949
public String bucket() {
50-
return apiRequest.bucket();
50+
return putObjectRequest.bucket();
5151
}
5252

5353
@Override
5454
public String key() {
55-
return apiRequest.key();
55+
return putObjectRequest.key();
5656
}
5757

58-
public PutObjectRequest toApiRequest() {
59-
return apiRequest;
58+
public PutObjectRequest toPutObjectRequest() {
59+
return putObjectRequest;
6060
}
6161

6262
/**
@@ -72,13 +72,12 @@ public static Builder builder() {
7272
return new BuilderImpl();
7373
}
7474

75-
7675
private static boolean bucketKeyPairProvided(BuilderImpl builder) {
7776
return builder.bucket != null && builder.key != null;
7877
}
7978

8079
private static boolean apiRequestProvided(BuilderImpl builder) {
81-
return builder.apiRequest != null;
80+
return builder.putObjectRequest != null;
8281
}
8382

8483
@Override
@@ -99,7 +98,13 @@ public interface Builder extends TransferRequest.Builder<UploadRequest, Builder>
9998
*/
10099
Builder source(Path source);
101100

102-
Builder apiRequest(PutObjectRequest apiRequest);
101+
/**
102+
* Configure the {@link PutObjectRequest} that should be used for the upload
103+
*
104+
* @param putObjectRequest the putObjectRequest
105+
* @return Returns a reference to this object so that method calls can be chained together.
106+
*/
107+
Builder putObjectRequest(PutObjectRequest putObjectRequest);
103108

104109
/**
105110
* @return The built request.
@@ -110,7 +115,7 @@ public interface Builder extends TransferRequest.Builder<UploadRequest, Builder>
110115
private static class BuilderImpl implements Builder {
111116
private String bucket;
112117
private String key;
113-
private PutObjectRequest apiRequest;
118+
private PutObjectRequest putObjectRequest;
114119
private Path source;
115120

116121
@Override
@@ -132,8 +137,8 @@ public Builder key(String key) {
132137
}
133138

134139
@Override
135-
public Builder apiRequest(PutObjectRequest apiRequest) {
136-
this.apiRequest = apiRequest;
140+
public Builder putObjectRequest(PutObjectRequest putObjectRequest) {
141+
this.putObjectRequest = putObjectRequest;
137142
return this;
138143
}
139144

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ public final class DefaultS3CrtAsyncClient implements S3CrtAsyncClient {
3838
public DefaultS3CrtAsyncClient(DefaultS3CrtClientBuilder builder) {
3939
S3NativeClientConfiguration.Builder configBuilder =
4040
S3NativeClientConfiguration.builder()
41-
.targetThroughputGbps(builder.targetThroughputGbps())
42-
.partSizeBytes(builder.partSizeBytes());
41+
.targetThroughputInGbps(builder.targetThroughputInGbps())
42+
.partSizeInBytes(builder.partSizeBytes());
4343
if (builder.region() != null) {
4444
configBuilder.signingRegion(builder.region().id());
4545
}
@@ -53,7 +53,7 @@ public DefaultS3CrtAsyncClient(DefaultS3CrtClientBuilder builder) {
5353
configuration.clientBootstrap(),
5454
configuration.credentialsProvider(),
5555
configuration.partSizeBytes(),
56-
configuration.targetThroughputGbps(),
56+
configuration.targetThroughputInGbps(),
5757
configuration.maxConcurrency());
5858
}
5959

@@ -115,7 +115,7 @@ public static final class DefaultS3CrtClientBuilder implements S3CrtAsyncClientB
115115
private AwsCredentialsProvider credentialsProvider;
116116
private Region region;
117117
private Long partSizeBytes;
118-
private Double targetThroughputGbps;
118+
private Double targetThroughputInGbps;
119119
private Integer maxConcurrency;
120120

121121
public AwsCredentialsProvider credentialsProvider() {
@@ -130,8 +130,8 @@ public Long partSizeBytes() {
130130
return partSizeBytes;
131131
}
132132

133-
public Double targetThroughputGbps() {
134-
return targetThroughputGbps;
133+
public Double targetThroughputInGbps() {
134+
return targetThroughputInGbps;
135135
}
136136

137137
public Integer maxConcurrency() {
@@ -157,8 +157,8 @@ public S3CrtAsyncClientBuilder minimumPartSizeInBytes(Long partSizeBytes) {
157157
}
158158

159159
@Override
160-
public S3CrtAsyncClientBuilder targetThroughputGbps(Double targetThroughputGbps) {
161-
this.targetThroughputGbps = targetThroughputGbps;
160+
public S3CrtAsyncClientBuilder targetThroughputInGbps(Double targetThroughputInGbps) {
161+
this.targetThroughputInGbps = targetThroughputInGbps;
162162
return this;
163163
}
164164

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public DefaultS3TransferManager(DefaultBuilder builder) {
4141
builder.s3ClientConfiguration.maxConcurrency().ifPresent(clientBuilder::maxConcurrency);
4242
builder.s3ClientConfiguration.minimumPartSizeInBytes().ifPresent(clientBuilder::minimumPartSizeInBytes);
4343
builder.s3ClientConfiguration.region().ifPresent(clientBuilder::region);
44-
builder.s3ClientConfiguration.targetThroughputGbps().ifPresent(clientBuilder::targetThroughputGbps);
44+
builder.s3ClientConfiguration.targetThroughputInGbps().ifPresent(clientBuilder::targetThroughputInGbps);
4545

4646
s3CrtAsyncClient = clientBuilder.build();
4747
}
@@ -53,7 +53,7 @@ public DefaultS3TransferManager(DefaultBuilder builder) {
5353

5454
@Override
5555
public Upload upload(UploadRequest uploadRequest) {
56-
PutObjectRequest putObjectRequest = uploadRequest.toApiRequest();
56+
PutObjectRequest putObjectRequest = uploadRequest.toPutObjectRequest();
5757
AsyncRequestBody requestBody = requestBodyFor(uploadRequest);
5858

5959
CompletableFuture<PutObjectResponse> putObjFuture = s3CrtAsyncClient.putObject(putObjectRequest, requestBody);
@@ -66,7 +66,7 @@ public Upload upload(UploadRequest uploadRequest) {
6666
@Override
6767
public Download download(DownloadRequest downloadRequest) {
6868
CompletableFuture<GetObjectResponse> future =
69-
s3CrtAsyncClient.getObject(downloadRequest.toApiRequest(),
69+
s3CrtAsyncClient.getObject(downloadRequest.toGetObjectRequest(),
7070
AsyncResponseTransformer.toFile(downloadRequest.destination()));
7171
return new DefaultDownload(future.thenApply(r -> DefaultCompletedDownload.builder().response(r).build()));
7272
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ interface S3CrtAsyncClientBuilder extends SdkBuilder<S3CrtAsyncClientBuilder, S3
3535

3636
S3CrtAsyncClientBuilder minimumPartSizeInBytes(Long uploadPartSize);
3737

38-
S3CrtAsyncClientBuilder targetThroughputGbps(Double targetThroughputGbps);
38+
S3CrtAsyncClientBuilder targetThroughputInGbps(Double targetThroughputInGbps);
3939

4040
S3CrtAsyncClientBuilder maxConcurrency(Integer maxConcurrency);
4141

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@
2929
*/
3030
@SdkInternalApi
3131
public final class S3NativeClientConfiguration implements SdkAutoCloseable {
32-
private static final long DEFAULT_PART_SIZE_BYTES = 8L * SizeConstant.MB;
33-
private static final long DEFAULT_TARGET_THROUGHPUT_GBPS = 5;
32+
private static final long DEFAULT_PART_SIZE_IN_BYTES = 8L * SizeConstant.MB;
33+
private static final long DEFAULT_TARGET_THROUGHPUT_IN_GBPS = 5;
3434
private final String signingRegion;
3535
private final ClientBootstrap clientBootstrap;
3636
private final CredentialsProvider credentialsProvider;
37-
private final long partSizeBytes;
38-
private final double targetThroughputGbps;
37+
private final long partSizeInBytes;
38+
private final double targetThroughputInGbps;
3939
private final int maxConcurrency;
4040

4141
public S3NativeClientConfiguration(Builder builder) {
@@ -47,10 +47,10 @@ public S3NativeClientConfiguration(Builder builder) {
4747
.withClientBootstrap(clientBootstrap)
4848
.build() :
4949
builder.credentialsProvider;
50-
this.partSizeBytes = builder.partSizeBytes == null ? DEFAULT_PART_SIZE_BYTES :
51-
builder.partSizeBytes;
52-
this.targetThroughputGbps = builder.targetThroughputGbps == null ?
53-
DEFAULT_TARGET_THROUGHPUT_GBPS : builder.targetThroughputGbps;
50+
this.partSizeInBytes = builder.partSizeInBytes == null ? DEFAULT_PART_SIZE_IN_BYTES :
51+
builder.partSizeInBytes;
52+
this.targetThroughputInGbps = builder.targetThroughputInGbps == null ?
53+
DEFAULT_TARGET_THROUGHPUT_IN_GBPS : builder.targetThroughputInGbps;
5454

5555
// Using 0 so that CRT will calculate it based on targetThroughputGbps
5656
this.maxConcurrency = builder.maxConcurrency == null ? 0 : builder.maxConcurrency;
@@ -73,11 +73,11 @@ public CredentialsProvider credentialsProvider() {
7373
}
7474

7575
public long partSizeBytes() {
76-
return partSizeBytes;
76+
return partSizeInBytes;
7777
}
7878

79-
public double targetThroughputGbps() {
80-
return targetThroughputGbps;
79+
public double targetThroughputInGbps() {
80+
return targetThroughputInGbps;
8181
}
8282

8383
public int maxConcurrency() {
@@ -93,8 +93,8 @@ public void close() {
9393
public static final class Builder {
9494
private String signingRegion;
9595
private CredentialsProvider credentialsProvider;
96-
private Long partSizeBytes;
97-
private Double targetThroughputGbps;
96+
private Long partSizeInBytes;
97+
private Double targetThroughputInGbps;
9898
private Integer maxConcurrency;
9999

100100
private Builder() {
@@ -110,13 +110,13 @@ public Builder credentialsProvider(CredentialsProvider credentialsProvider) {
110110
return this;
111111
}
112112

113-
public Builder partSizeBytes(Long partSizeBytes) {
114-
this.partSizeBytes = partSizeBytes;
113+
public Builder partSizeInBytes(Long partSizeInBytes) {
114+
this.partSizeInBytes = partSizeInBytes;
115115
return this;
116116
}
117117

118-
public Builder targetThroughputGbps(Double targetThroughputGbps) {
119-
this.targetThroughputGbps = targetThroughputGbps;
118+
public Builder targetThroughputInGbps(Double targetThroughputInGbps) {
119+
this.targetThroughputInGbps = targetThroughputInGbps;
120120
return this;
121121
}
122122

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public void upload_bothBucketKeyPairAndRequestProvided_throws() {
5555
UploadRequest.builder()
5656
.bucket("bucket")
5757
.key("key")
58-
.apiRequest(PutObjectRequest.builder().build())
58+
.putObjectRequest(PutObjectRequest.builder().build())
5959
.build();
6060
}
6161

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public void bothBucketKeyPairAndRequestProvided_throws() {
5959
DownloadRequest.builder()
6060
.bucket("bucket")
6161
.key("key")
62-
.apiRequest(GetObjectRequest.builder().build())
62+
.getObjectRequest(GetObjectRequest.builder().build())
6363
.build();
6464
}
6565

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,13 @@ public abstract class BaseTransferManagerBenchmark implements TransferManagerBen
5454
logger.info(() -> "Benchmark config: " + config);
5555
Long partSizeInMb = config.partSizeInMb() == null ? null : config.partSizeInMb() * 1024 * 1024L;
5656
s3 = S3CrtAsyncClient.builder()
57-
.targetThroughputGbps(config.targetThroughput())
57+
.targetThroughputInGbps(config.targetThroughput())
5858
.minimumPartSizeInBytes(partSizeInMb)
5959
.build();
6060
s3Sync = S3Client.builder()
6161
.build();
6262
transferManager = S3TransferManager.builder()
63-
.s3ClientConfiguration(b -> b.targetThroughputGbps(config.targetThroughput())
63+
.s3ClientConfiguration(b -> b.targetThroughputInGbps(config.targetThroughput())
6464
.minimumPartSizeInBytes(partSizeInMb))
6565
.build();
6666
bucket = config.bucket();

0 commit comments

Comments
 (0)