software.amazon.awssdk.core

Interface RequestOverrideConfiguration.Builder<B extends RequestOverrideConfiguration.Builder>

All Known Subinterfaces:

SdkRequestOverrideConfiguration.Builder

All Known Implementing Classes:

RequestOverrideConfiguration.BuilderImpl

Enclosing class:

RequestOverrideConfiguration

public static interface RequestOverrideConfiguration.Builder<B extends RequestOverrideConfiguration.Builder>

Method Summary

Modifier and Type	Method and Description
B	addApiName(ApiName apiName) Set the optional name of the higher level library that constructed the request.
B	addApiName(Consumer<ApiName.Builder> apiNameConsumer) Set the optional name of the higher level library that constructed the request.
List<ApiName>	apiNames() The optional names of the higher level libraries that constructed the request.
RequestOverrideConfiguration	build() Create a new SdkRequestOverrideConfiguration with the properties set on this builder.
Map<String,List<String>>	headers() Optional additional headers to be added to the HTTP request.
B	headers(Map<String,List<String>> headers) Add additional headers to be set on the HTTP request.
B	putHeader(String name, List<String> values) Add a single header with multiple values to be set on the HTTP request.
default B	putHeader(String name, String value) Add a single header to be set on the HTTP request.
B	putRawQueryParameter(String name, List<String> values) Add a single query parameter with multiple values to be set on the HTTP request.
default B	putRawQueryParameter(String name, String value) Add a single query parameter to be set on the HTTP request.
Map<String,List<String>>	rawQueryParameters() Optional additional query parameters to be added to the HTTP request.
B	rawQueryParameters(Map<String,List<String>> rawQueryParameters) Configure query parameters to be set on the HTTP request.

Method Detail

headers

Map<String,List<String>> headers()

Optional additional headers to be added to the HTTP request.

Returns:

The optional additional headers.

putHeader

default B putHeader(String name,
                    String value)

Add a single header to be set on the HTTP request.

This overrides any values already configured with this header name in the builder.

Parameters:

name - The name of the header.

value - The value of the header.

Returns:

This object for method chaining.

putHeader

B putHeader(String name,
            List<String> values)

Add a single header with multiple values to be set on the HTTP request.

This overrides any values already configured with this header name in the builder.

Parameters:

name - The name of the header.

values - The values of the header.

Returns:

This object for method chaining.

headers

B headers(Map<String,List<String>> headers)

Add additional headers to be set on the HTTP request.

This completely overrides any values currently configured in the builder.

Parameters:

headers - The set of additional headers.

Returns:

This object for method chaining.

rawQueryParameters

Map<String,List<String>> rawQueryParameters()

Optional additional query parameters to be added to the HTTP request.

Returns:

The optional additional query parameters.

putRawQueryParameter

default B putRawQueryParameter(String name,
                               String value)

Add a single query parameter to be set on the HTTP request.

This overrides any values already configured with this query name in the builder.

Parameters:

name - The query parameter name.

value - The query parameter value.

Returns:

This object for method chaining.

putRawQueryParameter

B putRawQueryParameter(String name,
                       List<String> values)

Add a single query parameter with multiple values to be set on the HTTP request.

This overrides any values already configured with this query name in the builder.

Parameters:

name - The query parameter name.

values - The query parameter values.

Returns:

This object for method chaining.

rawQueryParameters

B rawQueryParameters(Map<String,List<String>> rawQueryParameters)

Configure query parameters to be set on the HTTP request.

This completely overrides any query parameters currently configured in the builder.

Parameters:

rawQueryParameters - The set of additional query parameters.

Returns:

This object for method chaining.

apiNames

List<ApiName> apiNames()

The optional names of the higher level libraries that constructed the request.

Returns:

The names of the libraries.

addApiName

B addApiName(ApiName apiName)

Set the optional name of the higher level library that constructed the request.

Parameters:

apiName - The name of the library.

Returns:

This object for method chaining.

addApiName

B addApiName(Consumer<ApiName.Builder> apiNameConsumer)

Set the optional name of the higher level library that constructed the request.

Parameters:

apiNameConsumer - A Consumer that accepts a ApiName.Builder.

Returns:

This object for method chaining.

build

RequestOverrideConfiguration build()

Create a new SdkRequestOverrideConfiguration with the properties set on this builder.

Returns:

The new SdkRequestOverrideConfiguration.