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

Class UploadFileRequest

java.lang.Object

software.amazon.awssdk.transfer.s3.model.UploadFileRequest

All Implemented Interfaces:

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

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

Represents the request to 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	Description
static interface	UploadFileRequest.Builder	A builder for a UploadFileRequest, created with builder()

Method Summary

Modifier and Type	Method	Description
static UploadFileRequest.Builder	builder()	Creates a builder that can be used to create a UploadFileRequest.
boolean	equals(Object o)
int	hashCode()
PutObjectRequest	putObjectRequest()
static Class<? extends UploadFileRequest.Builder>	serializableBuilderClass()
Path	source()	The Path containing data to send to the service.
UploadFileRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<TransferListener>	transferListeners()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

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

transferListeners

public List<TransferListener> transferListeners()

Specified by:

transferListeners in interface TransferObjectRequest

Returns:

the List of transferListeners.

builder

public static UploadFileRequest.Builder builder()

Creates 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UploadFileRequest.Builder,UploadFileRequest>

Returns:

a builder for type T

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