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

Interface UploadRequest.Builder

All Superinterfaces:

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

Enclosing class:

UploadRequest

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

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

Method Summary

Modifier and Type	Method	Description
UploadRequest.Builder	addTransferListener(TransferListener transferListener)	Add a TransferListener that will be notified as part of this request.
UploadRequest	build()	An immutable object that is created from the properties that have been set on the builder.
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	requestBody(AsyncRequestBody requestBody)	The AsyncRequestBody containing the data to send to the service.
UploadRequest.Builder	transferListeners(Collection<TransferListener> transferListeners)	The TransferListeners that will be notified as part of this request.

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

copy

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

applyMutation

Method Details

requestBody

UploadRequest.Builder requestBody(AsyncRequestBody requestBody)

The AsyncRequestBody containing the data to send to the service. Request bodies may be declared using one of the static factory methods in the AsyncRequestBody class.

Parameters:

requestBody - the request body

Returns:

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

See Also:

• AsyncRequestBody

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)

transferListeners

UploadRequest.Builder 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

UploadRequest.Builder addTransferListener(TransferListener transferListener)

Add 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

build

UploadRequest build()

Description copied from interface: SdkBuilder

An immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<UploadRequest.Builder,UploadRequest>

Returns:

The built request.