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

Class DefaultFileUpload

java.lang.Object

software.amazon.awssdk.transfer.s3.internal.model.DefaultFileUpload

All Implemented Interfaces:

FileUpload, ObjectTransfer, Transfer

public final class DefaultFileUpload
extends Object
implements FileUpload

Constructor Summary

Constructors

Constructor	Description
DefaultFileUpload(CompletableFuture<CompletedFileUpload> completionFuture, TransferProgress progress, PauseObservable pauseObservable, UploadFileRequest request)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<CompletedFileUpload>	completionFuture()
boolean	equals(Object o)
int	hashCode()
ResumableFileUpload	pause()	Pauses the current upload operation and return the information that can be used to resume the upload at a later time.
TransferProgress	progress()	The stateful TransferProgress associated with this transfer.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DefaultFileUpload

public DefaultFileUpload(CompletableFuture<CompletedFileUpload> completionFuture,
 TransferProgress progress,
 PauseObservable pauseObservable,
 UploadFileRequest request)

Method Details

pause

public ResumableFileUpload pause()

Description copied from interface: FileUpload

Pauses the current upload operation and return the information that can be used to resume the upload at a later time.

The information object is serializable for persistent storage until it should be resumed. See ResumableFileUpload for supported formats.

Currently, it's only supported if the underlying S3AsyncClient is CRT-based (created via S3AsyncClient.crtBuilder() or S3AsyncClient.crtCreate()), OR the underlying S3AsyncClient has multipart enabled (S3AsyncClientBuilder.multipartConfiguration(MultipartConfiguration) or S3AsyncClientBuilder.multipartEnabled(Boolean)). It will throw UnsupportedOperationException if the S3TransferManager is created with a non CRT-based S3 client (created via S3AsyncClient.builder()) and does not have multipart configuration enabled.

Specified by:

pause in interface FileUpload

Returns:

A ResumableFileUpload that can be used to resume the upload.

completionFuture

public CompletableFuture<CompletedFileUpload> completionFuture()

Specified by:

completionFuture in interface FileUpload

Specified by:

completionFuture in interface Transfer

Returns:

The future that will be completed when this transfer is complete.

progress

public TransferProgress progress()

Description copied from interface: ObjectTransfer

The stateful TransferProgress associated with this transfer.

Specified by:

progress in interface ObjectTransfer

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