software.amazon.awssdk.transfer.s3

Interface UploadRequest.Builder

All Superinterfaces:

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

Enclosing class:

UploadRequest

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

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

Method Summary

Modifier and Type	Method and Description
UploadRequest	build()
default UploadRequest.Builder	putObjectRequest(Consumer<PutObjectRequest.Builder> putObjectRequestBuilder) Configure the PutObjectRequest that should be used for the upload
UploadRequest.Builder	putObjectRequest(PutObjectRequest putObjectRequest) Configure the PutObjectRequest that should be used for the upload
UploadRequest.Builder	source(Path source) The Path to file containing data to send to the service.

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

copy

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

applyMutation

Method Detail

source

UploadRequest.Builder source(Path source)

The Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown.

Parameters:

source - the source path

Returns:

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

putObjectRequest

UploadRequest.Builder putObjectRequest(PutObjectRequest putObjectRequest)

Configure the PutObjectRequest that should be used for the upload

Parameters:

putObjectRequest - the putObjectRequest

Returns:

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

See Also:

putObjectRequest(Consumer)

putObjectRequest

default UploadRequest.Builder putObjectRequest(Consumer<PutObjectRequest.Builder> putObjectRequestBuilder)

Configure the PutObjectRequest that should be used for the upload

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

Parameters:

putObjectRequestBuilder - the putObjectRequest consumer builder

Returns:

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

See Also:

putObjectRequest(PutObjectRequest)

build

UploadRequest build()

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<UploadRequest.Builder,UploadRequest>

Specified by:

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

Returns:

The built request.