software.amazon.awssdk.core.config

Interface ClientOverrideConfiguration.Builder

All Superinterfaces:

CopyableBuilder<ClientOverrideConfiguration.Builder,ClientOverrideConfiguration>, SdkBuilder<ClientOverrideConfiguration.Builder,ClientOverrideConfiguration>

Enclosing class:

ClientOverrideConfiguration

public static interface ClientOverrideConfiguration.Builder
extends CopyableBuilder<ClientOverrideConfiguration.Builder,ClientOverrideConfiguration>

A builder for ClientOverrideConfiguration.

All implementations of this interface are mutable and not thread safe.

Method Summary

Modifier and Type	Method and Description
ClientOverrideConfiguration.Builder	addAdditionalHttpHeader(String header, String... values) Add a header that should be sent with every HTTP request to AWS.
ClientOverrideConfiguration.Builder	addExecutionInterceptor(ExecutionInterceptor executionInterceptor) Add an execution interceptor that will have access to read and modify the request and response objects as they are processed by the SDK.
ClientOverrideConfiguration.Builder	additionalHttpHeaders(Map<String,List<String>> additionalHttpHeaders) Define a set of headers that should be added to every HTTP request sent to AWS.
<T> ClientOverrideConfiguration.Builder	advancedOption(SdkAdvancedClientOption<T> option, T value) Configure an advanced override option.
ClientOverrideConfiguration.Builder	advancedOptions(Map<SdkAdvancedClientOption<?>,?> advancedOptions) Configure the map of advanced override options.
ClientOverrideConfiguration.Builder	executionInterceptors(List<ExecutionInterceptor> executionInterceptors) Configure a list of execution interceptors that will have access to read and modify the request and response objcets as they are processed by the SDK.
ClientOverrideConfiguration.Builder	gzipEnabled(Boolean gzipEnabled) Configure whether GZIP should be used when communicating with AWS.
default ClientOverrideConfiguration.Builder	retryPolicy(Consumer<RetryPolicy.Builder> retryPolicy) Configure the retry policy the should be used when handling failure cases.
ClientOverrideConfiguration.Builder	retryPolicy(RetryPolicy retryPolicy) Configure the retry policy that should be used when handling failure cases.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

additionalHttpHeaders

ClientOverrideConfiguration.Builder additionalHttpHeaders(Map<String,List<String>> additionalHttpHeaders)

Define a set of headers that should be added to every HTTP request sent to AWS. This will override any headers previously added to the builder.

See Also:

ClientOverrideConfiguration.additionalHttpHeaders()

addAdditionalHttpHeader

ClientOverrideConfiguration.Builder addAdditionalHttpHeader(String header,
                                                            String... values)

Add a header that should be sent with every HTTP request to AWS. This will always add a new header to the request, even if that particular header had already been defined.

For example, the following code will result in two different "X-Header" values sent to AWS.

 httpConfiguration.addAdditionalHttpHeader("X-Header", "Value1");
 httpConfiguration.addAdditionalHttpHeader("X-Header", "Value2");
 

See Also:

ClientOverrideConfiguration.additionalHttpHeaders()

gzipEnabled

ClientOverrideConfiguration.Builder gzipEnabled(Boolean gzipEnabled)

Configure whether GZIP should be used when communicating with AWS. Enabling GZIP increases CPU utilization and memory usage, while decreasing the amount of data sent over the network.

See Also:

ClientOverrideConfiguration.gzipEnabled()

retryPolicy

ClientOverrideConfiguration.Builder retryPolicy(RetryPolicy retryPolicy)

Configure the retry policy that should be used when handling failure cases.

See Also:

ClientOverrideConfiguration.retryPolicy()

retryPolicy

default ClientOverrideConfiguration.Builder retryPolicy(Consumer<RetryPolicy.Builder> retryPolicy)

Configure the retry policy the should be used when handling failure cases.

executionInterceptors

ClientOverrideConfiguration.Builder executionInterceptors(List<ExecutionInterceptor> executionInterceptors)

Configure a list of execution interceptors that will have access to read and modify the request and response objcets as they are processed by the SDK. These will replace any interceptors configured previously with this method or addExecutionInterceptor(ExecutionInterceptor). The provided interceptors are executed in the order they are configured and are always later in the order than the ones automatically added by the SDK. See ExecutionInterceptor for a more detailed explanation of interceptor order. This is currently an INTERNAL api, which means it is subject to change and should not be used.

See Also:

ClientOverrideConfiguration.executionInterceptors()

addExecutionInterceptor

ClientOverrideConfiguration.Builder addExecutionInterceptor(ExecutionInterceptor executionInterceptor)

Add an execution interceptor that will have access to read and modify the request and response objects as they are processed by the SDK. Interceptors added using this method are executed in the order they are configured and are always later in the order than the ones automatically added by the SDK. See ExecutionInterceptor for a more detailed explanation of interceptor order. This is currently an INTERNAL api, which means it is subject to change and should not be used.

See Also:

ClientOverrideConfiguration.executionInterceptors()

advancedOption

<T> ClientOverrideConfiguration.Builder advancedOption(SdkAdvancedClientOption<T> option,
                                                       T value)

Configure an advanced override option. These values are used very rarely, and the majority of SDK customers can ignore them.

Type Parameters:

T - The type of the option.

Parameters:

option - The option to configure.

value - The value of the option.

advancedOptions

ClientOverrideConfiguration.Builder advancedOptions(Map<SdkAdvancedClientOption<?>,?> advancedOptions)

Configure the map of advanced override options. This will override all values currently configured. The values in the map must match the key type of the map, or a runtime exception will be raised.