software.amazon.awssdk.transfer.s3

Class UploadFileRequest

java.lang.Object

software.amazon.awssdk.transfer.s3.UploadFileRequest

All Implemented Interfaces:

TransferObjectRequest, TransferRequest, ToCopyableBuilder<UploadFileRequest.Builder,UploadFileRequest>

public final class UploadFileRequest
extends Object
implements TransferObjectRequest, ToCopyableBuilder<UploadFileRequest.Builder,UploadFileRequest>

Upload a local file to an object in S3. For non-file-based uploads, you may use UploadRequest instead.

See Also:

S3TransferManager.uploadFile(UploadFileRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UploadFileRequest.Builder A builder for a UploadFileRequest, created with builder()

Method Summary

Modifier and Type	Method and Description
static UploadFileRequest.Builder	builder() Create a builder that can be used to create a UploadFileRequest.
boolean	equals(Object o)
int	hashCode()
Optional<TransferRequestOverrideConfiguration>	overrideConfiguration()
PutObjectRequest	putObjectRequest()
static Class<? extends UploadFileRequest.Builder>	serializableBuilderClass()
Path	source() The Path containing data to send to the service.
UploadFileRequest.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

putObjectRequest

public PutObjectRequest putObjectRequest()

Returns:

The PutObjectRequest request that should be used for the upload

source

public Path source()

The Path containing data to send to the service.

Returns:

the request body

overrideConfiguration

public Optional<TransferRequestOverrideConfiguration> overrideConfiguration()

Specified by:

overrideConfiguration in interface TransferObjectRequest

Returns:

the optional override configuration

See Also:

UploadFileRequest.Builder.overrideConfiguration(TransferRequestOverrideConfiguration)

builder

public static UploadFileRequest.Builder builder()

Create a builder that can be used to create a UploadFileRequest.

See Also:

S3TransferManager.uploadFile(UploadFileRequest)

serializableBuilderClass

public static Class<? extends UploadFileRequest.Builder> serializableBuilderClass()

toBuilder

public UploadFileRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UploadFileRequest.Builder,UploadFileRequest>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object