Skip to content

Update sample code and fix snippet path #3567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 25, 2022
Merged

Update sample code and fix snippet path #3567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1e6d65
Update sample code and fix snippet path
zoewangg Nov 24, 2022
ab025c7
Fix link
zoewangg Nov 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,7 @@
</activation>
<properties>
<!-- snippet-path only works with JDK 18+ -->
<additionalJavadocOption>--snippet-path=${basedir}/src/test/java</additionalJavadocOption>
<additionalJavadocOption>--snippet-path=${basedir}/src/test/java:${basedir}/service-custom/s3-transfer-manager/src/test/java</additionalJavadocOption>
</properties>
</profile>

Expand Down
2 changes: 1 addition & 1 deletion ...r-manager/src/main/java/software/amazon/awssdk/transfer/s3/progress/TransferListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ public interface TransferFailed extends TransferInitiated {
/**
* The exception associated with the failed transfer.
* <p>
* Note that this would be the <i>cause</i>> of a {@link CompletionException}, and not a {@link CompletionException}
* Note that this would be the <i>cause</i> of a {@link CompletionException}, and not a {@link CompletionException}
* itself.
*/
Throwable exception();
Expand Down
77 changes: 57 additions & 20 deletions ...er/src/test/java/software/amazon/awssdk/transfer/s3/samples/S3TransferManagerSamples.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,29 @@
import software.amazon.awssdk.core.async.AsyncResponseTransformer;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3AsyncClient;
import software.amazon.awssdk.services.s3.model.CopyObjectRequest;
import software.amazon.awssdk.services.s3.model.GetObjectResponse;
import software.amazon.awssdk.transfer.s3.S3TransferManager;
import software.amazon.awssdk.transfer.s3.model.CompletedCopy;
import software.amazon.awssdk.transfer.s3.model.CompletedDirectoryDownload;
import software.amazon.awssdk.transfer.s3.model.CompletedDirectoryUpload;
import software.amazon.awssdk.transfer.s3.model.Copy;
import software.amazon.awssdk.transfer.s3.model.CopyRequest;
import software.amazon.awssdk.transfer.s3.model.DirectoryDownload;
import software.amazon.awssdk.transfer.s3.model.DirectoryUpload;
import software.amazon.awssdk.transfer.s3.model.Download;
import software.amazon.awssdk.transfer.s3.model.DownloadDirectoryRequest;
import software.amazon.awssdk.transfer.s3.model.DownloadFileRequest;
import software.amazon.awssdk.transfer.s3.model.DownloadRequest;
import software.amazon.awssdk.transfer.s3.model.FileDownload;
import software.amazon.awssdk.transfer.s3.model.FileUpload;
import software.amazon.awssdk.transfer.s3.model.ResumableFileDownload;
import software.amazon.awssdk.transfer.s3.model.ResumableFileUpload;
import software.amazon.awssdk.transfer.s3.model.Upload;
import software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest;
import software.amazon.awssdk.transfer.s3.model.UploadFileRequest;
import software.amazon.awssdk.transfer.s3.model.UploadRequest;
import software.amazon.awssdk.transfer.s3.progress.LoggingTransferListener;

/**
* Contains code snippets that will be used in the Javadocs of {@link S3TransferManager}
Expand Down Expand Up @@ -73,9 +80,13 @@ public void downloadFile() {
// @start region=downloadFile
S3TransferManager transferManager = S3TransferManager.create();

FileDownload download =
transferManager.downloadFile(d -> d.getObjectRequest(g -> g.bucket("bucket").key("key")).destination(Paths.get(
"myFile.txt")));
DownloadFileRequest downloadFileRequest = DownloadFileRequest.builder()
.getObjectRequest(req -> req.bucket("bucket").key("key"))
.destination(Paths.get("myFile.txt"))
.addTransferListener(LoggingTransferListener.create())
.build();

FileDownload download = transferManager.downloadFile(downloadFileRequest);

// Wait for the transfer to complete
download.completionFuture().join();
Expand All @@ -86,11 +97,15 @@ public void download() {
// @start region=download
S3TransferManager transferManager = S3TransferManager.create();

DownloadRequest<ResponseBytes<GetObjectResponse>> downloadRequest =
DownloadRequest.builder()
.getObjectRequest(req -> req.bucket("bucket").key("key"))
.responseTransformer(AsyncResponseTransformer.toBytes())
.build();

// Initiate the transfer
Download<ResponseBytes<GetObjectResponse>> download =
transferManager.download(d -> d.getObjectRequest(g -> g.bucket("bucket")
.key("key"))
.responseTransformer(AsyncResponseTransformer.toBytes()));
transferManager.download(downloadRequest);
// Wait for the transfer to complete
download.completionFuture().join();
// @end region=download
Expand All @@ -100,10 +115,14 @@ public void resumeDownloadFile() {
// @start region=resumeDownloadFile
S3TransferManager transferManager = S3TransferManager.create();

DownloadFileRequest downloadFileRequest = DownloadFileRequest.builder()
.getObjectRequest(req -> req.bucket("bucket").key("key"))
.destination(Paths.get("myFile.txt"))
.build();

// Initiate the transfer
FileDownload download =
transferManager.downloadFile(d -> d.getObjectRequest(g -> g.bucket("bucket").key("key")).destination(Paths.get(
"myFile.txt")));
transferManager.downloadFile(downloadFileRequest);

// Pause the download
ResumableFileDownload resumableFileDownload = download.pause(); // @link substring="pause" target="software.amazon.awssdk.transfer.s3.model.FileDownload#pause()"
Expand All @@ -127,10 +146,14 @@ public void resumeUploadFile() {
// @start region=resumeUploadFile
S3TransferManager transferManager = S3TransferManager.create();

UploadFileRequest uploadFileRequest = UploadFileRequest.builder()
.putObjectRequest(req -> req.bucket("bucket").key("key"))
.source(Paths.get("myFile.txt"))
.build();

// Initiate the transfer
FileUpload upload =
transferManager.uploadFile(d -> d.putObjectRequest(g -> g.bucket("bucket").key("key")).source(Paths.get("myFile"
+ ".txt")));
transferManager.uploadFile(uploadFileRequest);
// Pause the upload
ResumableFileUpload resumableFileUpload = upload.pause();

Expand All @@ -153,9 +176,13 @@ public void uploadFile() {
// @start region=uploadFile
S3TransferManager transferManager = S3TransferManager.create();

FileUpload upload = transferManager.uploadFile(u -> u.source(Paths.get("myFile.txt"))
.putObjectRequest(p -> p.bucket("bucket").key(
"key")));
UploadFileRequest uploadFileRequest = UploadFileRequest.builder()
.putObjectRequest(req -> req.bucket("bucket").key("key"))
.addTransferListener(LoggingTransferListener.create())
.source(Paths.get("myFile.txt"))
.build();

FileUpload upload = transferManager.uploadFile(uploadFileRequest);
upload.completionFuture().join();
// @end region=uploadFile
}
Expand All @@ -164,8 +191,12 @@ public void upload() {
// @start region=upload
S3TransferManager transferManager = S3TransferManager.create();

Upload upload = transferManager.upload(u -> u.requestBody(AsyncRequestBody.fromString("Hello world"))
.putObjectRequest(p -> p.bucket("bucket").key("key")));
UploadRequest uploadRequest = UploadRequest.builder()
.requestBody(AsyncRequestBody.fromString("Hello world"))
.putObjectRequest(req -> req.bucket("bucket").key("key"))
.build();

Upload upload = transferManager.upload(uploadRequest);
// Wait for the transfer to complete
upload.completionFuture().join();
// @end region=upload
Expand Down Expand Up @@ -209,11 +240,17 @@ public void downloadDirectory() {
public void copy() {
// @start region=copy
S3TransferManager transferManager = S3TransferManager.create();
Copy copy =
transferManager.copy(c -> c.copyObjectRequest(r -> r.sourceBucket("source_bucket")
.sourceKey("source_key")
.destinationBucket("dest_bucket")
.destinationKey("dest_key")));
CopyObjectRequest copyObjectRequest = CopyObjectRequest.builder()
.sourceBucket("source_bucket")
.sourceKey("source_key")
.destinationBucket("dest_bucket")
.destinationKey("dest_key")
.build();
CopyRequest copyRequest = CopyRequest.builder()
.copyObjectRequest(copyObjectRequest)
.build();

Copy copy = transferManager.copy(copyRequest);
// Wait for the transfer to complete
CompletedCopy completedCopy = copy.completionFuture().join();
// @end region=copy
Expand Down