software.amazon.awssdk.transfer.s3

Interface DownloadRequest.TypedBuilder<T>

All Superinterfaces:

Buildable, CopyableBuilder<DownloadRequest.TypedBuilder<T>,DownloadRequest<T>>, SdkBuilder<DownloadRequest.TypedBuilder<T>,DownloadRequest<T>>

Enclosing class:

DownloadRequest<ReturnT>

public static interface DownloadRequest.TypedBuilder<T>
extends CopyableBuilder<DownloadRequest.TypedBuilder<T>,DownloadRequest<T>>

The type-parameterized version of DownloadRequest.UntypedBuilder. This builder's type is inferred as part of specifying DownloadRequest.UntypedBuilder.responseTransformer(AsyncResponseTransformer), after which this builder can be used to construct a DownloadRequest with the same generic type.

Method Summary

Modifier and Type	Method and Description
default DownloadRequest.TypedBuilder<T>	getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder) The GetObjectRequest request that should be used for the download
DownloadRequest.TypedBuilder<T>	getObjectRequest(GetObjectRequest getObjectRequest) The GetObjectRequest request that should be used for the download
default DownloadRequest.TypedBuilder<T>	overrideConfiguration(Consumer<TransferRequestOverrideConfiguration.Builder> configurationBuilder) Similar to overrideConfiguration(TransferRequestOverrideConfiguration), but takes a lambda to configure a new TransferRequestOverrideConfiguration.Builder.
DownloadRequest.TypedBuilder<T>	overrideConfiguration(TransferRequestOverrideConfiguration configuration) Add an optional request override configuration.
DownloadRequest.TypedBuilder<T>	responseTransformer(AsyncResponseTransformer<GetObjectResponse,T> responseTransformer) Specifies the AsyncResponseTransformer that should be used for the download.

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

copy

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

applyMutation, build

Method Detail

getObjectRequest

DownloadRequest.TypedBuilder<T> 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.TypedBuilder<T> 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.TypedBuilder<T> overrideConfiguration(TransferRequestOverrideConfiguration configuration)

Add an optional request override configuration.

Parameters:

configuration - The override configuration.

Returns:

This builder for method chaining.

overrideConfiguration

default DownloadRequest.TypedBuilder<T> 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

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

Specifies the AsyncResponseTransformer that should be used for the download. The generic type used is constrained by the DownloadRequest.UntypedBuilder.responseTransformer(AsyncResponseTransformer) that was previously used to create this DownloadRequest.TypedBuilder.

Parameters:

responseTransformer - the AsyncResponseTransformer

Returns:

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

See Also:

AsyncResponseTransformer