software.amazon.awssdk.transfer.s3

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 and Description
UploadRequest	build()
default UploadRequest.Builder	overrideConfiguration(Consumer<TransferRequestOverrideConfiguration.Builder> configurationBuilder) Similar to overrideConfiguration(TransferRequestOverrideConfiguration), but takes a lambda to configure a new TransferRequestOverrideConfiguration.Builder.
UploadRequest.Builder	overrideConfiguration(TransferRequestOverrideConfiguration configuration) Add an optional request override configuration.
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.

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

copy

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

applyMutation

Method Detail

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)

overrideConfiguration

UploadRequest.Builder overrideConfiguration(TransferRequestOverrideConfiguration configuration)

Add an optional request override configuration.

Parameters:

configuration - The override configuration.

Returns:

This builder for method chaining.

overrideConfiguration

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

build

UploadRequest build()

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<UploadRequest.Builder,UploadRequest>

Returns:

The built request.