software.amazon.awssdk.transfer.s3.internal

Class DefaultS3TransferManager

java.lang.Object

software.amazon.awssdk.transfer.s3.internal.DefaultS3TransferManager

All Implemented Interfaces:

AutoCloseable, S3TransferManager, SdkAutoCloseable

public final class DefaultS3TransferManager
extends Object
implements S3TransferManager

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awssdk.transfer.s3.S3TransferManager

S3TransferManager.Builder

Constructor Summary

Constructors

Constructor and Description
DefaultS3TransferManager(software.amazon.awssdk.transfer.s3.internal.DefaultS3TransferManager.DefaultBuilder builder)

Method Summary

Modifier and Type	Method and Description
static S3TransferManager.Builder	builder() Creates a default builder for S3TransferManager.
void	close()
Download	download(DownloadRequest downloadRequest) Download an object identified by the bucket and key from S3 to the given file.
Upload	upload(UploadRequest uploadRequest) Upload a file to S3.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.transfer.s3.S3TransferManager

create, download, upload

Constructor Detail

DefaultS3TransferManager

public DefaultS3TransferManager(software.amazon.awssdk.transfer.s3.internal.DefaultS3TransferManager.DefaultBuilder builder)

Method Detail

upload

public Upload upload(UploadRequest uploadRequest)

Description copied from interface: S3TransferManager

Upload a file to S3.

Usage Example:

 
 Upload upload =
     transferManager.upload(UploadRequest.builder()
                                        .source(Paths.get("myFile.txt"))
                                        .putObjectRequest(PutObjectRequest.builder()
                                                                          .bucket("bucket")
                                                                          .key("key")
                                                                          .build())
                                        .build());
 // Wait for the transfer to complete
 upload.completionFuture().join();
 
 

Specified by:

upload in interface S3TransferManager

download

public Download download(DownloadRequest downloadRequest)

Description copied from interface: S3TransferManager

Download an object identified by the bucket and key from S3 to the given file.

Usage Example:

 
 // Initiate the transfer
 Download download =
     transferManager.download(DownloadRequest.builder()
                                             .destination(Paths.get("myFile.txt"))
                                             .getObjectRequest(GetObjectRequest.builder()
                                                                               .bucket("bucket")
                                                                               .key("key")
                                                                               .build())
                                             .build());
 // Wait for the transfer to complete
 download.completionFuture().join();
 
 

Specified by:

download in interface S3TransferManager

See Also:

S3TransferManager.download(Consumer)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

builder

public static S3TransferManager.Builder builder()

Description copied from interface: S3TransferManager

Creates a default builder for S3TransferManager.

Specified by:

builder in interface S3TransferManager