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

Interface FileUpload

All Superinterfaces:

ObjectTransfer, Transfer

All Known Implementing Classes:

CrtFileUpload, DefaultFileUpload

public interface FileUpload
extends ObjectTransfer

An upload transfer of a single object to S3.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<CompletedFileUpload>	completionFuture()
ResumableFileUpload	pause()	Pauses the current upload operation and return the information that can be used to resume the upload at a later time.

Methods inherited from interface software.amazon.awssdk.transfer.s3.model.ObjectTransfer

progress

Method Details

pause

ResumableFileUpload pause()

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.

Returns:

A ResumableFileUpload that can be used to resume the upload.

completionFuture

CompletableFuture<CompletedFileUpload> completionFuture()

Specified by:

completionFuture in interface Transfer

Returns:

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