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

Class DownloadRequest<ReturnT>

java.lang.Object

software.amazon.awssdk.transfer.s3.model.DownloadRequest<ReturnT>

All Implemented Interfaces:

TransferObjectRequest, TransferRequest, ToCopyableBuilder<DownloadRequest.TypedBuilder<ReturnT>,DownloadRequest<ReturnT>>

@SdkPublicApi
public final class DownloadRequest<ReturnT>
extends Object
implements TransferObjectRequest, ToCopyableBuilder<DownloadRequest.TypedBuilder<ReturnT>,DownloadRequest<ReturnT>>

Represents the request to download an object identified by the bucket and key from S3 through the given AsyncResponseTransformer. For downloading to a file, you may use DownloadFileRequest instead.

See Also:

• S3TransferManager.download(DownloadRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DownloadRequest.TypedBuilder<T>	The type-parameterized version of DownloadRequest.UntypedBuilder.
static interface	DownloadRequest.UntypedBuilder	Initial calls to builder() return an DownloadRequest.UntypedBuilder, where the builder is not yet parameterized with the generic type associated with DownloadRequest.

Method Summary

Modifier and Type	Method	Description
static DownloadRequest.UntypedBuilder	builder()	Creates a builder that can be used to create a DownloadRequest.
boolean	equals(Object o)
GetObjectRequest	getObjectRequest()
int	hashCode()
AsyncResponseTransformer<GetObjectResponse,ReturnT>	responseTransformer()	The Path to file that response contents will be written to.
DownloadRequest.TypedBuilder<ReturnT>	toBuilder()
String	toString()
List<TransferListener>	transferListeners()

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

Method Details

builder

public static DownloadRequest.UntypedBuilder builder()

Creates a builder that can be used to create a DownloadRequest.

See Also:

• DownloadRequest.UntypedBuilder

toBuilder

public DownloadRequest.TypedBuilder<ReturnT> toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DownloadRequest.TypedBuilder<ReturnT>,DownloadRequest<ReturnT>>

responseTransformer

public AsyncResponseTransformer<GetObjectResponse,ReturnT> responseTransformer()

The Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown.

Returns:

the destination path

getObjectRequest

public GetObjectRequest getObjectRequest()

Returns:

The GetObjectRequest request that should be used for the download

transferListeners

public List<TransferListener> transferListeners()

Specified by:

transferListeners in interface TransferObjectRequest

Returns:

the List of transferListeners.

See Also:

• DownloadRequest.TypedBuilder.transferListeners(Collection)

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