software.amazon.awssdk.transfer.s3

Interface UploadFileRequest.Builder

All Superinterfaces:

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

Enclosing class:

UploadFileRequest

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

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

Method Summary

Modifier and Type	Method and Description
default UploadFileRequest.Builder	overrideConfiguration(Consumer<TransferRequestOverrideConfiguration.Builder> configurationBuilder) Similar to overrideConfiguration(TransferRequestOverrideConfiguration), but takes a lambda to configure a new TransferRequestOverrideConfiguration.Builder.
UploadFileRequest.Builder	overrideConfiguration(TransferRequestOverrideConfiguration configuration) Add an optional request override configuration.
default UploadFileRequest.Builder	putObjectRequest(Consumer<PutObjectRequest.Builder> putObjectRequestBuilder) Configure the PutObjectRequest that should be used for the upload
UploadFileRequest.Builder	putObjectRequest(PutObjectRequest putObjectRequest) Configure the PutObjectRequest that should be used for the upload
default UploadFileRequest.Builder	source(File source) The file containing data to send to the service.
UploadFileRequest.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, build

Method Detail

source

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

source

default UploadFileRequest.Builder source(File source)

The 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

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

UploadFileRequest.Builder overrideConfiguration(TransferRequestOverrideConfiguration configuration)

Add an optional request override configuration.

Parameters:

configuration - The override configuration.

Returns:

This builder for method chaining.

overrideConfiguration

default UploadFileRequest.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)