Package org.opensearch.client.transport.aws

Class AwsSdk2TransportOptions.DefaultImpl

java.lang.Object

org.opensearch.client.transport.TransportOptions.DefaultImpl

org.opensearch.client.transport.aws.AwsSdk2TransportOptions.DefaultImpl

All Implemented Interfaces:

AwsSdk2TransportOptions, TransportOptions

Enclosing interface:

AwsSdk2TransportOptions

public static class AwsSdk2TransportOptions.DefaultImpl
extends TransportOptions.DefaultImpl
implements AwsSdk2TransportOptions

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.transport.aws.AwsSdk2TransportOptions

AwsSdk2TransportOptions.Builder, AwsSdk2TransportOptions.BuilderImpl, AwsSdk2TransportOptions.DefaultImpl

Nested classes/interfaces inherited from interface org.opensearch.client.transport.TransportOptions

TransportOptions.Builder, TransportOptions.BuilderImpl, TransportOptions.DefaultImpl

Method Summary

Modifier and Type	Method	Description
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 class org.opensearch.client.transport.TransportOptions.DefaultImpl

headers, onWarnings, queryParameters

Methods inherited from class java.lang.Object

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

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

headers, onWarnings, queryParameters, with

Method Details

credentials

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

Description copied from interface: AwsSdk2TransportOptions

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.

Specified by:

credentials in interface AwsSdk2TransportOptions

Returns:

A credentials provider or null

requestCompressionSize

public Integer requestCompressionSize()

Description copied from interface: AwsSdk2TransportOptions

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.

Specified by:

requestCompressionSize in interface AwsSdk2TransportOptions

Returns:

An integer size limit or null

responseCompression

public Boolean responseCompression()

Description copied from interface: AwsSdk2TransportOptions

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.

Specified by:

responseCompression in interface AwsSdk2TransportOptions

Returns:

response compression enable/disable flag, or null

mapper

public JsonpMapper mapper()

Description copied from interface: AwsSdk2TransportOptions

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.

Specified by:

mapper in interface AwsSdk2TransportOptions

Returns:

A mapper or null

signingClock

public Clock signingClock()

Description copied from interface: AwsSdk2TransportOptions

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.

Specified by:

signingClock in interface AwsSdk2TransportOptions

Returns:

A clock or null

toBuilder

public AwsSdk2TransportOptions.Builder toBuilder()

Specified by:

toBuilder in interface AwsSdk2TransportOptions

Specified by:

toBuilder in interface TransportOptions

Overrides:

toBuilder in class TransportOptions.DefaultImpl