public static interface RequestOverrideConfiguration.Builder<B extends RequestOverrideConfiguration.Builder>
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.
|
B |
addMetricPublisher(MetricPublisher metricPublisher)
Add a metric publisher to the existing list of previously set publishers to be used for publishing metrics
for this request.
|
Duration |
apiCallAttemptTimeout() |
B |
apiCallAttemptTimeout(Duration apiCallAttemptTimeout)
Configure the amount of time to wait for the http request to complete before giving up and timing out.
|
Duration |
apiCallTimeout() |
B |
apiCallTimeout(Duration apiCallTimeout)
Configure the amount of time to allow the client to complete the execution of an API call.
|
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.
|
List<MetricPublisher> |
metricPublishers() |
B |
metricPublishers(List<MetricPublisher> metricPublisher)
Sets the metric publishers for publishing the metrics collected for this 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.
|
Signer |
signer() |
B |
signer(Signer signer)
Sets the signer to use for signing the request.
|
Map<String,List<String>> headers()
default B putHeader(String name, String value)
This overrides any values for the given header set on the request by default by the SDK, as well as header
overrides set at the client level using
ClientOverrideConfiguration
.
This overrides any values already configured with this header name in the builder.
name
- The name of the header.value
- The value of the header.B putHeader(String name, List<String> values)
This overrides any values for the given header set on the request by default by the SDK, as well as header
overrides set at the client level using
ClientOverrideConfiguration
.
This overrides any values already configured with this header name in the builder.
name
- The name of the header.values
- The values of the header.B headers(Map<String,List<String>> headers)
This overrides any values for the given headers set on the request by default by the SDK, as well as header
overrides set at the client level using
ClientOverrideConfiguration
.
This completely overrides any values currently configured in the builder.
headers
- The set of additional headers.Map<String,List<String>> rawQueryParameters()
default B putRawQueryParameter(String name, String value)
This overrides any values already configured with this query name in the builder.
name
- The query parameter name.value
- The query parameter value.B putRawQueryParameter(String name, List<String> values)
This overrides any values already configured with this query name in the builder.
name
- The query parameter name.values
- The query parameter values.B rawQueryParameters(Map<String,List<String>> rawQueryParameters)
This completely overrides any query parameters currently configured in the builder.
rawQueryParameters
- The set of additional query parameters.List<ApiName> apiNames()
B addApiName(ApiName apiName)
apiName
- The name of the library.B addApiName(Consumer<ApiName.Builder> apiNameConsumer)
apiNameConsumer
- A Consumer
that accepts a ApiName.Builder
.B apiCallTimeout(Duration apiCallTimeout)
The api call 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 apiCallAttemptTimeout()
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 'api call' time).
Duration apiCallTimeout()
B apiCallAttemptTimeout(Duration apiCallAttemptTimeout)
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.
This may be used together with apiCallTimeout()
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 'api call' time).
Duration apiCallAttemptTimeout()
B signer(Signer signer)
signer
- Signer for signing the requestSigner signer()
B metricPublishers(List<MetricPublisher> metricPublisher)
metricPublisher
- The list metric publisher for this request.B addMetricPublisher(MetricPublisher metricPublisher)
metricPublisher
- The metric publisher to add.List<MetricPublisher> metricPublishers()
RequestOverrideConfiguration build()
SdkRequestOverrideConfiguration
with the properties set on this builder.SdkRequestOverrideConfiguration
.Copyright © 2020. All rights reserved.