software.amazon.awssdk.transfer.s3

Interface DownloadRequest.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DownloadRequest.Builder,DownloadRequest>, SdkBuilder<DownloadRequest.Builder,DownloadRequest>, TransferRequest.Builder<DownloadRequest,DownloadRequest.Builder>

Enclosing class:

DownloadRequest

@NotThreadSafe
public static interface DownloadRequest.Builder
extends TransferRequest.Builder<DownloadRequest,DownloadRequest.Builder>, CopyableBuilder<DownloadRequest.Builder,DownloadRequest>

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

Method Summary

Modifier and Type	Method and Description
DownloadRequest	build()
DownloadRequest.Builder	destination(Path destination) The Path to file that response contents will be written to.
default DownloadRequest.Builder	getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder) The GetObjectRequest request that should be used for the download
DownloadRequest.Builder	getObjectRequest(GetObjectRequest getObjectRequest) The GetObjectRequest request 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

Method Detail

destination

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

getObjectRequest

DownloadRequest.Builder 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.Builder 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)

build

DownloadRequest build()

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<DownloadRequest.Builder,DownloadRequest>

Specified by:

build in interface TransferRequest.Builder<DownloadRequest,DownloadRequest.Builder>

Returns:

The built request.