Package org.opensearch.client.transport.aws

Interface AwsSdk2TransportOptions

All Superinterfaces:

TransportOptions

All Known Implementing Classes:

AwsSdk2TransportOptions.DefaultImpl

public interface AwsSdk2TransportOptions
extends TransportOptions

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AwsSdk2TransportOptions.Builder
static class	AwsSdk2TransportOptions.BuilderImpl
static class	AwsSdk2TransportOptions.DefaultImpl

Method Summary

Modifier and Type	Method	Description
static AwsSdk2TransportOptions.Builder	builder()
software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	credentials()	Get the credentials provider to user for signing requests.
JsonpMapper	mapper()	Get mapper used for serializing and deserializing requests and responses.
Integer	requestCompressionSize()	Get the maximum size for uncompressed requests.
Boolean	responseCompression()	Get the response compression enable/disable value.
Clock	signingClock()	Get the clock used for signing requests.
AwsSdk2TransportOptions.Builder	toBuilder()

Methods inherited from interface org.opensearch.client.transport.TransportOptions

headers, onWarnings, queryParameters, with

Method Details

credentials

software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentials()

Get the credentials provider to user for signing requests.

If this is null, then a default provider will be used -- either a provider specified in a more general AwsSdk2TransportOptions that applies to the request, or the default credential chain if there is none.

Returns:

A credentials provider or null

requestCompressionSize

Integer requestCompressionSize()

Get the maximum size for uncompressed requests. Requests larger than this size will be sent with Content-Encoding: gzip.

If this is null, then a default will be used -- either a value specified in a more general AwsSdk2TransportOptions that applies to the request, or a reasonable default if there is none.

If this is Integer.MAX_VALUE, then requests will not be compressed. If this is 0, then all non-empty request bodies will be compressed.

Returns:

An integer size limit or null

responseCompression

Boolean responseCompression()

Get the response compression enable/disable value. If this is true, then an Accept-Encoding: gzip header will be sent with the request. The server will decide whether or not to compress its responses.

If this is null, then a default will be used -- either a value specified in a more general AwsSdk2TransportOptions that applies to the request, or Boolean.TRUE if there is none.

Returns:

response compression enable/disable flag, or null

mapper

JsonpMapper mapper()

Get mapper used for serializing and deserializing requests and responses.

If this is null, then a default will be used -- either a value specified in a more general AwsSdk2TransportOptions that applies to the request, or a new JacksonJsonpMapper or equivalent if there is none.

Returns:

A mapper or null

signingClock

Clock signingClock()

Get the clock used for signing requests.

If this is null, then a default will be used -- either a value specified in a more general AwsSdk2TransportOptions that applies to the request, or Clock.systemUTC() if there is none.

Returns:

A clock or null

toBuilder

AwsSdk2TransportOptions.Builder toBuilder()

Specified by:

toBuilder in interface TransportOptions

builder

static AwsSdk2TransportOptions.Builder builder()