Package software.amazon.awssdk.crt.s3

Class S3MetaRequest

java.lang.Object

software.amazon.awssdk.crt.CrtResource

software.amazon.awssdk.crt.s3.S3MetaRequest

All Implemented Interfaces:

AutoCloseable

public class S3MetaRequest
extends CrtResource

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.awssdk.crt.CrtResource

CrtResource.ResourceInstance

Constructor Summary

Constructors

Constructor	Description
S3MetaRequest()

Method Summary

Modifier and Type	Method	Description
void	cancel()
CompletableFuture<Void>	getShutdownCompleteFuture()
void	incrementReadWindow(long bytes)	Increment the flow-control window, so that response data continues downloading.
ResumeToken	pause()	Pauses meta request and returns a token that can be used to resume a meta request.

Methods inherited from class software.amazon.awssdk.crt.CrtResource

addRef, addReferenceTo, close, collectNativeResource, collectNativeResources, decRef, getNativeHandle, getResourceLogDescription, isNull, logNativeResources, logNativeResources, removeReferenceTo, setDescription, waitForNoResources

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

S3MetaRequest

public S3MetaRequest()

Method Detail

getShutdownCompleteFuture

public CompletableFuture<Void> getShutdownCompleteFuture()

cancel

public void cancel()

pause

public ResumeToken pause()

Pauses meta request and returns a token that can be used to resume a meta request. For PutObject resume, input stream should always start at the beginning, already uploaded parts will be skipped, but checksums on those will be verified if request specified checksum algo.

Returns:

token to resume request. might be null if request has not started executing yet

incrementReadWindow

public void incrementReadWindow(long bytes)

Increment the flow-control window, so that response data continues downloading.

If the client was created with S3ClientOptions.withReadBackpressureEnabled(boolean) set true, each S3MetaRequest has a flow-control window that shrinks as response body data is downloaded (headers do not affect the size of the window). S3ClientOptions.withInitialReadWindowSize(long) sets the starting size for each S3MetaRequest's window. Whenever the window reaches zero, data stops downloading. Increment the window to keep data flowing. Maintain a larger window to keep up a high download throughput, parts cannot download in parallel unless the window is large enough to hold multiple parts. Maintain a smaller window to limit the amount of data buffered in memory.

If backpressure is disabled this call has no effect, data is downloaded as fast as possible.

WARNING: This feature is experimental. Currently, backpressure is only applied to GetObject requests which are split into multiple parts, and you may still receive some data after the window reaches zero.

Parameters:

bytes - size to increment window by

See Also:

S3ClientOptions.withReadBackpressureEnabled(boolean)