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

Interface DownloadRequest.UntypedBuilder

Enclosing class:

DownloadRequest<ReturnT>

public static interface DownloadRequest.UntypedBuilder

Initial calls to DownloadRequest.builder() return an DownloadRequest.UntypedBuilder, where the builder is not yet parameterized with the generic type associated with DownloadRequest. This prevents the otherwise awkward syntax of having to explicitly cast the builder type, e.g.,

 DownloadRequest.<ResponseBytes<GetObjectResponse>>builder()
 

Instead, the type may be inferred as part of specifying the responseTransformer(AsyncResponseTransformer) parameter, at which point the builder chain will return a new DownloadRequest.TypedBuilder.

Method Summary

Modifier and Type	Method	Description
DownloadRequest.UntypedBuilder	addTransferListener(TransferListener transferListener)	Adds a TransferListener that will be notified as part of this request.
default DownloadRequest.UntypedBuilder	getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder)	The GetObjectRequest request that should be used for the download
DownloadRequest.UntypedBuilder	getObjectRequest(GetObjectRequest getObjectRequest)	The GetObjectRequest request that should be used for the download
<T> DownloadRequest.TypedBuilder<T>	responseTransformer(AsyncResponseTransformer<GetObjectResponse,T> responseTransformer)	Specifies the AsyncResponseTransformer that should be used for the download.
DownloadRequest.UntypedBuilder	transferListeners(Collection<TransferListener> transferListeners)	The TransferListeners that will be notified as part of this request.

Method Detail

getObjectRequest

DownloadRequest.UntypedBuilder getObjectRequest(GetObjectRequest getObjectRequest)

The GetObjectRequest request that should be used for the download

Parameters:

getObjectRequest - the getObject request

Returns:

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

See Also:

getObjectRequest(Consumer)

getObjectRequest

default DownloadRequest.UntypedBuilder getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder)

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

Parameters:

getObjectRequestBuilder - the getObject request

Returns:

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

See Also:

getObjectRequest(GetObjectRequest)

transferListeners

DownloadRequest.UntypedBuilder 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

DownloadRequest.UntypedBuilder addTransferListener(TransferListener transferListener)

Adds 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

responseTransformer

<T> DownloadRequest.TypedBuilder<T> responseTransformer(AsyncResponseTransformer<GetObjectResponse,T> responseTransformer)

Specifies the AsyncResponseTransformer that should be used for the download. This method also infers the generic type of DownloadRequest to create, inferred from the second type parameter of the provided AsyncResponseTransformer. E.g, specifying AsyncResponseTransformer.toBytes() would result in inferring the type of the DownloadRequest to be of ResponseBytes<GetObjectResponse>. See the static factory methods available in AsyncResponseTransformer.

Type Parameters:

T - the type of DownloadRequest to create

Parameters:

responseTransformer - the AsyncResponseTransformer

Returns:

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

See Also:

AsyncResponseTransformer