Package software.amazon.awssdk.core.internal.async

Class FileAsyncRequestBody

java.lang.Object

software.amazon.awssdk.core.internal.async.FileAsyncRequestBody

All Implemented Interfaces:

org.reactivestreams.Publisher<ByteBuffer>, AsyncRequestBody, SdkPublisher<ByteBuffer>

public final class FileAsyncRequestBody
extends Object
implements AsyncRequestBody

Implementation of AsyncRequestBody that reads data from a file.

See Also:

AsyncRequestBody.fromFile(Path), AsyncRequestBody.fromFile(java.io.File)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FileAsyncRequestBody.Builder	A builder for FileAsyncRequestBody.

Method Summary

Modifier and Type	Method	Description
static FileAsyncRequestBody.Builder	builder()
int	chunkSizeInBytes()
Optional<Long>	contentLength()
String	contentType()
long	fileLength()
long	numBytesToRead()
Path	path()
long	position()
SdkPublisher<AsyncRequestBody>	split(AsyncRequestBodySplitConfiguration splitConfiguration)	Converts this AsyncRequestBody to a publisher of AsyncRequestBodys, each of which publishes a specific portion of the original data, based on the provided AsyncRequestBodySplitConfiguration.
void	subscribe(org.reactivestreams.Subscriber<? super ByteBuffer> s)

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.core.async.AsyncRequestBody

split

Methods inherited from interface software.amazon.awssdk.core.async.SdkPublisher

addTrailingData, buffer, doAfterOnCancel, doAfterOnComplete, doAfterOnError, filter, filter, flatMapIterable, limit, map, subscribe

Method Detail

split

public SdkPublisher<AsyncRequestBody> split(AsyncRequestBodySplitConfiguration splitConfiguration)

Description copied from interface: AsyncRequestBody

Converts this AsyncRequestBody to a publisher of AsyncRequestBodys, each of which publishes a specific portion of the original data, based on the provided AsyncRequestBodySplitConfiguration. The default chunk size is 2MB and the default buffer size is 8MB.

By default, if content length of this AsyncRequestBody is present, each divided AsyncRequestBody is delivered to the subscriber right after it's initialized. On the other hand, if content length is null, it is sent after the entire content for that chunk is buffered. In this case, the configured maxMemoryUsageInBytes must be larger than or equal to chunkSizeInBytes. Note that this behavior may be different if a specific implementation of this interface overrides this method.

Specified by:

split in interface AsyncRequestBody

See Also:

AsyncRequestBodySplitConfiguration

path

public Path path()

fileLength

public long fileLength()

chunkSizeInBytes

public int chunkSizeInBytes()

position

public long position()

numBytesToRead

public long numBytesToRead()

contentLength

public Optional<Long> contentLength()

Specified by:

contentLength in interface AsyncRequestBody

Returns:

The content length of the data being produced.

contentType

public String contentType()

Specified by:

contentType in interface AsyncRequestBody

Returns:

The content type of the data being produced.

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super ByteBuffer> s)

Specified by:

subscribe in interface org.reactivestreams.Publisher<ByteBuffer>

builder

public static FileAsyncRequestBody.Builder builder()

Returns:

Builder instance to construct a FileAsyncRequestBody.