software.amazon.awssdk.transfer.s3

Interface UploadDirectoryRequest.Builder

All Superinterfaces:

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

Enclosing class:

UploadDirectoryRequest

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

Method Summary

Modifier and Type	Method and Description
UploadDirectoryRequest.Builder	bucket(String bucket) The name of the bucket to upload objects to.
UploadDirectoryRequest	build()
UploadDirectoryRequest.Builder	delimiter(String delimiter) Specify the delimiter.
default UploadDirectoryRequest.Builder	overrideConfiguration(Consumer<UploadDirectoryOverrideConfiguration.Builder> uploadConfigurationBuilder) Similar to overrideConfiguration(UploadDirectoryOverrideConfiguration), but takes a lambda to configure a new UploadDirectoryOverrideConfiguration.Builder.
UploadDirectoryRequest.Builder	overrideConfiguration(UploadDirectoryOverrideConfiguration configuration) Add an optional request override configuration.
UploadDirectoryRequest.Builder	prefix(String prefix) Specify the key prefix to use for the objects.
UploadDirectoryRequest.Builder	sourceDirectory(Path sourceDirectory) Specify the source directory to upload.

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

copy

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

applyMutation

Method Detail

sourceDirectory

UploadDirectoryRequest.Builder sourceDirectory(Path sourceDirectory)

Specify the source directory to upload. The source directory must exist. Fle wildcards are not supported and treated literally. Hidden files/directories are visited.

Note that the current user must have read access to all directories and files, otherwise SecurityException will be thrown.

Parameters:

sourceDirectory - the source directory

Returns:

This builder for method chaining.

See Also:

UploadDirectoryOverrideConfiguration

bucket

UploadDirectoryRequest.Builder bucket(String bucket)

The name of the bucket to upload objects to.

Parameters:

bucket - the bucket name

Returns:

This builder for method chaining.

prefix

UploadDirectoryRequest.Builder prefix(String prefix)

Specify the key prefix to use for the objects. If not provided, files will be uploaded to the root of the bucket

See Organizing objects using prefixes

Note: if the provided prefix ends with the same string as delimiter, it will get "normalized" when generating the key name. For example, assuming the prefix provided is "foo/" and the delimiter is "/" and the source directory has the following structure:

 |- test
     |- obj1.txt
     |- obj2.txt
 

the object keys will be "foo/obj1.txt" and "foo/obj2.txt" as apposed to "foo//obj1.txt" and "foo//obj2.txt"

Parameters:

prefix - the key prefix

Returns:

This builder for method chaining.

See Also:

delimiter(String)

delimiter

UploadDirectoryRequest.Builder delimiter(String delimiter)

Specify the delimiter. A delimiter causes a list operation to roll up all the keys that share a common prefix into a single summary list result. If not provided, "/" will be used. See Organizing objects using prefixes

Note: if the provided prefix ends with the same string as delimiter, it will get "normalized" when generating the key name. For example, assuming the prefix provided is "foo/" and the delimiter is "/" and the source directory has the following structure:

 |- test
     |- obj1.txt
     |- obj2.txt
 

the object keys will be "foo/obj1.txt" and "foo/obj2.txt" as apposed to "foo//obj1.txt" and "foo//obj2.txt"

Parameters:

delimiter - the delimiter

Returns:

This builder for method chaining.

See Also:

prefix(String)

overrideConfiguration

UploadDirectoryRequest.Builder overrideConfiguration(UploadDirectoryOverrideConfiguration configuration)

Add an optional request override configuration.

Parameters:

configuration - The override configuration.

Returns:

This builder for method chaining.

overrideConfiguration

default UploadDirectoryRequest.Builder overrideConfiguration(Consumer<UploadDirectoryOverrideConfiguration.Builder> uploadConfigurationBuilder)

Similar to overrideConfiguration(UploadDirectoryOverrideConfiguration), but takes a lambda to configure a new UploadDirectoryOverrideConfiguration.Builder. This removes the need to call UploadDirectoryOverrideConfiguration.builder() and UploadDirectoryOverrideConfiguration.Builder.build().

Parameters:

uploadConfigurationBuilder - the upload configuration

Returns:

this builder for method chaining.

See Also:

overrideConfiguration(UploadDirectoryOverrideConfiguration)

build

UploadDirectoryRequest build()

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<UploadDirectoryRequest.Builder,UploadDirectoryRequest>