Class UploadDirectoryRequest

java.lang.Object

software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest

All Implemented Interfaces:

TransferDirectoryRequest, TransferRequest, ToCopyableBuilder<UploadDirectoryRequest.Builder,UploadDirectoryRequest>

@SdkPublicApi
public final class UploadDirectoryRequest
extends Object
implements TransferDirectoryRequest, ToCopyableBuilder<UploadDirectoryRequest.Builder,UploadDirectoryRequest>

Request object to upload a local directory to S3 using the Transfer Manager.

See Also:

• S3TransferManager.uploadDirectory(UploadDirectoryRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UploadDirectoryRequest.Builder

Constructor Summary

Constructors

Constructor	Description
UploadDirectoryRequest(software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest.DefaultBuilder builder)

Method Summary

Modifier and Type	Method	Description
String	bucket()	The name of the bucket to upload objects to.
static UploadDirectoryRequest.Builder	builder()
boolean	equals(Object o)
Optional<Boolean>	followSymbolicLinks()
int	hashCode()
OptionalInt	maxDepth()
Optional<String>	s3Delimiter()
Optional<String>	s3Prefix()
static Class<? extends UploadDirectoryRequest.Builder>	serializableBuilderClass()
Path	source()	The source directory to upload
UploadDirectoryRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Consumer<UploadFileRequest.Builder>	uploadFileRequestTransformer()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Constructor Details

UploadDirectoryRequest

public UploadDirectoryRequest(software.amazon.awssdk.transfer.s3.model.UploadDirectoryRequest.DefaultBuilder builder)

Method Details

source

public Path source()

The source directory to upload

Returns:

the source directory

See Also:

• UploadDirectoryRequest.Builder.source(Path)

bucket

public String bucket()

The name of the bucket to upload objects to.

Returns:

bucket name

See Also:

• UploadDirectoryRequest.Builder.bucket(String)

s3Prefix

public Optional<String> s3Prefix()

Returns:

the optional key prefix

See Also:

• UploadDirectoryRequest.Builder.s3Prefix(String)

s3Delimiter

public Optional<String> s3Delimiter()

Returns:

the optional delimiter

See Also:

• UploadDirectoryRequest.Builder.s3Delimiter(String)

followSymbolicLinks

public Optional<Boolean> followSymbolicLinks()

Returns:

whether to follow symbolic links

See Also:

• UploadDirectoryRequest.Builder.followSymbolicLinks(Boolean)

maxDepth

public OptionalInt maxDepth()

Returns:

the maximum number of directory levels to traverse

See Also:

• UploadDirectoryRequest.Builder.maxDepth(Integer)

uploadFileRequestTransformer

public Consumer<UploadFileRequest.Builder> uploadFileRequestTransformer()

Returns:

the upload request transformer if not null, otherwise no-op

See Also:

• UploadDirectoryRequest.Builder.uploadFileRequestTransformer(Consumer)

builder

public static UploadDirectoryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UploadDirectoryRequest.Builder> serializableBuilderClass()

toBuilder

public UploadDirectoryRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UploadDirectoryRequest.Builder,UploadDirectoryRequest>

Returns:

a builder for type T

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object