software.amazon.awssdk.transfer.s3

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 and Description
default <T> DownloadRequest.TypedBuilder<T>	applyMutation(Function<DownloadRequest.UntypedBuilder,DownloadRequest.TypedBuilder<T>> mutator) Like SdkBuilder.applyMutation(Consumer), but accepts a Function that upgrades this DownloadRequest.UntypedBuilder to a DownloadRequest.TypedBuilder.
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
default DownloadRequest.UntypedBuilder	overrideConfiguration(Consumer<TransferRequestOverrideConfiguration.Builder> configurationBuilder) Similar to overrideConfiguration(TransferRequestOverrideConfiguration), but takes a lambda to configure a new TransferRequestOverrideConfiguration.Builder.
DownloadRequest.UntypedBuilder	overrideConfiguration(TransferRequestOverrideConfiguration configuration) Add an optional request override configuration.
<T> DownloadRequest.TypedBuilder<T>	responseTransformer(AsyncResponseTransformer<GetObjectResponse,T> responseTransformer) Specifies the AsyncResponseTransformer that should be used for the download.

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)

overrideConfiguration

DownloadRequest.UntypedBuilder overrideConfiguration(TransferRequestOverrideConfiguration configuration)

Add an optional request override configuration.

Parameters:

configuration - The override configuration.

Returns:

This builder for method chaining.

overrideConfiguration

default DownloadRequest.UntypedBuilder overrideConfiguration(Consumer<TransferRequestOverrideConfiguration.Builder> configurationBuilder)

Similar to overrideConfiguration(TransferRequestOverrideConfiguration), but takes a lambda to configure a new TransferRequestOverrideConfiguration.Builder. This removes the need to call TransferRequestOverrideConfiguration.builder() and TransferRequestOverrideConfiguration.Builder.build().

Parameters:

configurationBuilder - the upload configuration

Returns:

this builder for method chaining.

See Also:

overrideConfiguration(TransferRequestOverrideConfiguration)

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

applyMutation

default <T> DownloadRequest.TypedBuilder<T> applyMutation(Function<DownloadRequest.UntypedBuilder,DownloadRequest.TypedBuilder<T>> mutator)

Like SdkBuilder.applyMutation(Consumer), but accepts a Function that upgrades this DownloadRequest.UntypedBuilder to a DownloadRequest.TypedBuilder. Therefore, the function must also call responseTransformer(AsyncResponseTransformer) to specify the generic type.