software.amazon.awssdk.transfer.s3

Interface UploadDirectoryOverrideConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<UploadDirectoryOverrideConfiguration.Builder,UploadDirectoryOverrideConfiguration>, SdkBuilder<UploadDirectoryOverrideConfiguration.Builder,UploadDirectoryOverrideConfiguration>

Enclosing class:

UploadDirectoryOverrideConfiguration

public static interface UploadDirectoryOverrideConfiguration.Builder
extends CopyableBuilder<UploadDirectoryOverrideConfiguration.Builder,UploadDirectoryOverrideConfiguration>

Method Summary

Modifier and Type	Method and Description
UploadDirectoryOverrideConfiguration	build()
UploadDirectoryOverrideConfiguration.Builder	followSymbolicLinks(Boolean followSymbolicLinks) Specify whether to follow symbolic links when traversing the file tree.
UploadDirectoryOverrideConfiguration.Builder	maxDepth(Integer maxDepth) Specify the maximum number of levels of directories to visit.
UploadDirectoryOverrideConfiguration.Builder	recursive(Boolean recursive) Specify whether to recursively upload all files under the specified directory
UploadDirectoryOverrideConfiguration.Builder	uploadFileRequestTransformer(Consumer<UploadFileRequest.Builder> uploadFileRequestTransformer) Specify a function used to transform the UploadFileRequests generated by this UploadDirectoryRequest.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation

Method Detail

recursive

UploadDirectoryOverrideConfiguration.Builder recursive(Boolean recursive)

Specify whether to recursively upload all files under the specified directory

Default to true

Parameters:

recursive - whether enable recursive upload

Returns:

This builder for method chaining.

followSymbolicLinks

UploadDirectoryOverrideConfiguration.Builder followSymbolicLinks(Boolean followSymbolicLinks)

Specify whether to follow symbolic links when traversing the file tree.

Default to false

Parameters:

followSymbolicLinks - whether to follow symbolic links

Returns:

This builder for method chaining.

maxDepth

UploadDirectoryOverrideConfiguration.Builder maxDepth(Integer maxDepth)

Specify the maximum number of levels of directories to visit. Must be positive. 1 means only the files directly within the provided source directory are visited.

Default to Integer.MAX_VALUE

Parameters:

maxDepth - the maximum number of directory levels to visit

Returns:

This builder for method chaining.

uploadFileRequestTransformer

UploadDirectoryOverrideConfiguration.Builder uploadFileRequestTransformer(Consumer<UploadFileRequest.Builder> uploadFileRequestTransformer)

Specify a function used to transform the UploadFileRequests generated by this UploadDirectoryRequest. The provided function is called once for each file that is uploaded, allowing you to modify the paths resolved by TransferManager on a per-file basis, modify the created PutObjectRequest before it is passed to S3, or configure a TransferRequestOverrideConfiguration.

The factory receives the UploadFileRequests created by Transfer Manager for each file in the directory being uploaded, and returns a (potentially modified) UploadFileRequest.

Usage Example:

 
 // Add a LoggingTransferListener to every transfer within the upload directory request
 TransferRequestOverrideConfiguration fileUploadConfiguration =
     TransferRequestOverrideConfiguration.builder()
         .addListener(LoggingTransferListener.create())
         .build();

 UploadDirectoryOverrideConfiguration directoryUploadConfiguration =
     UploadDirectoryOverrideConfiguration.builder()
         .uploadFileRequestTransformer(request -> request.overrideConfiguration(fileUploadConfiguration))
         .build();

 UploadDirectoryRequest request =
     UploadDirectoryRequest.builder()
         .sourceDirectory(Paths.get("."))
         .bucket("bucket")
         .prefix("prefix")
         .overrideConfiguration(directoryUploadConfiguration)
         .build()

 UploadDirectoryTransfer uploadDirectory = transferManager.uploadDirectory(request);

 // Wait for the transfer to complete
 CompletedUploadDirectory completedUploadDirectory = uploadDirectory.completionFuture().join();

 // Print out the failed uploads
 completedUploadDirectory.failedUploads().forEach(System.out::println);
 
 

Parameters:

uploadFileRequestTransformer - A transformer to use for modifying the file-level upload requests before execution

Returns:

This builder for method chaining

build

UploadDirectoryOverrideConfiguration build()

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<UploadDirectoryOverrideConfiguration.Builder,UploadDirectoryOverrideConfiguration>