public static interface S3TransferManager.Builder
S3TransferManager.| Modifier and Type | Method and Description |
|---|---|
S3TransferManager |
build()
Builds an instance of
S3TransferManager based on the settings supplied to this builder |
S3TransferManager.Builder |
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. |
S3TransferManager.Builder |
s3Client(S3AsyncClient s3AsyncClient)
Specifies the low level
S3AsyncClient that will be used to send requests to S3. |
S3TransferManager.Builder |
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 |
S3TransferManager.Builder |
uploadDirectoryMaxDepth(Integer uploadDirectoryMaxDepth)
Specifies the maximum number of levels of directories to visit in
S3TransferManager.uploadDirectory(software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest) operation. |
S3TransferManager.Builder s3Client(S3AsyncClient s3AsyncClient)
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.
s3AsyncClient - the S3 async clientS3AsyncClient.crtBuilder()S3TransferManager.Builder executor(Executor executor)
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.
executor - the executor to useS3TransferManager.Builder uploadDirectoryFollowSymbolicLinks(Boolean uploadDirectoryFollowSymbolicLinks)
S3TransferManager.uploadDirectory(software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest) operation
Default to false
uploadDirectoryFollowSymbolicLinks - whether to follow symbolic linksS3TransferManager.Builder uploadDirectoryMaxDepth(Integer uploadDirectoryMaxDepth)
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
uploadDirectoryMaxDepth - the maximum number of directory levels to visitS3TransferManager build()
S3TransferManager based on the settings supplied to this builderS3TransferManagerCopyright © 2023. All rights reserved.