ClientConfig

java.lang.Object
- com.amazon.dax.client.dynamodbv2.ClientConfig

```
public final class ClientConfig
extends Object
```
Dax client configuration.

See Also:

AmazonDaxClientBuilder, AmazonDaxAsyncClientBuilder

Field Summary

Fields
Modifier and Type	Field and Description
`protected static long`	`DEFAULT_CLUSTER_UPDATE_INTERVAL_MS`
`protected static long`	`DEFAULT_CLUSTER_UPDATE_THRESHOLD_MS`
`protected static long`	`DEFAULT_CONNECT_TIMEOUT_MS`
`protected static long`	`DEFAULT_HEALTH_CHECK_INTERVAL_MS`
`protected static long`	`DEFAULT_HEALTH_CHECK_TIMEOUT_MS`
`protected static long`	`DEFAULT_IDLE_CONNECTION_TIMEOUT_MS`
`protected static int`	`DEFAULT_MAX_PENDING_CONNECTIONS_PER_HOST`
`protected static long`	`DEFAULT_MAX_RETRY_DELAY_MS`
`protected static int`	`DEFAULT_MIN_IDLE_CONNECTION_SIZE`
`protected static int`	`DEFAULT_READ_RETRIES`
`protected static long`	`DEFAULT_REQUEST_TIMEOUT_MS`
`protected static long`	`DEFAULT_THREAD_KEEP_ALIVE_MS`
`protected static int`	`DEFAULT_UNHEALTHY_CONSECUTIVE_ERROR_COUNT`
`protected static int`	`DEFAULT_WRITE_RETRIES`
`AWSCredentialsProvider`	`mProvider` Deprecated.
`String`	`mRegion` Deprecated.

Constructor Summary

Constructors
Constructor and Description

ClientConfig()
Constructs a new default initialized instance

Constructors
Constructor and Description
`ClientConfig()` Constructs a new default initialized instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getClusterUpdateInterval()` Returns the interval between polling of cluster members for membership changes.
`long`	`getClusterUpdateThreshold()` Returns the threshold below which the cluster will not be polled for membership changes.
`long`	`getConnectTimeout()` Returns the timeout for connections with the DAX cluster.
`AWSCredentialsProvider`	`getCredentialsProvider()` Sets the credentials provider used to sign requests to the DAX cluster.
`long`	`getHealthCheckInterval()` Returns the interval between health checks with the DAX cluster.
`long`	`getHealthCheckTimeout()` Returns the health check timeout for connections with the DAX cluster.
`com.amazon.dax.client.HostPort[]`	`getHostPorts()` Returns the DAX cluster discovery endpoints.
`com.amazon.dax.client.DaxHostnameVerifier`	`getHostVerifier()` Returns the DAX cluster hostname verifier
`long`	`getIdleConnectionTimeout()` Returns the timeout for idle connections with the DAX cluster.
`int`	`getMaxPendingConnectsPerHost()` Returns the maximum number of pending connections per DAX node.
`long`	`getMaxRetryDelay()` Returns the maximum delay between retries when the cluster is believed to be recovering.
`int`	`getMinIdleConnectionSize()` Returns the minimum number of idling connections with the DAX cluster.
`int`	`getReadRetries()` Returns the number of times to retry reads (not counting the initial try).
`String`	`getRegion()` Returns the AWS region.
`long`	`getRequestTimeout()` Returns the request timeout for connections with the DAX cluster.
`long`	`getThreadKeepAlive()` Returns the health check thread keep alive time.
`int`	`getUnhealthyConsecutiveErrorCount()` Returns the number of errors required to signal node unhealthy within health check interval
`int`	`getWriteRetries()` Returns the number of times to retry writes (not counting the initial try).
`boolean`	`isEncrypted()` Returns if TLS endpoint is used.
`void`	`setClusterUpdateInterval(long clusterUpdateInterval, TimeUnit unit)` Sets the interval between polling of cluster members for membership changes.
`void`	`setClusterUpdateThreshold(long clusterUpdateThreshold, TimeUnit unit)` Sets the threshold below which explicit unforced cluster refresh requests will not be attempted to poll for membership changes.
`void`	`setConnectTimeout(long connectTimeout, TimeUnit unit)` Sets the timeout for connections with the DAX cluster.
`void`	`setCredentialsProvider(AWSCredentialsProvider provider)` Sets the credentials provider used to sign requests to the DAX cluster.
`void`	`setEndpoints(boolean skipHostnameVerification, String... hosts)` Sets the DAX cluster discovery endpoints.
`void`	`setEndpoints(String... hosts)` Sets the DAX cluster discovery endpoints.
`void`	`setHealthCheckInterval(long healthCheckInterval, TimeUnit unit)` Sets the interval between health checks with the DAX cluster.
`void`	`setHealthCheckTimeout(long healthCheckTimeout, TimeUnit unit)` Sets the health check timeout for connections with the DAX cluster.
`void`	`setIdleConnectionTimeout(long idleTimeout, TimeUnit unit)` Sets the timeout for idle connections with the DAX cluster.
`void`	`setMaxPendingConnectsPerHost(int maxPending)` Sets the maximum number of pending connections per DAX node.
`void`	`setMaxRetryDelay(long retryDelayCap, TimeUnit unit)` Sets the maximum delay between retries when the cluster is believed to be recovering.
`void`	`setMinIdleConnectionSize(int size)` Sets the minimum number of idling connections with the DAX cluster.
`void`	`setReadRetries(int readRetries)` Sets the number of times to retry reads (not counting the initial try).
`void`	`setRegion(Region region)` Sets the AWS region.
`void`	`setRegion(String region)` Sets the AWS region.
`void`	`setRequestTimeout(long RequestTimeout, TimeUnit unit)` Sets the request timeout for connections with the DAX cluster.
`void`	`setThreadKeepAlive(long threadKeepAlive, TimeUnit unit)` Sets the health check thread keep alive time.
`void`	`setUnhealthyConsecutiveErrorCount(int errorCount)` Sets the number of consecutive errors required to signal node unhealthy within health check interval.
`void`	`setWriteRetries(int writeRetries)` Sets the number of times to retry writes (not counting the initial try).
`ClientConfig`	`withClusterUpdateInterval(long clusterUpdateInterval, TimeUnit unit)` Sets the interval between polling of cluster members for membership changes.
`ClientConfig`	`withClusterUpdateThreshold(long clusterUpdateThreshold, TimeUnit unit)` Sets the threshold below which explicit unforced cluster refresh requests will not be attempted to poll for membership changes.
`ClientConfig`	`withConnectTimeout(long connectTimeout, TimeUnit unit)` Sets the timeout for connections with the DAX cluster.
`ClientConfig`	`withCredentialsProvider(AWSCredentialsProvider provider)` Sets the credentials provider used to sign requests to the DAX cluster.
`ClientConfig`	`withEndpoints(boolean skipHostnameVerification, String... hosts)` Sets the DAX cluster discovery endpoints.
`ClientConfig`	`withEndpoints(String... hosts)` Sets the DAX cluster discovery endpoints.
`ClientConfig`	`withHealthCheckInterval(long healthCheckInterval, TimeUnit unit)` Sets the interval between health checks with the DAX cluster.
`ClientConfig`	`withHealthCheckTimeout(long healthCheckTimeout, TimeUnit unit)` Sets the health check timeout for connections with the DAX cluster.
`ClientConfig`	`withIdleConnectionTimeout(long idleTimeout, TimeUnit unit)` Sets the timeout for idle connections with the DAX cluster.
`ClientConfig`	`withMaxPendingConnectsPerHost(int maxPending)` Sets the maximum number of pending connections per DAX node.
`ClientConfig`	`withMaxRetryDelay(long retryDelayCap, TimeUnit unit)` Sets the maximum delay between retries when the cluster is believed to be recovering.
`ClientConfig`	`withMinIdleConnectionSize(int size)` Sets the minimum number of idling connections with the DAX cluster.
`ClientConfig`	`withReadRetries(int readRetries)` Sets the number of times to retry reads (not counting the initial try).
`ClientConfig`	`withRegion(Region region)` Sets the AWS region.
`ClientConfig`	`withRegion(String region)` Sets the AWS region.
`ClientConfig`	`withRequestTimeout(long RequestTimeout, TimeUnit unit)` Sets the request timeout for connections with the DAX cluster.
`ClientConfig`	`withThreadKeepAlive(long threadKeepAlive, TimeUnit unit)` Sets the health check thread keep alive time.
`ClientConfig`	`withUnhealthyConsecutiveErrorCount(int errorCount)` Sets the number of consecutive errors required to signal node unhealthy within health check interval.
`ClientConfig`	`withWriteRetries(int writeRetries)` Sets the number of times to retry writes (not counting the initial try).

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

- Field Detail
  - DEFAULT_MAX_PENDING_CONNECTIONS_PER_HOST
```
protected static final int DEFAULT_MAX_PENDING_CONNECTIONS_PER_HOST
```
    See Also:
    
    Constant Field Values
  - DEFAULT_UNHEALTHY_CONSECUTIVE_ERROR_COUNT
```
protected static final int DEFAULT_UNHEALTHY_CONSECUTIVE_ERROR_COUNT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CLUSTER_UPDATE_INTERVAL_MS
```
protected static final long DEFAULT_CLUSTER_UPDATE_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CLUSTER_UPDATE_THRESHOLD_MS
```
protected static final long DEFAULT_CLUSTER_UPDATE_THRESHOLD_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CONNECT_TIMEOUT_MS
```
protected static final long DEFAULT_CONNECT_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_REQUEST_TIMEOUT_MS
```
protected static final long DEFAULT_REQUEST_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HEALTH_CHECK_INTERVAL_MS
```
protected static final long DEFAULT_HEALTH_CHECK_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HEALTH_CHECK_TIMEOUT_MS
```
protected static final long DEFAULT_HEALTH_CHECK_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_IDLE_CONNECTION_TIMEOUT_MS
```
protected static final long DEFAULT_IDLE_CONNECTION_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_READ_RETRIES
```
protected static final int DEFAULT_READ_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_WRITE_RETRIES
```
protected static final int DEFAULT_WRITE_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_RETRY_DELAY_MS
```
protected static final long DEFAULT_MAX_RETRY_DELAY_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_THREAD_KEEP_ALIVE_MS
```
protected static final long DEFAULT_THREAD_KEEP_ALIVE_MS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MIN_IDLE_CONNECTION_SIZE
```
protected static final int DEFAULT_MIN_IDLE_CONNECTION_SIZE
```
    See Also:
    
    Constant Field Values
  - mProvider
```
@Deprecated
public AWSCredentialsProvider mProvider
```
    Deprecated.
  - mRegion
```
@Deprecated
public String mRegion
```
    Deprecated.
- Constructor Detail
  - ClientConfig
```
public ClientConfig()
```
    Constructs a new default initialized instance
    withConnectTimeout(long, TimeUnit) set to 1000L ms,
    withRequestTimeout(long, TimeUnit) set to 60000L ms,
    withHealthCheckInterval(long, TimeUnit) set to 5000L ms,
    withHealthCheckTimeout(long, TimeUnit) set to 1000L ms,
    withIdleConnectionTimeout(long, TimeUnit) set to 30000L ms,
    withMinIdleConnectionSize(int) set to 1,
    withClusterUpdateInterval(long, TimeUnit) set to 4000L ms,
    withClusterUpdateThreshold(long, TimeUnit) set to 125L ms,
    withThreadKeepAlive(long, TimeUnit) set to 10000L ms,
    withMaxPendingConnectsPerHost(int) set to 10,
    withUnhealthyConsecutiveErrorCount(int) set to 5,
    withWriteRetries(int) set to 2,
    withReadRetries(int) set to 2,
    withMaxRetryDelay(long, TimeUnit) set to 7000L ms
- Method Detail
  - isEncrypted
```
public boolean isEncrypted()
```
    Returns if TLS endpoint is used.
    
    Returns:
    
    if TLS endpoint is used
  - getHostPorts
```
public com.amazon.dax.client.HostPort[] getHostPorts()
```
    Returns the DAX cluster discovery endpoints.
    
    Returns:
    
    the cluster discovery endpoints
    
    See Also:
    
    withEndpoints(String...), withEndpoints(boolean, String...), setEndpoints(String...), setEndpoints(boolean, String...)
  - getHostVerifier
```
public com.amazon.dax.client.DaxHostnameVerifier getHostVerifier()
```
    Returns the DAX cluster hostname verifier
    
    Returns:
    
    the hostname verifier
  - setEndpoints
```
public void setEndpoints(String... hosts)
```
    Sets the DAX cluster discovery endpoints.
    Cluster discovery endpoints are available from the DynamoDB console or by calling describe-clusters with the AWS CLI or DAX control plane client.
    
    Parameters:
    
    hosts - the cluster discovery endpoints, in the form [scheme://]hostname:port
    
    See Also:
    
    getHostPorts()
  - setEndpoints
```
public void setEndpoints(boolean skipHostnameVerification,
                         String... hosts)
```
    Sets the DAX cluster discovery endpoints.
    Cluster discovery endpoints are available from the DynamoDB console or by calling describe-clusters with the AWS CLI or DAX control plane client. For encrypted cluster, only one cluster discovery endpoint may be provided.
    
    Parameters:
    
    skipHostnameVerification - skip hostname verification of TLS connections. This parameter has no impact on unecrypted clusters. The default is to perform hostname verification, setting this to true will skip verification. Be sure you understand the implication of doing so, which is the inability to authenticate the cluster that you are connecting to.
    
    hosts - the cluster discovery endpoints, in the form [scheme://]hostname:port
    
    See Also:
    
    getHostPorts()
  - withEndpoints
```
public ClientConfig withEndpoints(String... hosts)
```
    Sets the DAX cluster discovery endpoints.
    Cluster discovery endpoints are available from the DynamoDB console or by calling describe-clusters with the AWS CLI or DAX control plane client.
    
    Parameters:
    
    hosts - the cluster discovery endpoints, in the form [scheme://]hostname:port
    
    Returns:
    
    this object for method chaining
    
    See Also:
    
    getHostPorts()
  - withEndpoints
```
public ClientConfig withEndpoints(boolean skipHostnameVerification,
                                  String... hosts)
```
    Sets the DAX cluster discovery endpoints.
    Cluster discovery endpoints are available from the DynamoDB console or by calling describe-clusters with the AWS CLI or DAX control plane client. For encrypted cluster, only one cluster discovery endpoint may be provided.
    
    Parameters:
    
    skipHostnameVerification - skip hostname verification of TLS connections. This parameter has no impact on unecrypted clusters. The default is to perform hostname verification, setting this to True will skip verification. Be sure you understand the implication of doing so, which is the inability to authenticate the cluster that you are connecting to.
    
    hosts - the cluster discovery endpoints, in the form [scheme://]hostname:port
    
    Returns:
    
    this object for method chaining
    
    See Also:
    
    getHostPorts()
  - getConnectTimeout
```
public long getConnectTimeout()
```
    Returns the timeout for connections with the DAX cluster.
    Defaults to 1000L ms.
    
    Returns:
    
    the timeout in ns
  - setConnectTimeout
```
public void setConnectTimeout(long connectTimeout,
                              TimeUnit unit)
```
    Sets the timeout for connections with the DAX cluster.
    Defaults to 1000L ms.
    
    Parameters:
    
    connectTimeout - the timeout
    
    unit - the time unit for connectTimeout
  - withConnectTimeout
```
public ClientConfig withConnectTimeout(long connectTimeout,
                                       TimeUnit unit)
```
    Sets the timeout for connections with the DAX cluster.
    Defaults to 1000L ms.
    
    Parameters:
    
    connectTimeout - the timeout
    
    unit - the time unit for connectTimeout
    
    Returns:
    
    this object for method chaining
  - getRequestTimeout
```
public long getRequestTimeout()
```
    Returns the request timeout for connections with the DAX cluster.
    Defaults to 60000L ms.
    
    Returns:
    
    the timeout in ns
  - setRequestTimeout
```
public void setRequestTimeout(long RequestTimeout,
                              TimeUnit unit)
```
    Sets the request timeout for connections with the DAX cluster.
    Defaults to 60000L ms.
    
    Parameters:
    
    RequestTimeout - the timeout
    
    unit - the time unit for readTimeout
  - withRequestTimeout
```
public ClientConfig withRequestTimeout(long RequestTimeout,
                                       TimeUnit unit)
```
    Sets the request timeout for connections with the DAX cluster.
    Defaults to 60000L ms.
    
    Parameters:
    
    RequestTimeout - the timeout
    
    unit - the time unit for readTimeout
    
    Returns:
    
    this object for method chaining
  - getHealthCheckTimeout
```
public long getHealthCheckTimeout()
```
    Returns the health check timeout for connections with the DAX cluster. Defaults to 1000L ms.
    
    Returns:
    
    the timeout in ns
  - setHealthCheckTimeout
```
public void setHealthCheckTimeout(long healthCheckTimeout,
                                  TimeUnit unit)
```
    Sets the health check timeout for connections with the DAX cluster.
    Defaults to 1000L ms.
    
    Parameters:
    
    healthCheckTimeout - the timeout
    
    unit - the time unit for healthCheckTimeout
  - withHealthCheckTimeout
```
public ClientConfig withHealthCheckTimeout(long healthCheckTimeout,
                                           TimeUnit unit)
```
    Sets the health check timeout for connections with the DAX cluster.
    Defaults to 1000L ms.
    
    Parameters:
    
    healthCheckTimeout - the timeout
    
    unit - the time unit for healthCheckTimeout
    
    Returns:
    
    this object for method chaining
  - getHealthCheckInterval
```
public long getHealthCheckInterval()
```
    Returns the interval between health checks with the DAX cluster. Defaults to 5000L ms.
    
    Returns:
    
    the interval in ns
  - setHealthCheckInterval
```
public void setHealthCheckInterval(long healthCheckInterval,
                                   TimeUnit unit)
```
    Sets the interval between health checks with the DAX cluster.
    Defaults to 5000L ms.
    
    Parameters:
    
    healthCheckInterval - the interval
    
    unit - the time unit for healthCheckInterval
  - withHealthCheckInterval
```
public ClientConfig withHealthCheckInterval(long healthCheckInterval,
                                            TimeUnit unit)
```
    Sets the interval between health checks with the DAX cluster.
    Defaults to 5000L ms.
    
    Parameters:
    
    healthCheckInterval - the interval
    
    unit - the time unit for healthCheckInterval
    
    Returns:
    
    this object for method chaining
  - getIdleConnectionTimeout
```
public long getIdleConnectionTimeout()
```
    Returns the timeout for idle connections with the DAX cluster. Defaults to 30000L ms.
    
    Returns:
    
    the timeout in ns
  - setIdleConnectionTimeout
```
public void setIdleConnectionTimeout(long idleTimeout,
                                     TimeUnit unit)
```
    Sets the timeout for idle connections with the DAX cluster.
    Defaults to 30000L ms.
    
    Parameters:
    
    idleTimeout - the timeout
    
    unit - the time unit for idleTimeout
  - withIdleConnectionTimeout
```
public ClientConfig withIdleConnectionTimeout(long idleTimeout,
                                              TimeUnit unit)
```
    Sets the timeout for idle connections with the DAX cluster.
    Defaults to 30000L ms.
    
    Parameters:
    
    idleTimeout - the timeout
    
    unit - the time unit for idleTimeout
    
    Returns:
    
    this object for method chaining
  - getMinIdleConnectionSize
```
public int getMinIdleConnectionSize()
```
    Returns the minimum number of idling connections with the DAX cluster.
    For every request, client will use an idle connection, if available, and establish a new one if none is available. Idle connections will be closed after the timeout specified in getIdleConnectionTimeout().
    
    Note: connections are not pre-allocated at pool create time and the pool will grow to the min idle size on demand.
    
    Defaults to 1 and the min value is 1.
    
    Returns:
    
    the size
  - setMinIdleConnectionSize
```
public void setMinIdleConnectionSize(int size)
```
    Sets the minimum number of idling connections with the DAX cluster.
    For every request, client will use an idle connection, if available, and establish a new one if none is available. Idle connections will be closed after the timeout specified in getIdleConnectionTimeout().
    
    Note: connections are not pre-allocated at pool create time and the pool will grow to the min idle size on demand.
    
    Defaults to 1 and the min value is 1.
    
    Parameters:
    
    size - the minimum size
  - withMinIdleConnectionSize
```
public ClientConfig withMinIdleConnectionSize(int size)
```
    Sets the minimum number of idling connections with the DAX cluster.
    For every request, client will use an idle connection, if available, and establish a new one if none is available. Idle connections will be closed after the timeout specified in getIdleConnectionTimeout().
    
    Note: connections are not pre-allocated at pool create time and the pool will grow to the min idle size on demand.
    
    Defaults to 1 and the min value is 1.
    
    Parameters:
    
    size - the minimum size
    
    Returns:
    
    this object for method chaining
  - getWriteRetries
```
public int getWriteRetries()
```
    Returns the number of times to retry writes (not counting the initial try). Defaults to 2.
    
    Returns:
    
    the number of times to retry
  - setWriteRetries
```
public void setWriteRetries(int writeRetries)
```
    Sets the number of times to retry writes (not counting the initial try).
    Defaults to 2.
    
    Parameters:
    
    writeRetries - the number of times to retry
  - withWriteRetries
```
public ClientConfig withWriteRetries(int writeRetries)
```
    Sets the number of times to retry writes (not counting the initial try).
    Defaults to 2.
    
    Parameters:
    
    writeRetries - the number of times to retry
    
    Returns:
    
    this object for method chaining
  - getMaxPendingConnectsPerHost
```
public int getMaxPendingConnectsPerHost()
```
    Returns the maximum number of pending connections per DAX node.
    Pending connections are connections which are currently connecting.
    Defaults to 10.
    
    Returns:
    
    the maximum number of pending connections
  - setMaxPendingConnectsPerHost
```
public void setMaxPendingConnectsPerHost(int maxPending)
```
    Sets the maximum number of pending connections per DAX node.
    Pending connections are connections which are currently connecting.
    Defaults to 10.
    
    Parameters:
    
    maxPending - the maximum number of pending connections
  - withMaxPendingConnectsPerHost
```
public ClientConfig withMaxPendingConnectsPerHost(int maxPending)
```
    Sets the maximum number of pending connections per DAX node.
    Pending connections are connections which are currently connecting.
    Defaults to 10.
    
    Parameters:
    
    maxPending - the maximum number of pending connections
    
    Returns:
    
    this object for method chaining
  - getReadRetries
```
public int getReadRetries()
```
    Returns the number of times to retry reads (not counting the initial try). Defaults to 2.
    
    Returns:
    
    the number of times to retry
  - setReadRetries
```
public void setReadRetries(int readRetries)
```
    Sets the number of times to retry reads (not counting the initial try).
    Defaults to 2.
    
    Parameters:
    
    readRetries - the number of times to retry
  - withReadRetries
```
public ClientConfig withReadRetries(int readRetries)
```
    Sets the number of times to retry reads (not counting the initial try).
    Defaults to 2.
    
    Parameters:
    
    readRetries - the number of times to retry
    
    Returns:
    
    this object for method chaining
  - getThreadKeepAlive
```
public long getThreadKeepAlive()
```
    Returns the health check thread keep alive time.
    This is the length of time before idle threads will be terminated. The affected threads are monitoring connections to the DAX cluster. Defaults to 10000L ms.
    
    Returns:
    
    the keep alive time in ns
  - setThreadKeepAlive
```
public void setThreadKeepAlive(long threadKeepAlive,
                               TimeUnit unit)
```
    Sets the health check thread keep alive time.
    This is the length of time before idle threads will be terminated. The affected threads are monitoring connections to the DAX cluster. Defaults to 10000L ms.
    
    Parameters:
    
    threadKeepAlive - the keep alive time
    
    unit - the time unit for threadKeepAlive
  - withThreadKeepAlive
```
public ClientConfig withThreadKeepAlive(long threadKeepAlive,
                                        TimeUnit unit)
```
    Sets the health check thread keep alive time.
    This is the length of time before idle threads will be terminated. The affected threads are monitoring connections to the DAX cluster. Defaults to 10000L ms.
    
    Parameters:
    
    threadKeepAlive - the keep alive time
    
    unit - the time unit for threadKeepAlive
    
    Returns:
    
    this object for method chaining
  - getClusterUpdateInterval
```
public long getClusterUpdateInterval()
```
    Returns the interval between polling of cluster members for membership changes. Defaults to 4000L ms.
    
    Returns:
    
    the interval between polling
  - setClusterUpdateInterval
```
public void setClusterUpdateInterval(long clusterUpdateInterval,
                                     TimeUnit unit)
```
    Sets the interval between polling of cluster members for membership changes.
    Defaults to 4000L ms.
    
    Parameters:
    
    clusterUpdateInterval - the interval between polling
    
    unit - the time unit for clusterUpdateInterval
  - withClusterUpdateInterval
```
public ClientConfig withClusterUpdateInterval(long clusterUpdateInterval,
                                              TimeUnit unit)
```
    Sets the interval between polling of cluster members for membership changes.
    Defaults to 4000L ms.
    
    Parameters:
    
    clusterUpdateInterval - the interval between polling
    
    unit - the time unit for clusterUpdateInterval
    
    Returns:
    
    this object for method chaining
  - getClusterUpdateThreshold
```
public long getClusterUpdateThreshold()
```
    Returns the threshold below which the cluster will not be polled for membership changes. Defaults to 125L ms.
    
    Returns:
    
    the update threshold in ns
  - setClusterUpdateThreshold
```
public void setClusterUpdateThreshold(long clusterUpdateThreshold,
                                      TimeUnit unit)
```
    Sets the threshold below which explicit unforced cluster refresh requests will not be attempted to poll for membership changes.
    Defaults to 125L ms.
    
    Parameters:
    
    clusterUpdateThreshold - the update threshold
    
    unit - the time unit for clusterUpdateThreshold
  - withClusterUpdateThreshold
```
public ClientConfig withClusterUpdateThreshold(long clusterUpdateThreshold,
                                               TimeUnit unit)
```
    Sets the threshold below which explicit unforced cluster refresh requests will not be attempted to poll for membership changes.
    Defaults to 125L ms.
    
    Parameters:
    
    clusterUpdateThreshold - the update threshold
    
    unit - the time unit for clusterUpdateThreshold
    
    Returns:
    
    this object for method chaining
  - getCredentialsProvider
```
public AWSCredentialsProvider getCredentialsProvider()
```
    Sets the credentials provider used to sign requests to the DAX cluster.
    
    Returns:
    
    the credentials provider
  - setCredentialsProvider
```
public void setCredentialsProvider(AWSCredentialsProvider provider)
```
    Sets the credentials provider used to sign requests to the DAX cluster.
    
    Parameters:
    
    provider - the credentials provider
  - withCredentialsProvider
```
public ClientConfig withCredentialsProvider(AWSCredentialsProvider provider)
```
    Sets the credentials provider used to sign requests to the DAX cluster.
    
    Parameters:
    
    provider - the credentials provider
    
    Returns:
    
    this object for method chaining
  - getMaxRetryDelay
```
public long getMaxRetryDelay()
```
    Returns the maximum delay between retries when the cluster is believed to be recovering.
    If the cluster is believed to be healthy this delay is not used; instead a retry is immediately attempted (on another node if the cluster has more than one member). Defaults to 7000L ms.
    
    Returns:
    
    the maximum delay in ns
  - setMaxRetryDelay
```
public void setMaxRetryDelay(long retryDelayCap,
                             TimeUnit unit)
```
    Sets the maximum delay between retries when the cluster is believed to be recovering.
    If the cluster is believed to be healthy this delay is not used; instead a retry is immediately attempted (on another node if the cluster has more than one member). Defaults to 7000L ms.
    
    Parameters:
    
    retryDelayCap - the maximum delay
    
    unit - the time unit for retryDelayCap
  - withMaxRetryDelay
```
public ClientConfig withMaxRetryDelay(long retryDelayCap,
                                      TimeUnit unit)
```
    Sets the maximum delay between retries when the cluster is believed to be recovering.
    If the cluster is believed to be healthy this delay is not used; instead a retry is immediately attempted (on another node if the cluster has more than one member). Defaults to 7000L ms.
    
    Parameters:
    
    retryDelayCap - the maximum delay
    
    unit - the time unit for retryDelayCap
    
    Returns:
    
    this object for method chaining
  - getRegion
```
public String getRegion()
```
    Returns the AWS region.
    The region is necessary for signing requests; it is not used for cluster discovery.
    
    Returns:
    
    the region
  - setRegion
```
public void setRegion(Region region)
```
    Sets the AWS region.
    The region is necessary for signing requests; it is not used for cluster discovery.
    
    Parameters:
    
    region - the region
  - setRegion
```
public void setRegion(String region)
```
    Sets the AWS region.
    The region is necessary for signing requests; it is not used for cluster discovery.
    
    Parameters:
    
    region - the region
  - withRegion
```
public ClientConfig withRegion(Region region)
```
    Sets the AWS region.
    The region is necessary for signing requests; it is not used for cluster discovery.
    
    Parameters:
    
    region - the region
    
    Returns:
    
    this object for method chaining
  - withRegion
```
public ClientConfig withRegion(String region)
```
    Sets the AWS region.
    The region is necessary for signing requests; it is not used for cluster discovery.
    
    Parameters:
    
    region - the region
    
    Returns:
    
    this object for method chaining
  - getUnhealthyConsecutiveErrorCount
```
public int getUnhealthyConsecutiveErrorCount()
```
    Returns the number of errors required to signal node unhealthy within health check interval
    Defaults to 5.
    
    Returns:
    
    number of errors
  - setUnhealthyConsecutiveErrorCount
```
public void setUnhealthyConsecutiveErrorCount(int errorCount)
```
    Sets the number of consecutive errors required to signal node unhealthy within health check interval. If number of errors exceed the specified value, no more requests are routed to that particular node.
    Defaults to 5.
    
    Parameters:
    
    errorCount - number of errors
  - withUnhealthyConsecutiveErrorCount
```
public ClientConfig withUnhealthyConsecutiveErrorCount(int errorCount)
```
    Sets the number of consecutive errors required to signal node unhealthy within health check interval. If number of errors exceed the specified value, no more requests are routed to that particular node.
    Defaults to 5.
    
    Parameters:
    
    errorCount - number of errors
    
    Returns:
    
    this object for method chaining

Class ClientConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_PENDING_CONNECTIONS_PER_HOST

DEFAULT_UNHEALTHY_CONSECUTIVE_ERROR_COUNT

DEFAULT_CLUSTER_UPDATE_INTERVAL_MS

DEFAULT_CLUSTER_UPDATE_THRESHOLD_MS

DEFAULT_CONNECT_TIMEOUT_MS

DEFAULT_REQUEST_TIMEOUT_MS

DEFAULT_HEALTH_CHECK_INTERVAL_MS

DEFAULT_HEALTH_CHECK_TIMEOUT_MS

DEFAULT_IDLE_CONNECTION_TIMEOUT_MS

DEFAULT_READ_RETRIES

DEFAULT_WRITE_RETRIES

DEFAULT_MAX_RETRY_DELAY_MS

DEFAULT_THREAD_KEEP_ALIVE_MS

DEFAULT_MIN_IDLE_CONNECTION_SIZE

mProvider

mRegion

Constructor Detail

ClientConfig

Method Detail

isEncrypted

getHostPorts

getHostVerifier

setEndpoints

setEndpoints

withEndpoints

withEndpoints

getConnectTimeout

setConnectTimeout

withConnectTimeout

getRequestTimeout

setRequestTimeout

withRequestTimeout

getHealthCheckTimeout

setHealthCheckTimeout

withHealthCheckTimeout

getHealthCheckInterval

setHealthCheckInterval

withHealthCheckInterval

getIdleConnectionTimeout

setIdleConnectionTimeout

withIdleConnectionTimeout

getMinIdleConnectionSize

setMinIdleConnectionSize

withMinIdleConnectionSize

getWriteRetries

setWriteRetries

withWriteRetries

getMaxPendingConnectsPerHost

setMaxPendingConnectsPerHost

withMaxPendingConnectsPerHost

getReadRetries

setReadRetries

withReadRetries

getThreadKeepAlive

setThreadKeepAlive

withThreadKeepAlive

getClusterUpdateInterval

setClusterUpdateInterval

withClusterUpdateInterval

getClusterUpdateThreshold

setClusterUpdateThreshold

withClusterUpdateThreshold

getCredentialsProvider

setCredentialsProvider

withCredentialsProvider

getMaxRetryDelay

setMaxRetryDelay

withMaxRetryDelay

getRegion

setRegion

setRegion

withRegion

withRegion

getUnhealthyConsecutiveErrorCount