Class TransferManagerFactory.DefaultBuilder

java.lang.Object

software.amazon.awssdk.transfer.s3.internal.TransferManagerFactory.DefaultBuilder

All Implemented Interfaces:

S3TransferManager.Builder

Enclosing class:

TransferManagerFactory

public static final class TransferManagerFactory.DefaultBuilder
extends Object
implements S3TransferManager.Builder

Constructor Summary

Constructors

Constructor	Description
DefaultBuilder()

Method Summary

Modifier and Type	Method	Description
S3TransferManager	build()	Builds an instance of S3TransferManager based on the settings supplied to this builder
TransferManagerFactory.DefaultBuilder	executor(Executor executor)	Specifies the executor that S3TransferManager will use to execute background tasks before handing them off to the underlying S3 async client, such as visiting file tree in a S3TransferManager.uploadDirectory(UploadDirectoryRequest) operation.
Integer	getTransferDirectoryMaxConcurrency()
Boolean	getUploadDirectoryFollowSymbolicLinks()
Integer	getUploadDirectoryMaxDepth()
TransferManagerFactory.DefaultBuilder	s3Client(S3AsyncClient s3AsyncClient)	Specifies the low level S3AsyncClient that will be used to send requests to S3.
void	setTransferDirectoryMaxConcurrency(Integer transferDirectoryMaxConcurrency)
void	setUploadDirectoryFollowSymbolicLinks(Boolean followSymbolicLinks)
void	setUploadDirectoryMaxDepth(Integer uploadDirectoryMaxDepth)
TransferManagerFactory.DefaultBuilder	transferDirectoryMaxConcurrency(Integer transferDirectoryMaxConcurrency)	Specifies the maximum number of concurrent file transfers that will be performed when uploading or downloading a directory.
TransferManagerFactory.DefaultBuilder	uploadDirectoryFollowSymbolicLinks(Boolean uploadDirectoryFollowSymbolicLinks)	Specifies whether to follow symbolic links when traversing the file tree in S3TransferManager.uploadDirectory(software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest) operation
TransferManagerFactory.DefaultBuilder	uploadDirectoryMaxDepth(Integer uploadDirectoryMaxDepth)	Specifies the maximum number of levels of directories to visit in S3TransferManager.uploadDirectory(software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest) operation.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultBuilder

public DefaultBuilder()

Method Details

s3Client

public TransferManagerFactory.DefaultBuilder s3Client(S3AsyncClient s3AsyncClient)

Description copied from interface: S3TransferManager.Builder

Specifies the low level S3AsyncClient that will be used to send requests to S3. The SDK will create a default S3AsyncClient if not provided.

It's highly recommended to use S3AsyncClient.crtBuilder() to create an S3AsyncClient instance to benefit from multipart upload/download feature and maximum throughput.

Note: the provided S3AsyncClient will not be closed when the transfer manager is closed; it must be closed by the caller when it is ready to be disposed.

Specified by:

s3Client in interface S3TransferManager.Builder

Parameters:

s3AsyncClient - the S3 async client

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• S3AsyncClient.crtBuilder()

executor

public TransferManagerFactory.DefaultBuilder executor(Executor executor)

Description copied from interface: S3TransferManager.Builder

Specifies the executor that S3TransferManager will use to execute background tasks before handing them off to the underlying S3 async client, such as visiting file tree in a S3TransferManager.uploadDirectory(UploadDirectoryRequest) operation.

The SDK will create an executor if not provided.

This executor must be shut down by the user when it is ready to be disposed. The SDK will not close the executor when the s3 transfer manager is closed.

Specified by:

executor in interface S3TransferManager.Builder

Parameters:

executor - the executor to use

Returns:

this builder for method chaining.

uploadDirectoryFollowSymbolicLinks

public TransferManagerFactory.DefaultBuilder uploadDirectoryFollowSymbolicLinks(Boolean uploadDirectoryFollowSymbolicLinks)

Description copied from interface: S3TransferManager.Builder

Specifies whether to follow symbolic links when traversing the file tree in S3TransferManager.uploadDirectory(software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest) operation

Default to false

Specified by:

uploadDirectoryFollowSymbolicLinks in interface S3TransferManager.Builder

Parameters:

uploadDirectoryFollowSymbolicLinks - whether to follow symbolic links

Returns:

This builder for method chaining.

setUploadDirectoryFollowSymbolicLinks

public void setUploadDirectoryFollowSymbolicLinks(Boolean followSymbolicLinks)

getUploadDirectoryFollowSymbolicLinks

public Boolean getUploadDirectoryFollowSymbolicLinks()

uploadDirectoryMaxDepth

public TransferManagerFactory.DefaultBuilder uploadDirectoryMaxDepth(Integer uploadDirectoryMaxDepth)

Description copied from interface: S3TransferManager.Builder

Specifies the maximum number of levels of directories to visit in S3TransferManager.uploadDirectory(software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest) operation. Must be positive. 1 means only the files directly within the provided source directory are visited.

Default to Integer.MAX_VALUE

Specified by:

uploadDirectoryMaxDepth in interface S3TransferManager.Builder

Parameters:

uploadDirectoryMaxDepth - the maximum number of directory levels to visit

Returns:

This builder for method chaining.

setUploadDirectoryMaxDepth

public void setUploadDirectoryMaxDepth(Integer uploadDirectoryMaxDepth)

getUploadDirectoryMaxDepth

public Integer getUploadDirectoryMaxDepth()

transferDirectoryMaxConcurrency

public TransferManagerFactory.DefaultBuilder transferDirectoryMaxConcurrency(Integer transferDirectoryMaxConcurrency)

Description copied from interface: S3TransferManager.Builder

Specifies the maximum number of concurrent file transfers that will be performed when uploading or downloading a directory. This setting controls the concurrency for an individual call to S3TransferManager.uploadDirectory(software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest) or S3TransferManager.downloadDirectory(software.amazon.awssdk.transfer.s3.model.DownloadDirectoryRequest).

Default to 100

Specified by:

transferDirectoryMaxConcurrency in interface S3TransferManager.Builder

Parameters:

transferDirectoryMaxConcurrency - the maximum number of concurrent file transfers

Returns:

This builder for method chaining.

setTransferDirectoryMaxConcurrency

public void setTransferDirectoryMaxConcurrency(Integer transferDirectoryMaxConcurrency)

getTransferDirectoryMaxConcurrency

public Integer getTransferDirectoryMaxConcurrency()

build

public S3TransferManager build()

Description copied from interface: S3TransferManager.Builder

Builds an instance of S3TransferManager based on the settings supplied to this builder

Specified by:

build in interface S3TransferManager.Builder

Returns:

an instance of S3TransferManager