com.amazonaws.opensdk

Class SdkRequestConfig.Builder

java.lang.Object

com.amazonaws.opensdk.SdkRequestConfig.Builder

Enclosing class:

SdkRequestConfig

public static class SdkRequestConfig.Builder
extends Object

Interface for building a SdkRequestConfig object.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SdkRequestConfig	build() Builds the SdkRequestConfig with the current state of the builder.
SdkRequestConfig.Builder	customHeader(String name, String value) Put a new custom header to the map of custom header names to custom header values.
SdkRequestConfig.Builder	customQueryParam(String name, String value) Add a custom query parameter for the request.
SdkRequestConfig.Builder	httpRequestTimeout(int httpRequestTimeout) Sets the amount of time to wait (in milliseconds) for a single HTTP request to complete before giving up and timing out.
SdkRequestConfig.Builder	totalExecutionTimeout(int totalExecutionTimeout) Sets the amount of time (in milliseconds) to allow the client to complete the execution of an API call.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

httpRequestTimeout

public SdkRequestConfig.Builder httpRequestTimeout(int httpRequestTimeout)

Sets the amount of time to wait (in milliseconds) for a single HTTP request to complete before giving up and timing out.

This feature requires buffering the entire response (for non-streaming APIs) into memory to enforce a hard timeout when reading the response. For APIs that return large responses this could be expensive.

The http request timeout feature doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The typical case aborts the request within a few milliseconds but there may occasionally be requests that don't get aborted until several seconds after the timer has been breached. Because of this, this feature should not be used when absolute precision is needed.

This timeout is disabled by default.

Parameters:

httpRequestTimeout - The amount of time to wait (in milliseconds) for the request to complete before giving up and timing out. A non-positive value disables the timeout for this request.

Returns:

This object for method chaining.

See Also:

#totalExecutionTimeout(int)} to enforce a timeout across all retries

totalExecutionTimeout

public SdkRequestConfig.Builder totalExecutionTimeout(int totalExecutionTimeout)

Sets the amount of time (in milliseconds) to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes all HTTP requests (even retries), unmarshalling, etc.

This feature requires buffering the entire response (for non-streaming APIs) into memory to enforce a hard timeout when reading the response. For APIs that return large responses this could be expensive.

The total execution timeout feature doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The typical case aborts the request within a few milliseconds but there may occasionally be requests that don't get aborted until several seconds after the timer has been breached. Because of this, the client execution timeout feature should not be used when absolute precision is needed.

This timeout is disabled by default.

Parameters:

totalExecutionTimeout - The amount of time (in milliseconds) to allow the client to complete the execution of an API call. A non-positive value disables the timeout for this request.

Returns:

This object for method chaining.

See Also:

#httpRequestTimeout(int)} to enforce a timeout per HTTP request

customHeader

public SdkRequestConfig.Builder customHeader(String name,
                                             String value)

Put a new custom header to the map of custom header names to custom header values.

NOTE: Custom header values set via this method will overwrite any conflicting values coming from the request parameters.

Parameters:

name - The name of the header to add

value - The value of the header to add

Returns:

This object for method chaining.

customQueryParam

public SdkRequestConfig.Builder customQueryParam(String name,
                                                 String value)

Add a custom query parameter for the request. Since multiple values are allowed for the same query parameter, this method does NOT overwrite any existing parameter values in the request.

Parameters:

name - The name of the query parameter

value - The value of the query parameter. Only the parameter name will be added in the URI if the value is set to null. For example, customQueryParameter("param", null) will be serialized to "?param", while customQueryParameter("param", "") will be serialized to "?param=".

Returns:

This object for method chaining.

build

public SdkRequestConfig build()

Builds the SdkRequestConfig with the current state of the builder.

Returns:

Immutable SdkRequestConfig object. See BaseRequest.sdkRequestConfig(SdkRequestConfig).