Class FileAsyncResponseTransformer<ResponseT>

java.lang.Object

software.amazon.awssdk.core.internal.async.FileAsyncResponseTransformer<ResponseT>

Type Parameters:

ResponseT - Response POJO type.

All Implemented Interfaces:

AsyncResponseTransformer<ResponseT,ResponseT>

public final class FileAsyncResponseTransformer<ResponseT>
extends Object
implements AsyncResponseTransformer<ResponseT,ResponseT>

AsyncResponseTransformer that writes the data to the specified file.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awssdk.core.async.AsyncResponseTransformer

AsyncResponseTransformer.SplitResult<ResponseT,ResultT>

Constructor Summary

Constructors

Constructor	Description
FileAsyncResponseTransformer(Path path)
FileAsyncResponseTransformer(Path path, FileTransformerConfiguration fileConfiguration)

Method Summary

Modifier and Type	Method	Description
void	exceptionOccurred(Throwable throwable)	Called when an error is encountered while making the request or receiving the response.
void	onResponse(ResponseT response)	Called when the unmarshalled response object is ready.
void	onStream(SdkPublisher<ByteBuffer> publisher)	Called when the response stream is ready.
CompletableFuture<ResponseT>	prepare()	Initial call to enable any setup required before the response is handled.

Methods inherited from class java.lang.Object

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

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

split, split

Constructor Details

FileAsyncResponseTransformer

public FileAsyncResponseTransformer(Path path)

FileAsyncResponseTransformer

public FileAsyncResponseTransformer(Path path,
 FileTransformerConfiguration fileConfiguration)

Method Details

prepare

public CompletableFuture<ResponseT> prepare()

Description copied from interface: AsyncResponseTransformer

Initial call to enable any setup required before the response is handled.

Note that this will be called for each request attempt, up to the number of retries allowed by the configured RetryPolicy.

This method is guaranteed to be called before the request is executed, and before AsyncResponseTransformer.onResponse(Object) is signaled.

Specified by:

prepare in interface AsyncResponseTransformer<ResponseT,ResponseT>

Returns:

The future holding the transformed response.

onResponse

public void onResponse(ResponseT response)

Description copied from interface: AsyncResponseTransformer

Called when the unmarshalled response object is ready.

Specified by:

onResponse in interface AsyncResponseTransformer<ResponseT,ResponseT>

Parameters:

response - The unmarshalled response.

onStream

public void onStream(SdkPublisher<ByteBuffer> publisher)

Description copied from interface: AsyncResponseTransformer

Called when the response stream is ready.

Specified by:

onStream in interface AsyncResponseTransformer<ResponseT,ResponseT>

Parameters:

publisher - The publisher.

exceptionOccurred

public void exceptionOccurred(Throwable throwable)

Description copied from interface: AsyncResponseTransformer

Called when an error is encountered while making the request or receiving the response. Implementations should free up any resources in this method. This method may be called multiple times during the lifecycle of a request if automatic retries are enabled.

Specified by:

exceptionOccurred in interface AsyncResponseTransformer<ResponseT,ResponseT>

Parameters:

throwable - Error that occurred.