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

Class DownloadFileRequest

java.lang.Object

software.amazon.awssdk.transfer.s3.model.DownloadFileRequest

All Implemented Interfaces:

TransferObjectRequest, TransferRequest, ToCopyableBuilder<DownloadFileRequest.Builder,DownloadFileRequest>

@SdkPublicApi
public final class DownloadFileRequest
extends Object
implements TransferObjectRequest, ToCopyableBuilder<DownloadFileRequest.Builder,DownloadFileRequest>

Download an object identified by the bucket and key from S3 to a local file. For non-file-based downloads, you may use DownloadRequest instead.

See Also:

• S3TransferManager.downloadFile(DownloadFileRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DownloadFileRequest.Builder	A builder for a DownloadFileRequest, created with builder()

Method Summary

Modifier and Type	Method	Description
static DownloadFileRequest.Builder	builder()	Creates a builder that can be used to create a DownloadFileRequest.
Path	destination()	The Path to file that response contents will be written to.
boolean	equals(Object o)
GetObjectRequest	getObjectRequest()
int	hashCode()
static Class<? extends DownloadFileRequest.Builder>	serializableBuilderClass()
DownloadFileRequest.Builder	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 DownloadFileRequest.Builder builder()

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

See Also:

• S3TransferManager.downloadFile(DownloadFileRequest)

toBuilder

public DownloadFileRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DownloadFileRequest.Builder,DownloadFileRequest>

destination

public Path destination()

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:

List of TransferListeners that will be notified as part of this request.

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

serializableBuilderClass

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