Class DownloadFileRequest
java.lang.Object
software.amazon.awssdk.transfer.s3.model.DownloadFileRequest
- All Implemented Interfaces:
TransferObjectRequest
,TransferRequest
,ToCopyableBuilder<DownloadFileRequest.Builder,
DownloadFileRequest>
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
A builder for aDownloadFileRequest
, created withbuilder()
-
Method Summary
Modifier and TypeMethodDescriptionstatic DownloadFileRequest.Builder
builder()
Creates a builder that can be used to create aDownloadFileRequest
.ThePath
to file that response contents will be written to.boolean
int
hashCode()
static Class
<? extends DownloadFileRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.toString()
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
builder
Creates a builder that can be used to create aDownloadFileRequest
.- See Also:
-
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 interfaceToCopyableBuilder<DownloadFileRequest.Builder,
DownloadFileRequest> - Returns:
- a builder for type T
-
destination
ThePath
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
- Returns:
- The
GetObjectRequest
request that should be used for the download
-
transferListeners
- Specified by:
transferListeners
in interfaceTransferObjectRequest
- Returns:
- List of
TransferListener
s that will be notified as part of this request.
-
equals
-
hashCode
public int hashCode() -
toString
-
serializableBuilderClass
-