LegacyClientConfiguration (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.LegacyClientConfiguration

Deprecated.
Replaced with ClientConfiguration.
```
@NotThreadSafe
@Deprecated
public class LegacyClientConfiguration
extends Object
```
Client configuration options such as proxy settings, user agent string, max retry attempts, etc.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_CLIENT_EXECUTION_TIMEOUT`	Deprecated. The default timeout for a request.
`static int`	`DEFAULT_MAX_CONNECTIONS`	Deprecated. The default max connection pool size.
`static int`	`DEFAULT_MAX_CONSECUTIVE_RETRIES_BEFORE_THROTTLING`	Deprecated.
`static RetryPolicy`	`DEFAULT_RETRY_POLICY`	Deprecated. Default request retry policy, including the maximum retry count of 3, the default retry condition and the default back-off strategy.
`static boolean`	`DEFAULT_THROTTLE_RETRIES`	Deprecated. The default on whether to throttle retries.
`static boolean`	`DEFAULT_USE_GZIP`	Deprecated. The default on whether to use gzip compression.
`static String`	`DEFAULT_USER_AGENT`	Deprecated. The default HTTP user agent header for AWS Java SDK clients.

Constructor Summary

Constructors
Constructor	Description
`LegacyClientConfiguration()`	Deprecated. Create a legacy client configuration object with default options.
`LegacyClientConfiguration(LegacyClientConfiguration other)`	Deprecated. Create a copy of another legacy client configuration object.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addHeader(String name, String value)`	Deprecated. Adds a header to be added on all requests
`int`	`getClientExecutionTimeout()`	Deprecated. Returns the amount of time (in milliseconds) to allow the client to complete the execution of an API call.
`Map<String,String>`	`getHeaders()`	Deprecated. Returns headers to be added to all requests
`int`	`getMaxConsecutiveRetriesBeforeThrottling()`	Deprecated.
`int`	`getMaxErrorRetry()`	Deprecated. Returns the maximum number of retry attempts for failed retryable requests (ex: 5xx error responses from a service).
`Protocol`	`getProtocol()`	Deprecated. Returns the protocol (HTTP or HTTPS) to use when connecting to Amazon Web Services.
`RetryPolicy`	`getRetryPolicy()`	Deprecated. Returns the retry policy upon failed requests.
`String`	`getSignerOverride()`	Deprecated. Returns the name of the signature algorithm to use for signing requests made by this client.
`String`	`getUserAgent()`	Deprecated. Replaced by `getUserAgentPrefix()` and `getUserAgentSuffix()`
`String`	`getUserAgentPrefix()`	Deprecated. Returns the HTTP user agent header prefix to send with all requests.
`String`	`getUserAgentSuffix()`	Deprecated. Returns the HTTP user agent header suffix to add to the end of the user agent header on all requests.
`void`	`setClientExecutionTimeout(int clientExecutionTimeout)`	Deprecated. Sets the amount of time (in milliseconds) to allow the client to complete the execution of an API call.
`void`	`setMaxConsecutiveRetriesBeforeThrottling(int maxConsecutiveRetriesBeforeThrottling)`	Deprecated. Set the maximum number of consecutive failed retries that the client will permit before throttling all subsequent retries of failed requests.
`void`	`setMaxErrorRetry(int maxErrorRetry)`	Deprecated. Sets the maximum number of retry attempts for failed retryable requests (ex: 5xx error responses from services).
`void`	`setProtocol(Protocol protocol)`	Deprecated. Sets the protocol (i.e.
`void`	`setRetryPolicy(RetryPolicy retryPolicy)`	Deprecated. Sets the retry policy upon failed requests.
`void`	`setSignerOverride(String value)`	Deprecated. Sets the name of the signature algorithm to use for signing requests made by this client.
`void`	`setUseGzip(boolean use)`	Deprecated. Sets whether gzip compression should be used
`void`	`setUserAgent(String userAgent)`	Deprecated. Replaced by `setUserAgentPrefix(String)` and `setUserAgentSuffix(String)`
`void`	`setUserAgentPrefix(String prefix)`	Deprecated. Sets the HTTP user agent prefix to send with all requests.
`void`	`setUserAgentSuffix(String suffix)`	Deprecated. Sets the HTTP user agent suffix to send with all requests.
`void`	`setUseThrottleRetries(boolean use)`	Deprecated. Sets whether throttled retries should be used
`boolean`	`useGzip()`	Deprecated. Checks if gzip compression is used
`boolean`	`useThrottledRetries()`	Deprecated. Returns whether retry throttling will be used.
`LegacyClientConfiguration`	`withClientExecutionTimeout(int clientExecutionTimeout)`	Deprecated. Sets the amount of time (in milliseconds) to allow the client to complete the execution of an API call.
`LegacyClientConfiguration`	`withGzip(boolean use)`	Deprecated. Sets whether gzip compression should be used
`LegacyClientConfiguration`	`withHeader(String name, String value)`	Deprecated. Adds a header to be added on all requests and returns the `LegacyClientConfiguration` object
`LegacyClientConfiguration`	`withMaxConsecutiveRetriesBeforeThrottling(int maxConsecutiveRetriesBeforeThrottling)`	Deprecated. Set the maximum number of consecutive failed retries that the client will permit before throttling all subsequent retries of failed requests.
`LegacyClientConfiguration`	`withMaxErrorRetry(int maxErrorRetry)`	Deprecated. Sets the maximum number of retry attempts for failed retryable requests (ex: 5xx error responses from services), and returns the updated ClientConfiguration object.
`LegacyClientConfiguration`	`withProtocol(Protocol protocol)`	Deprecated. Sets the protocol (i.e.
`LegacyClientConfiguration`	`withRetryPolicy(RetryPolicy retryPolicy)`	Deprecated. Sets the retry policy upon failed requests, and returns the updated ClientConfiguration object.
`LegacyClientConfiguration`	`withSignerOverride(String value)`	Deprecated. Sets the name of the signature algorithm to use for signing requests made by this client.
`LegacyClientConfiguration`	`withThrottledRetries(boolean use)`	Deprecated. Sets whether throttled retries should be used
`LegacyClientConfiguration`	`withUserAgent(String userAgent)`	Deprecated. Replaced by `withUserAgentPrefix(String)` and `withUserAgentSuffix(String)`
`LegacyClientConfiguration`	`withUserAgentPrefix(String prefix)`	Deprecated. Sets the HTTP user agent prefix header used in requests and returns the updated ClientConfiguration object.
`LegacyClientConfiguration`	`withUserAgentSuffix(String suffix)`	Deprecated. Sets the HTTP user agent suffix header used in requests and returns the updated ClientConfiguration object.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CLIENT_EXECUTION_TIMEOUT
```
public static final int DEFAULT_CLIENT_EXECUTION_TIMEOUT
```
    Deprecated.
    
    The default timeout for a request. This is disabled by default.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_CONNECTIONS
```
public static final int DEFAULT_MAX_CONNECTIONS
```
    Deprecated.
    
    The default max connection pool size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_USER_AGENT
```
public static final String DEFAULT_USER_AGENT
```
    Deprecated.
    
    The default HTTP user agent header for AWS Java SDK clients.
  - DEFAULT_RETRY_POLICY
```
public static final RetryPolicy DEFAULT_RETRY_POLICY
```
    Deprecated.
    
    Default request retry policy, including the maximum retry count of 3, the default retry condition and the default back-off strategy.
    
    See Also:
    
    PredefinedRetryPolicies.DEFAULT, PredefinedRetryPolicies.DYNAMODB_DEFAULT
  - DEFAULT_USE_GZIP
```
public static final boolean DEFAULT_USE_GZIP
```
    Deprecated.
    
    The default on whether to use gzip compression.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_THROTTLE_RETRIES
```
public static final boolean DEFAULT_THROTTLE_RETRIES
```
    Deprecated.
    
    The default on whether to throttle retries.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_CONSECUTIVE_RETRIES_BEFORE_THROTTLING
```
public static final int DEFAULT_MAX_CONSECUTIVE_RETRIES_BEFORE_THROTTLING
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LegacyClientConfiguration
```
public LegacyClientConfiguration()
```
    Deprecated.
    
    Create a legacy client configuration object with default options.
  - LegacyClientConfiguration
```
public LegacyClientConfiguration(LegacyClientConfiguration other)
```
    Deprecated.
    
    Create a copy of another legacy client configuration object.
- Method Detail
  - getProtocol
```
public Protocol getProtocol()
```
    Deprecated.
    
    Returns the protocol (HTTP or HTTPS) to use when connecting to Amazon Web Services.
    The default configuration is to use HTTPS for all requests for increased security.
    Individual clients can also override this setting by explicitly including the protocol as part of the endpoint URL when calling AmazonWebServiceClient.setEndpoint(String).
    
    Returns:
    
    The protocol to use when connecting to Amazon Web Services.
  - setProtocol
```
public void setProtocol(Protocol protocol)
```
    Deprecated.
    
    Sets the protocol (i.e. HTTP or HTTPS) to use when connecting to Amazon Web Services.
    The default configuration is to use HTTPS for all requests for increased security.
    Individual clients can also override this setting by explicitly including the protocol as part of the endpoint URL when calling AmazonWebServiceClient.setEndpoint(String).
    
    Parameters:
    
    protocol - The protocol to use when connecting to Amazon Web Services.
  - withProtocol
```
public LegacyClientConfiguration withProtocol(Protocol protocol)
```
    Deprecated.
    
    Sets the protocol (i.e. HTTP or HTTPS) to use when connecting to Amazon Web Services, and returns the updated ClientConfiguration object so that additional calls may be chained together.
    The default configuration is to use HTTPS for all requests for increased security.
    Individual clients can also override this setting by explicitly including the protocol as part of the endpoint URL when calling AmazonWebServiceClient.setEndpoint(String).
    
    Parameters:
    
    protocol - The protocol to use when connecting to Amazon Web Services.
    
    Returns:
    
    The updated ClientConfiguration object with the new max HTTP connections setting.
  - getUserAgent
```
@Deprecated
public String getUserAgent()
```
    Deprecated. Replaced by getUserAgentPrefix() and getUserAgentSuffix()
    
    Returns:
    
    The user agent string to use when sending requests.
  - setUserAgent
```
@Deprecated
public void setUserAgent(String userAgent)
```
    Deprecated. Replaced by setUserAgentPrefix(String) and setUserAgentSuffix(String)
    
    Parameters:
    
    userAgent - The user agent string to use when sending requests.
  - withUserAgent
```
@Deprecated
public LegacyClientConfiguration withUserAgent(String userAgent)
```
    Deprecated. Replaced by withUserAgentPrefix(String) and withUserAgentSuffix(String)
    
    Parameters:
    
    userAgent - The user agent string to use when sending requests.
    
    Returns:
    
    The updated ClientConfiguration object.
  - getUserAgentPrefix
```
public String getUserAgentPrefix()
```
    Deprecated.
    
    Returns the HTTP user agent header prefix to send with all requests.
    
    Returns:
    
    The user agent string prefix to use when sending requests.
  - setUserAgentPrefix
```
public void setUserAgentPrefix(String prefix)
```
    Deprecated.
    
    Sets the HTTP user agent prefix to send with all requests.
    
    Parameters:
    
    prefix - The string to prefix to user agent to use when sending requests.
  - withUserAgentPrefix
```
public LegacyClientConfiguration withUserAgentPrefix(String prefix)
```
    Deprecated.
    
    Sets the HTTP user agent prefix header used in requests and returns the updated ClientConfiguration object.
    
    Parameters:
    
    prefix - The string to prefix to user agent to use when sending requests.
    
    Returns:
    
    The updated ClientConfiguration object.
  - getUserAgentSuffix
```
public String getUserAgentSuffix()
```
    Deprecated.
    
    Returns the HTTP user agent header suffix to add to the end of the user agent header on all requests.
    
    Returns:
    
    The user agent string suffix to use when sending requests.
  - setUserAgentSuffix
```
public void setUserAgentSuffix(String suffix)
```
    Deprecated.
    
    Sets the HTTP user agent suffix to send with all requests.
    
    Parameters:
    
    suffix - The string to suffix to user agent to use when sending requests.
  - withUserAgentSuffix
```
public LegacyClientConfiguration withUserAgentSuffix(String suffix)
```
    Deprecated.
    
    Sets the HTTP user agent suffix header used in requests and returns the updated ClientConfiguration object.
    
    Parameters:
    
    suffix - The string to suffix to user agent to use when sending requests.
    
    Returns:
    
    The updated ClientConfiguration object.
  - getRetryPolicy
```
public RetryPolicy getRetryPolicy()
```
    Deprecated.
    
    Returns the retry policy upon failed requests.
    
    Returns:
    
    The retry policy upon failed requests.
  - setRetryPolicy
```
public void setRetryPolicy(RetryPolicy retryPolicy)
```
    Deprecated.
    
    Sets the retry policy upon failed requests. User could specify whether the RetryPolicy should honor maxErrorRetry set by setMaxErrorRetry(int).
    
    Parameters:
    
    retryPolicy - The retry policy upon failed requests.
  - withRetryPolicy
```
public LegacyClientConfiguration withRetryPolicy(RetryPolicy retryPolicy)
```
    Deprecated.
    
    Sets the retry policy upon failed requests, and returns the updated ClientConfiguration object. User could specify whether the RetryPolicy should honor maxErrorRetry set by setMaxErrorRetry(int)
    
    Parameters:
    
    retryPolicy - The retry policy upon failed requests.
  - getMaxErrorRetry
```
public int getMaxErrorRetry()
```
    Deprecated.
    
    Returns the maximum number of retry attempts for failed retryable requests (ex: 5xx error responses from a service). This method returns -1 before a maxErrorRetry value is explicitly set by setMaxErrorRetry(int), in which case the configured RetryPolicy will be used to control the retry count.
    
    Returns:
    
    The maximum number of retry attempts for failed retryable requests, or -1 if maxErrorRetry has not been set by setMaxErrorRetry(int).
  - setMaxErrorRetry
```
public void setMaxErrorRetry(int maxErrorRetry)
```
    Deprecated.
    
    Sets the maximum number of retry attempts for failed retryable requests (ex: 5xx error responses from services).
    
    Parameters:
    
    maxErrorRetry - The maximum number of retry attempts for failed retryable requests. This value should not be negative.
  - withMaxErrorRetry
```
public LegacyClientConfiguration withMaxErrorRetry(int maxErrorRetry)
```
    Deprecated.
    
    Sets the maximum number of retry attempts for failed retryable requests (ex: 5xx error responses from services), and returns the updated ClientConfiguration object.
    
    Parameters:
    
    maxErrorRetry - The maximum number of retry attempts for failed retryable requests. This value should not be negative.
    
    Returns:
    
    The updated ClientConfiguration object.
  - getClientExecutionTimeout
```
public int getClientExecutionTimeout()
```
    Deprecated.
    
    Returns 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 request handler execution, all HTTP request including 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 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.
    
    Returns:
    
    The amount of time (in milliseconds) to allow the client to complete the execution of an API call.
  - setClientExecutionTimeout
```
public void setClientExecutionTimeout(int clientExecutionTimeout)
```
    Deprecated.
    
    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 request handler execution, all HTTP request including 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 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.
    
    Parameters:
    
    clientExecutionTimeout - The amount of time (in milliseconds) to allow the client to complete the execution of an API call. A value of '0' disables this feature.
  - withClientExecutionTimeout
```
public LegacyClientConfiguration withClientExecutionTimeout(int clientExecutionTimeout)
```
    Deprecated.
    
    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 request handler execution, all HTTP request including 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 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.
    
    Parameters:
    
    clientExecutionTimeout - The amount of time (in milliseconds) to allow the client to complete the execution of an API call. A value of '0' disables this feature.
    
    Returns:
    
    The updated ClientConfiguration object for method chaining
  - useThrottledRetries
```
public boolean useThrottledRetries()
```
    Deprecated.
    
    Returns whether retry throttling will be used.
    Retry throttling is a feature which intelligently throttles retry attempts when a large percentage of requests are failing and retries are unsuccessful, particularly in scenarios of degraded service health. In these situations the client will drain its internal retry capacity and slowly roll off from retry attempts until requests begin to succeed again. At that point the retry capacity pool will begin to refill and retries will once again be permitted.
    
    In situations where retries have been throttled this feature will effectively result in fail-fast behavior from the client. Because retries are circumvented exceptions will be immediately returned to the caller if the initial request is unsuccessful. This will result in a greater number of exceptions being returned up front but prevents requests being tied up attempting subsequent retries which are also likely to fail.
    
    Returns:
    
    true if retry throttling will be used
  - setUseThrottleRetries
```
public void setUseThrottleRetries(boolean use)
```
    Deprecated.
    
    Sets whether throttled retries should be used
    Retry throttling is a feature which intelligently throttles retry attempts when a large percentage of requests are failing and retries are unsuccessful, particularly in scenarios of degraded service health. In these situations the client will drain its internal retry capacity and slowly roll off from retry attempts until requests begin to succeed again. At that point the retry capacity pool will begin to refill and retries will once again be permitted.
    
    In situations where retries have been throttled this feature will effectively result in fail-fast behavior from the client. Because retries are circumvented exceptions will be immediately returned to the caller if the initial request is unsuccessful. This will result in a greater number of exceptions being returned up front but prevents requests being tied up attempting subsequent retries which are also likely to fail.
    
    Parameters:
    
    use - true if throttled retries should be used
  - withThrottledRetries
```
public LegacyClientConfiguration withThrottledRetries(boolean use)
```
    Deprecated.
    
    Sets whether throttled retries should be used
    Retry throttling is a feature which intelligently throttles retry attempts when a large percentage of requests are failing and retries are unsuccessful, particularly in scenarios of degraded service health. In these situations the client will drain its internal retry capacity and slowly roll off from retry attempts until requests begin to succeed again. At that point the retry capacity pool will begin to refill and retries will once again be permitted.
    
    In situations where retries have been throttled this feature will effectively result in fail-fast behavior from the client. Because retries are circumvented exceptions will be immediately returned to the caller if the initial request is unsuccessful. This will result in a greater number of exceptions being returned up front but prevents requests being tied up attempting subsequent retries which are also likely to fail.
    
    Parameters:
    
    use - true if throttled retries should be used
    
    Returns:
    
    The updated ClientConfiguration object.
  - setMaxConsecutiveRetriesBeforeThrottling
```
public void setMaxConsecutiveRetriesBeforeThrottling(int maxConsecutiveRetriesBeforeThrottling)
```
    Deprecated.
    
    Set the maximum number of consecutive failed retries that the client will permit before throttling all subsequent retries of failed requests.
    Note: This does not guarantee that each failed request will be retried up to this many times. Depending on the configured RetryPolicy and the number of past failed and successful requests, the actual number of retries attempted may be less.
    This has a default value of DEFAULT_MAX_CONSECUTIVE_RETRIES_BEFORE_THROTTLING.
    
    Parameters:
    
    maxConsecutiveRetriesBeforeThrottling - The maximum number of consecutive retries.
  - withMaxConsecutiveRetriesBeforeThrottling
```
public LegacyClientConfiguration withMaxConsecutiveRetriesBeforeThrottling(int maxConsecutiveRetriesBeforeThrottling)
```
    Deprecated.
    
    Set the maximum number of consecutive failed retries that the client will permit before throttling all subsequent retries of failed requests.
    Note: This does not guarantee that each failed request will be retried up to this many times. Depending on the configured RetryPolicy and the number of past failed and successful requests, the actual number of retries attempted may be less.
    This has a default value of DEFAULT_MAX_CONSECUTIVE_RETRIES_BEFORE_THROTTLING.
    
    Parameters:
    
    maxConsecutiveRetriesBeforeThrottling - The maximum number of consecutive retries.
    
    Returns:
    
    This object for chaining.
  - getMaxConsecutiveRetriesBeforeThrottling
```
public int getMaxConsecutiveRetriesBeforeThrottling()
```
    Deprecated.
    
    Returns:
    
    Set the maximum number of consecutive failed retries that the client will permit before throttling all subsequent retries of failed requests.
  - useGzip
```
public boolean useGzip()
```
    Deprecated.
    
    Checks if gzip compression is used
    
    Returns:
    
    if gzip compression is used
  - setUseGzip
```
public void setUseGzip(boolean use)
```
    Deprecated.
    
    Sets whether gzip compression should be used
    
    Parameters:
    
    use - whether gzip compression should be used
  - withGzip
```
public LegacyClientConfiguration withGzip(boolean use)
```
    Deprecated.
    
    Sets whether gzip compression should be used
    
    Parameters:
    
    use - whether gzip compression should be used
    
    Returns:
    
    The updated ClientConfiguration object.
  - getSignerOverride
```
public String getSignerOverride()
```
    Deprecated.
    
    Returns the name of the signature algorithm to use for signing requests made by this client. If not set or explicitly set to null, the client will choose a signature algorithm to use based on a configuration file of supported signature algorithms for the service and region.
    Most users do not need to concern themselves with which signature algorithm is being used, as the defaults will be sufficient. This setting exists only so advanced users can opt in to newer signature protocols which have not yet been made the default for a particular service/region.
    Not all services support all signature algorithms, and configuring an unsupported signature algorithm will lead to authentication failures. Use me at your own risk, and only after consulting the documentation for the service to ensure it actually does supports your chosen algorithm.
    If non-null, the name returned from this method is used to look up a Signer class implementing the chosen algorithm by the software.amazon.awssdk.auth.SignerFactory class.
    
    Returns:
    
    The signature algorithm to use for this client, or null to use the default.
  - setSignerOverride
```
public void setSignerOverride(String value)
```
    Deprecated.
    
    Sets the name of the signature algorithm to use for signing requests made by this client. If not set or explicitly set to null, the client will choose a signature algorithm to use based on a configuration file of supported signature algorithms for the service and region.
    Most users do not need to concern themselves with which signature algorithm is being used, as the defaults will be sufficient. This setting exists only so advanced users can opt in to newer signature protocols which have not yet been made the default for a particular service/region.
    Not all services support all signature algorithms, and configuring an unsupported signature algorithm will lead to authentication failures. Use me at your own risk, and only after consulting the documentation for the service to ensure it actually does supports your chosen algorithm.
    If non-null, the name returned from this method is used to look up a Signer class implementing the chosen algorithm by the software.amazon.awssdk.auth.SignerFactory class.
    
    Parameters:
    
    value - The signature algorithm to use for this client, or null to use the default.
  - withSignerOverride
```
public LegacyClientConfiguration withSignerOverride(String value)
```
    Deprecated.
    
    Sets the name of the signature algorithm to use for signing requests made by this client. If not set or explicitly set to null, the client will choose a signature algorithm to use based on a configuration file of supported signature algorithms for the service and region.
    Most users do not need to concern themselves with which signature algorithm is being used, as the defaults will be sufficient. This setting exists only so advanced users can opt in to newer signature protocols which have not yet been made the default for a particular service/region.
    Not all services support all signature algorithms, and configuring an unsupported signature algorithm will lead to authentication failures. Use me at your own risk, and only after consulting the documentation for the service to ensure it actually does supports your chosen algorithm.
    If non-null, the name returned from this method is used to look up a Signer class implementing the chosen algorithm by the software.amazon.awssdk.auth.SignerFactory class.
    
    Parameters:
    
    value - The signature algorithm to use for this client, or null to use the default.
    
    Returns:
    
    The updated ClientConfiguration object.
  - withHeader
```
public LegacyClientConfiguration withHeader(String name,
                                            String value)
```
    Deprecated.
    
    Adds a header to be added on all requests and returns the LegacyClientConfiguration object
    
    Parameters:
    
    name - the name of the header
    
    value - the value of the header
    
    Returns:
    
    The updated ClientConfiguration object.
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Deprecated.
    
    Adds a header to be added on all requests
    
    Parameters:
    
    name - the name of the header
    
    value - the value of the header
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Deprecated.
    
    Returns headers to be added to all requests
    
    Returns:
    
    headers to be added to all requests

Class LegacyClientConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CLIENT_EXECUTION_TIMEOUT

DEFAULT_MAX_CONNECTIONS

DEFAULT_USER_AGENT

DEFAULT_RETRY_POLICY

DEFAULT_USE_GZIP

DEFAULT_THROTTLE_RETRIES

DEFAULT_MAX_CONSECUTIVE_RETRIES_BEFORE_THROTTLING

Constructor Detail

LegacyClientConfiguration

LegacyClientConfiguration

Method Detail

getProtocol

setProtocol

withProtocol

getUserAgent

setUserAgent

withUserAgent

getUserAgentPrefix

setUserAgentPrefix

withUserAgentPrefix

getUserAgentSuffix

setUserAgentSuffix

withUserAgentSuffix

getRetryPolicy

setRetryPolicy

withRetryPolicy

getMaxErrorRetry

setMaxErrorRetry

withMaxErrorRetry

getClientExecutionTimeout

setClientExecutionTimeout

withClientExecutionTimeout

useThrottledRetries

setUseThrottleRetries

withThrottledRetries

setMaxConsecutiveRetriesBeforeThrottling

withMaxConsecutiveRetriesBeforeThrottling

getMaxConsecutiveRetriesBeforeThrottling

useGzip

setUseGzip

withGzip

getSignerOverride

setSignerOverride

withSignerOverride

withHeader

addHeader

getHeaders