software.amazon.awssdk.transfer.s3

Class DownloadRequest

java.lang.Object

software.amazon.awssdk.transfer.s3.DownloadRequest

All Implemented Interfaces:

TransferRequest, ToCopyableBuilder<DownloadRequest.Builder,DownloadRequest>

public final class DownloadRequest
extends Object
implements TransferRequest, ToCopyableBuilder<DownloadRequest.Builder,DownloadRequest>

Request object to download an object from S3 using the Transfer Manager.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DownloadRequest.Builder	builder() Create a builder that can be used to create a DownloadRequest.
Path	destination() The Path to file that response contents will be written to.
boolean	equals(Object o)
GetObjectRequest	getObjectRequest()
int	hashCode()
DownloadRequest.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

builder

public static DownloadRequest.Builder builder()

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

See Also:

S3TransferManager.download(DownloadRequest)

toBuilder

public DownloadRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DownloadRequest.Builder,DownloadRequest>

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object