@NotThreadSafe public static interface DownloadFileRequest.Builder extends CopyableBuilder<DownloadFileRequest.Builder,DownloadFileRequest>
DownloadFileRequest, created with DownloadFileRequest.builder()| Modifier and Type | Method and Description |
|---|---|
DownloadFileRequest.Builder |
addTransferListener(TransferListener transferListener)
Add a
TransferListener that will be notified as part of this request. |
default DownloadFileRequest.Builder |
destination(File destination)
The file that response contents will be written to.
|
DownloadFileRequest.Builder |
destination(Path destination)
The
Path to file that response contents will be written to. |
default DownloadFileRequest.Builder |
getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder)
The
GetObjectRequest request that should be used for the download |
DownloadFileRequest.Builder |
getObjectRequest(GetObjectRequest getObjectRequest)
The
GetObjectRequest request that should be used for the download |
DownloadFileRequest.Builder |
transferListeners(Collection<TransferListener> transferListeners)
The
TransferListeners that will be notified as part of this request. |
copyapplyMutation, buildDownloadFileRequest.Builder destination(Path destination)
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.destination - the destination pathdefault DownloadFileRequest.Builder destination(File destination)
destination - the destination pathDownloadFileRequest.Builder getObjectRequest(GetObjectRequest getObjectRequest)
GetObjectRequest request that should be used for the downloadgetObjectRequest - the getObject requestgetObjectRequest(Consumer)default DownloadFileRequest.Builder getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder)
GetObjectRequest request that should be used for the download
This is a convenience method that creates an instance of the GetObjectRequest builder avoiding the
need to create one manually via GetObjectRequest.builder().
getObjectRequestBuilder - the getObject requestgetObjectRequest(GetObjectRequest)DownloadFileRequest.Builder transferListeners(Collection<TransferListener> transferListeners)
TransferListeners that will be notified as part of this request. This method overrides and replaces any
transferListeners that have already been set. Add an optional request override configuration.transferListeners - the collection of transferListenersTransferListenerDownloadFileRequest.Builder addTransferListener(TransferListener transferListener)
TransferListener that will be notified as part of this request.transferListener - the transferListener to addTransferListenerCopyright © 2023. All rights reserved.