public class ClientOverrideConfiguration extends Object implements ToCopyableBuilder<ClientOverrideConfiguration.Builder,ClientOverrideConfiguration>
Use builder()
to create a set of options.
Modifier and Type | Class and Description |
---|---|
static interface |
ClientOverrideConfiguration.Builder
A builder for
ClientOverrideConfiguration . |
Modifier and Type | Method and Description |
---|---|
Map<String,List<String>> |
additionalHttpHeaders()
An unmodifiable representation of the set of HTTP headers that should be sent with every request.
|
<T> T |
advancedOption(AdvancedClientOption<T> option)
Load the requested advanced option that was configured on the client builder.
|
static ClientOverrideConfiguration.Builder |
builder()
Create a
ClientOverrideConfiguration.Builder , used to create a ClientOverrideConfiguration . |
Boolean |
gzipEnabled()
Whether GZIP should be used when communication with AWS.
|
Duration |
httpRequestTimeout()
The amount of time to wait for the request to complete before giving up and timing out.
|
List<ExecutionInterceptor> |
lastExecutionInterceptors()
An immutable collection of
ExecutionInterceptor s that should be hooked into the execution of each request, in the
order that they should be applied. |
RetryPolicy |
retryPolicy()
The retry policy that should be used when handling failure cases.
|
ClientOverrideConfiguration.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Duration |
totalExecutionTimeout()
The amount of time to allow the client to complete the execution of an API call.
|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
copy
public ClientOverrideConfiguration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ClientOverrideConfiguration.Builder,ClientOverrideConfiguration>
public static ClientOverrideConfiguration.Builder builder()
ClientOverrideConfiguration.Builder
, used to create a ClientOverrideConfiguration
.public Duration httpRequestTimeout()
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 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, the request timeout feature should not be used when absolute precision is needed.
public Duration totalExecutionTimeout()
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 client 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 may be used together with httpRequestTimeout()
to enforce both a timeout on each individual HTTP request
(i.e. each retry) and the total time spent on all requests across retries (i.e. the 'client execution' time). A
non-positive value disables this feature.
public Map<String,List<String>> additionalHttpHeaders()
public Boolean gzipEnabled()
public RetryPolicy retryPolicy()
public <T> T advancedOption(AdvancedClientOption<T> option)
public List<ExecutionInterceptor> lastExecutionInterceptors()
ExecutionInterceptor
s that should be hooked into the execution of each request, in the
order that they should be applied.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.