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
All Methods Instance Methods Abstract Methods 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 Detail
-
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 viaS3AsyncClient.crtBuilder()
orS3AsyncClient.crtCreate()
), OR the underlyingS3AsyncClient
has multipart enabled (S3AsyncClientBuilder.multipartConfiguration(MultipartConfiguration)
orS3AsyncClientBuilder.multipartEnabled(Boolean)
). It will throwUnsupportedOperationException
if theS3TransferManager
is created with a non CRT-based S3 client (created viaS3AsyncClient.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 interfaceTransfer
- Returns:
- The future that will be completed when this transfer is complete.
-
-