Package software.amazon.awssdk.transfer.s3.model

Class DownloadDirectoryRequest

java.lang.Object

software.amazon.awssdk.transfer.s3.model.DownloadDirectoryRequest

All Implemented Interfaces:

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

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

Request object to download the objects in the provided S3 bucket to a local directory using the Transfer Manager.

See Also:

• S3TransferManager.downloadDirectory(DownloadDirectoryRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DownloadDirectoryRequest.Builder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	bucket()	The name of the bucket
static DownloadDirectoryRequest.Builder	builder()
Path	destination()	The destination directory to which files should be downloaded.
Consumer<DownloadFileRequest.Builder>	downloadFileRequestTransformer()
boolean	equals(Object o)
DownloadFilter	filter()
int	hashCode()
Consumer<ListObjectsV2Request.Builder>	listObjectsRequestTransformer()
static Class<? extends DownloadDirectoryRequest.Builder>	serializableBuilderClass()
DownloadDirectoryRequest.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Constructor Details

DownloadDirectoryRequest

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

Method Details

destination

public Path destination()

The destination directory to which files should be downloaded.

Returns:

the destination directory

See Also:

• DownloadDirectoryRequest.Builder.destination(Path)

bucket

public String bucket()

The name of the bucket

Returns:

bucket name

See Also:

• DownloadDirectoryRequest.Builder.bucket(String)

filter

public DownloadFilter filter()

Returns:

the optional filter, or DownloadFilter.allObjects() if no filter was provided

See Also:

• DownloadDirectoryRequest.Builder.filter(DownloadFilter)

listObjectsRequestTransformer

public Consumer<ListObjectsV2Request.Builder> listObjectsRequestTransformer()

Returns:

the ListObjectsV2Request transformer if not null, otherwise no-op

See Also:

• DownloadDirectoryRequest.Builder.listObjectsV2RequestTransformer(Consumer)

downloadFileRequestTransformer

public Consumer<DownloadFileRequest.Builder> downloadFileRequestTransformer()

Returns:

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

See Also:

• DownloadDirectoryRequest.Builder.listObjectsV2RequestTransformer(Consumer)

builder

public static DownloadDirectoryRequest.Builder builder()

serializableBuilderClass

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

toBuilder

public DownloadDirectoryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DownloadDirectoryRequest.Builder,DownloadDirectoryRequest>

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