Package com.mongodb.stitch.android.services.aws

Interface AwsServiceClient

All Known Implementing Classes:

AwsServiceClientImpl

public interface AwsServiceClient

The AWS service client.

Field Summary

Fields

Modifier and Type	Field	Description
static NamedServiceClientFactory<AwsServiceClient>	factory

Method Summary

Modifier and Type	Method	Description
Task<Void>	execute(AwsRequest request)	Executes the AWS request.
<ResultT> Task<ResultT>	execute(AwsRequest request, Class<ResultT> resultClass)	Executes the AWS request, and decodes the result into an instance of the specified type.
<ResultT> Task<ResultT>	execute(AwsRequest request, Class<ResultT> resultClass, CodecRegistry codecRegistry)	Executes the AWS request, and decodes the result into an instance of the specified type.
Task<Void>	execute(AwsRequest request, Long requestTimeout)	Executes the AWS request.
<ResultT> Task<ResultT>	execute(AwsRequest request, Long requestTimeout, Class<ResultT> resultClass)	Executes the AWS request, and decodes the result into an instance of the specified type.
<ResultT> Task<ResultT>	execute(AwsRequest request, Long requestTimeout, Class<ResultT> resultClass, CodecRegistry codecRegistry)	Executes the AWS request, and decodes the result into an instance of the specified type.
<ResultT> Task<ResultT>	execute(AwsRequest request, Long requestTimeout, Decoder<ResultT> resultDecoder)	Executes the AWS request, and decodes the result into an instance of the specified type.
<ResultT> Task<ResultT>	execute(AwsRequest request, Decoder<ResultT> resultDecoder)	Executes the AWS request, and decodes the result into an instance of the specified type.
CodecRegistry	getCodecRegistry()	Get the codec registry that will be used to decode responses when a codec registry.
AwsServiceClient	withCodecRegistry(CodecRegistry codecRegistry)	Create a new AwsServiceClient instance with a different codec registry.

Field Detail

factory

static final NamedServiceClientFactory<AwsServiceClient> factory

Method Detail

execute

Task<Void> execute(@Nonnull
                   AwsRequest request)

Executes the AWS request.

Parameters:

request - the AWS request to execute.

Returns:

a task that completes when the request completes.

execute

<ResultT> Task<ResultT> execute(@Nonnull
                                AwsRequest request,
                                @Nonnull
                                Decoder<ResultT> resultDecoder)

Executes the AWS request, and decodes the result into an instance of the specified type. The response will be decoded using the codec registry specified when the app client was configured. If no codec registry was configured, a default codec registry will be used. The default codec registry supports the mappings specified here

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

request - the AWS request to execute.

resultDecoder - the Decoder to use to decode the result into a value.

Returns:

a task containing the decoded result value.

execute

<ResultT> Task<ResultT> execute(@Nonnull
                                AwsRequest request,
                                @Nonnull
                                Class<ResultT> resultClass)

Executes the AWS request, and decodes the result into an instance of the specified type. The response will be decoded using the codec registry specified when the app client was configured. If no codec registry was configured, a default codec registry will be used. The default codec registry supports the mappings specified here

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

request - the AWS request to execute.

resultClass - the class that the result should be decoded as.

Returns:

a task containing the decoded result value.

execute

<ResultT> Task<ResultT> execute(@Nonnull
                                AwsRequest request,
                                @Nonnull
                                Class<ResultT> resultClass,
                                @Nonnull
                                CodecRegistry codecRegistry)

Executes the AWS request, and decodes the result into an instance of the specified type. The response will be decoded using the codec registry given.

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

request - the AWS request to execute.

resultClass - the class that the result should be decoded as.

codecRegistry - the codec registry used for de/serialization of the function call.

Returns:

a task containing the decoded result value.

execute

Task<Void> execute(@Nonnull
                   AwsRequest request,
                   @Nonnull
                   Long requestTimeout)

Executes the AWS request.

Parameters:

request - the AWS request to execute.

requestTimeout - the number of milliseconds the client should wait for a response from the server before failing with an error.

Returns:

a task that completes when the request completes.

execute

<ResultT> Task<ResultT> execute(@Nonnull
                                AwsRequest request,
                                @Nonnull
                                Long requestTimeout,
                                @Nonnull
                                Decoder<ResultT> resultDecoder)

Executes the AWS request, and decodes the result into an instance of the specified type. The response will be decoded using the codec registry specified when the app client was configured. If no codec registry was configured, a default codec registry will be used. The default codec registry supports the mappings specified here

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

request - the AWS request to execute.

requestTimeout - the number of milliseconds the client should wait for a response from the server before failing with an error.

resultDecoder - the Decoder to use to decode the result into a value.

Returns:

a task containing the decoded result value.

execute

<ResultT> Task<ResultT> execute(@Nonnull
                                AwsRequest request,
                                @Nonnull
                                Long requestTimeout,
                                @Nonnull
                                Class<ResultT> resultClass)

Executes the AWS request, and decodes the result into an instance of the specified type. The response will be decoded using the codec registry specified when the app client was configured. If no codec registry was configured, a default codec registry will be used. The default codec registry supports the mappings specified here

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

request - the AWS request to execute.

requestTimeout - the number of milliseconds the client should wait for a response from the server before failing with an error.

resultClass - the class that the result should be decoded as.

Returns:

a task containing the decoded result value.

execute

<ResultT> Task<ResultT> execute(@Nonnull
                                AwsRequest request,
                                @Nonnull
                                Long requestTimeout,
                                @Nonnull
                                Class<ResultT> resultClass,
                                @Nonnull
                                CodecRegistry codecRegistry)

Executes the AWS request, and decodes the result into an instance of the specified type. The response will be decoded using the codec registry given.

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

request - the AWS request to execute.

requestTimeout - the number of milliseconds the client should wait for a response from the server before failing with an error.

resultClass - the class that the result should be decoded as.

codecRegistry - the codec registry used for de/serialization of the function call.

Returns:

a task containing the decoded result value.

getCodecRegistry

CodecRegistry getCodecRegistry()

Get the codec registry that will be used to decode responses when a codec registry.

Returns:

a task containing the CodecRegistry

withCodecRegistry

AwsServiceClient withCodecRegistry(@Nonnull
                                   CodecRegistry codecRegistry)

Create a new AwsServiceClient instance with a different codec registry.

Parameters:

codecRegistry - the new CodecRegistry for the client.

Returns:

a new AwsServiceClient instance with the different codec registry