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

Interface PresignedDownloadFileRequest.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PresignedDownloadFileRequest.Builder,PresignedDownloadFileRequest>, SdkBuilder<PresignedDownloadFileRequest.Builder,PresignedDownloadFileRequest>

Enclosing class:

PresignedDownloadFileRequest

@SdkPublicApi
@NotThreadSafe
public static interface PresignedDownloadFileRequest.Builder
extends CopyableBuilder<PresignedDownloadFileRequest.Builder,PresignedDownloadFileRequest>

A builder for a PresignedDownloadFileRequest, created with PresignedDownloadFileRequest.builder()

Method Summary

Modifier and Type	Method	Description
PresignedDownloadFileRequest.Builder	addTransferListener(TransferListener transferListener)	Add a TransferListener that will be notified as part of this request.
default PresignedDownloadFileRequest.Builder	destination(File destination)	The file that response contents will be written to.
PresignedDownloadFileRequest.Builder	destination(Path destination)	The Path to file that response contents will be written to.
default PresignedDownloadFileRequest.Builder	presignedUrlDownloadRequest(Consumer<PresignedUrlDownloadRequest.Builder> presignedUrlDownloadRequestBuilder)	The PresignedUrlDownloadRequest request that should be used for the download
PresignedDownloadFileRequest.Builder	presignedUrlDownloadRequest(PresignedUrlDownloadRequest presignedUrlDownloadRequest)	The PresignedUrlDownloadRequest request that should be used for the download
PresignedDownloadFileRequest.Builder	transferListeners(Collection<TransferListener> transferListeners)	The TransferListeners that will be notified as part of this request.

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

copy

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

applyMutation, build

Method Details

destination

PresignedDownloadFileRequest.Builder destination(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.

Parameters:

destination - the destination path

Returns:

Returns a reference to this object so that method calls can be chained together.

destination

default PresignedDownloadFileRequest.Builder destination(File destination)

The 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.

Parameters:

destination - the destination path

Returns:

Returns a reference to this object so that method calls can be chained together.

presignedUrlDownloadRequest

PresignedDownloadFileRequest.Builder presignedUrlDownloadRequest(PresignedUrlDownloadRequest presignedUrlDownloadRequest)

The PresignedUrlDownloadRequest request that should be used for the download

Parameters:

presignedUrlDownloadRequest - the presigned URL download request

Returns:

a reference to this object so that method calls can be chained together.

See Also:

• presignedUrlDownloadRequest(Consumer)

presignedUrlDownloadRequest

default PresignedDownloadFileRequest.Builder presignedUrlDownloadRequest(Consumer<PresignedUrlDownloadRequest.Builder> presignedUrlDownloadRequestBuilder)

The PresignedUrlDownloadRequest request that should be used for the download

This is a convenience method that creates an instance of the PresignedUrlDownloadRequest builder avoiding the need to create one manually via PresignedUrlDownloadRequest.builder().

Parameters:

presignedUrlDownloadRequestBuilder - the presigned URL download request

Returns:

a reference to this object so that method calls can be chained together.

See Also:

• presignedUrlDownloadRequest(PresignedUrlDownloadRequest)

transferListeners

PresignedDownloadFileRequest.Builder transferListeners(Collection<TransferListener> transferListeners)

The 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.

Parameters:

transferListeners - the collection of transferListeners

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• TransferListener

addTransferListener

PresignedDownloadFileRequest.Builder addTransferListener(TransferListener transferListener)

Add a TransferListener that will be notified as part of this request.

Parameters:

transferListener - the transferListener to add

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• TransferListener