ClientConfiguration (AliCloud TableStore SDK for Java 5.17.7 API)

java.lang.Object
- com.alicloud.openservices.tablestore.ClientConfiguration

```
public class ClientConfiguration
extends Object
```
Client configuration for accessing the Alibaba Cloud service.

构造器概要

构造器
构造器和说明

ClientConfiguration()
Constructs a new instance.

构造器
构造器和说明
`ClientConfiguration()` Constructs a new instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`int`	`getConnectionRequestTimeoutInMillisecond()`
`int`	`getConnectionTimeoutInMillisecond()` Returns the timeout for establishing a connection (unit: milliseconds). 0 means infinite waiting (but not recommended).
`int`	`getDnsCacheExpireAfterWriteSec()` Get the expiration time of DNS cache, in seconds.
`int`	`getDnsCacheMaxSize()` Get the number of entries in the DNS cache
`int`	`getDnsCacheRefreshAfterWriteSec()` Get the refresh frequency of DNS cache, in seconds.
`int`	`getIoThreadCount()` Returns the number of threads for the IOReactor of the HttpAsyncClient.
`int`	`getMaxConnections()` Returns the maximum number of allowed open HTTP connections.
`String`	`getProxyDomain()` Returns the Windows domain name for accessing the NTLM authenticated proxy server (optional).
`String`	`getProxyHost()` Returns the proxy server host address.
`String`	`getProxyPassword()` Returns the password for proxy server authentication.
`int`	`getProxyPort()` Returns the proxy server port.
`String`	`getProxyUsername()` Returns the username verified by the proxy server.
`String`	`getProxyWorkstation()` Returns the Windows workstation name of the NTLM proxy server.
`RequestTracer`	`getRequestTracer()` Get the link tracking system interface
`RetryStrategy`	`getRetryStrategy()` Returns the request retry policy of TableStore
`int`	`getRetryThreadCount()` Returns the number of threads in the thread pool used for executing error retries.
`int`	`getSocketTimeoutInMillisecond()` Returns the timeout for transmitting data via the opened connection (unit: milliseconds). 0 means infinite waiting (but not recommended).
`int`	`getSslSessionCacheSize()` Get the cache size of the ssl session
`int`	`getSslSessionTimeoutInSec()` Get the timeout of the ssl session
`long`	`getSyncClientWaitFutureTimeoutInMillis()` Get the maximum timeout for waiting asynchronous call returns in the sync Client.
`TimeseriesConfiguration`	`getTimeseriesConfiguration()` Get the configuration of the time series Client.
`int`	`getTimeThresholdOfServerTracer()` Returns the current server-side Tracer time threshold setting (unit: milliseconds).
`int`	`getTimeThresholdOfTraceLogger()` Returns the currently set time threshold (unit: milliseconds).
`boolean`	`isEnableDnsCache()` Get the status of DNS cache
`boolean`	`isEnableRequestCompression()` Returns whether the request data needs to be compressed.
`boolean`	`isEnableRequestTracer()` Get the status of the link tracking system.
`boolean`	`isEnableResponseCompression()` Returns whether to inform TableStore to compress the response content.
`boolean`	`isEnableResponseContentMD5Checking()` Returns whether the response content needs to be verified by MD5.
`boolean`	`isEnableResponseValidation()` Returns whether the response needs to be verified.
`void`	`setConnectionRequestTimeoutInMillisecond(int connectionRequestTimeoutInMillisecond)` Set the ConnectionRequestTimeout configuration for HttpAsyncClient.
`void`	`setConnectionTimeoutInMillisecond(int connectionTimeoutInMillisecond)` Set the timeout for establishing a connection (unit: milliseconds). 0 means wait indefinitely (but not recommended).
`void`	`setDnsCacheExpireAfterWriteSec(int dnsCacheExpireAfterWriteSec)` Set the expiration time for DNS cache, in seconds.
`void`	`setDnsCacheRefreshAfterWriteSec(int dnsCacheRefreshAfterWriteSec)` Set the refresh frequency of DNS cache, in seconds.
`void`	`setEnableDnsCache(boolean enableDnsCache)` Set whether to enable DNS cache
`void`	`setEnableRequestCompression(boolean enableRequestCompression)` Set whether to enable compression for request data
`void`	`setEnableRequestTracer(boolean enableRequestTracer)` Set whether the link tracing system is enabled
`void`	`setEnableResponseCompression(boolean enableResponseCompression)` Whether to inform TableStore to compress the content of the returned response.
`void`	`setEnableResponseContentMD5Checking(boolean enableResponseContentMD5Checking)` Whether to enable MD5 verification for the content of the response.
`void`	`setEnableResponseValidation(boolean enableResponseValidation)` Whether to enable validation of the response.
`void`	`setIoThreadCount(int ioThreadCount)` Set the number of threads for the IOReactor of the HttpAsyncClient (since asynchronous IO is used, a large number of threads does not need to be configured, and each thread can provide high concurrency).
`void`	`setMaxConnections(int maxConnections)` Set the maximum number of HTTP connections allowed to be opened (the number of connections affects concurrency and should be determined by factors such as QPS, the time for a single request, machine configuration, etc., to set a reasonable value).
`void`	`setProxyDomain(String proxyDomain)` Set the Windows domain name for accessing the NTLM authentication proxy server (optional).
`void`	`setProxyHost(String proxyHost)` Set the proxy server host address.
`void`	`setProxyPassword(String proxyPassword)` Set the password for proxy server authentication.
`void`	`setProxyPort(int proxyPort)` Set the proxy server port.
`void`	`setProxyUsername(String proxyUsername)` Set the username for proxy server authentication.
`void`	`setProxyWorkstation(String proxyWorkstation)` Set the Windows workstation name for the NTLM proxy server.
`void`	`setRequestTracer(RequestTracer requestTracer)` Set the interface for the link tracing system
`void`	`setRetryStrategy(RetryStrategy retryStrategy)` Set the request retry strategy for TableStore
`void`	`setRetryThreadCount(int retryThreadCount)` Set the number of threads in the thread pool used for executing error retries.
`void`	`setSocketTimeoutInMillisecond(int socketTimeoutInMillisecond)` Set the timeout for transmitting data through an opened connection (unit: milliseconds). 0 means infinite wait (but it is not recommended).
`void`	`setSslSessionCacheSize(int sslSessionCacheSize)` Set the cache size of the ssl session
`void`	`setSslSessionTimeoutInSec(int seconds)` Set the timeout for the SSL session
`void`	`setSyncClientWaitFutureTimeoutInMillis(long syncClientWaitFutureTimeoutInMillis)` Set the maximum timeout for waiting for asynchronous calls to return within the sync Client.
`void`	`setTimeseriesConfiguration(TimeseriesConfiguration timeseriesConfiguration)` Set the configuration for the timeseries Client.
`void`	`setTimeThresholdOfServerTracer(int timeThresholdOfServerTracer)` Set the time threshold for the server Tracer (unit: milliseconds).
`void`	`setTimeThresholdOfTraceLogger(int timeThresholdOfTraceLogger)` Set a time threshold (unit: milliseconds).

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ClientConfiguration
```
public ClientConfiguration()
```
    Constructs a new instance.
- 方法详细资料
  - setEnableRequestCompression
```
public void setEnableRequestCompression(boolean enableRequestCompression)
```
    Set whether to enable compression for request data
    
    参数:
    
    enableRequestCompression - Whether to compress (true/false)
  - isEnableRequestCompression
```
public boolean isEnableRequestCompression()
```
    Returns whether the request data needs to be compressed.
    
    返回:
    
    Whether the request needs to be compressed.
  - setEnableResponseCompression
```
public void setEnableResponseCompression(boolean enableResponseCompression)
```
    Whether to inform TableStore to compress the content of the returned response.
    
    参数:
    
    enableResponseCompression - whether to inform TableStore to compress the content of the returned response.
  - isEnableResponseCompression
```
public boolean isEnableResponseCompression()
```
    Returns whether to inform TableStore to compress the response content.
    
    返回:
    
    whether to inform TableStore to compress the response content
  - isEnableResponseValidation
```
public boolean isEnableResponseValidation()
```
    Returns whether the response needs to be verified.
    
    返回:
    
    Whether the response needs to be verified.
  - setEnableResponseValidation
```
public void setEnableResponseValidation(boolean enableResponseValidation)
```
    Whether to enable validation of the response. If enabled, the Client will validate the integrity of the headers, whether the results are expired, and the correctness of the authorization information.
    
    参数:
    
    enableResponseValidation - whether to enable validation of the response
  - getIoThreadCount
```
public int getIoThreadCount()
```
    Returns the number of threads for the IOReactor of the HttpAsyncClient.
    
    返回:
    
    the number of threads for the IOReactor
  - setIoThreadCount
```
public void setIoThreadCount(int ioThreadCount)
```
    Set the number of threads for the IOReactor of the HttpAsyncClient (since asynchronous IO is used, a large number of threads does not need to be configured, and each thread can provide high concurrency).
    
    参数:
    
    ioThreadCount - Number of threads for the IOReactor
  - getMaxConnections
```
public int getMaxConnections()
```
    Returns the maximum number of allowed open HTTP connections.
    
    返回:
    
    The maximum number of HTTP connections.
  - setMaxConnections
```
public void setMaxConnections(int maxConnections)
```
    Set the maximum number of HTTP connections allowed to be opened (the number of connections affects concurrency and should be determined by factors such as QPS, the time for a single request, machine configuration, etc., to set a reasonable value).
    
    参数:
    
    maxConnections - The maximum number of HTTP connections.
  - getSocketTimeoutInMillisecond
```
public int getSocketTimeoutInMillisecond()
```
    Returns the timeout for transmitting data via the opened connection (unit: milliseconds). 0 means infinite waiting (but not recommended). Subject to the system's timeout limit.
    
    返回:
    
    The timeout for transmitting data via the opened connection (unit: milliseconds).
  - setSocketTimeoutInMillisecond
```
public void setSocketTimeoutInMillisecond(int socketTimeoutInMillisecond)
```
    Set the timeout for transmitting data through an opened connection (unit: milliseconds). 0 means infinite wait (but it is not recommended). It is subject to the system's timeout limit.
    
    参数:
    
    socketTimeoutInMillisecond - The timeout for transmitting data through an opened connection (unit: milliseconds).
  - getConnectionTimeoutInMillisecond
```
public int getConnectionTimeoutInMillisecond()
```
    Returns the timeout for establishing a connection (unit: milliseconds). 0 means infinite waiting (but not recommended). Subject to the system's timeout limit.
    
    返回:
    
    The timeout for establishing a connection (unit: milliseconds).
  - setConnectionTimeoutInMillisecond
```
public void setConnectionTimeoutInMillisecond(int connectionTimeoutInMillisecond)
```
    Set the timeout for establishing a connection (unit: milliseconds). 0 means wait indefinitely (but not recommended). Subject to the system's timeout restrictions.
    
    参数:
    
    connectionTimeoutInMillisecond - Timeout for establishing a connection (unit: milliseconds).
  - getRetryThreadCount
```
public int getRetryThreadCount()
```
    Returns the number of threads in the thread pool used for executing error retries. This thread pool is a ScheduledExecutorService.
    
    返回:
    
    The number of threads in the thread pool used for executing error retries.
  - setRetryThreadCount
```
public void setRetryThreadCount(int retryThreadCount)
```
    Set the number of threads in the thread pool used for executing error retries. This thread pool is a ScheduledExecutorService.
    
    参数:
    
    retryThreadCount - The number of threads in the thread pool used for executing error retries.
  - isEnableResponseContentMD5Checking
```
public boolean isEnableResponseContentMD5Checking()
```
    Returns whether the response content needs to be verified by MD5.
    
    返回:
    
    Whether the MD5 content needs to be verified by MD5.
  - setEnableResponseContentMD5Checking
```
public void setEnableResponseContentMD5Checking(boolean enableResponseContentMD5Checking)
```
    Whether to enable MD5 verification for the content of the response. If enabled, the Client will calculate the MD5 value of the response data and compare it with the value in the x-ots-contentmd5 header of the response.
    
    参数:
    
    enableResponseContentMD5Checking - Whether to verify the MD5 of the response data
  - getRetryStrategy
```
public RetryStrategy getRetryStrategy()
```
    Returns the request retry policy of TableStore
    
    返回:
    
    request retry policy
  - setRetryStrategy
```
public void setRetryStrategy(RetryStrategy retryStrategy)
```
    Set the request retry strategy for TableStore
    
    参数:
    
    retryStrategy - The request retry strategy for TableStore
  - getTimeThresholdOfTraceLogger
```
public int getTimeThresholdOfTraceLogger()
```
    Returns the currently set time threshold (unit: milliseconds). When the total execution time of a request (including the time used for retries) exceeds this threshold, the SDK will log a WARN-level message. This feature depends on the logging-related configurations.
    
    返回:
    
    Time threshold
  - setTimeThresholdOfTraceLogger
```
public void setTimeThresholdOfTraceLogger(int timeThresholdOfTraceLogger)
```
    Set a time threshold (unit: milliseconds). When the total execution time of a request (including the time used for retries) exceeds this threshold, the SDK will log a WARN level message. This feature depends on the logging-related configurations.
    
    参数:
    
    timeThresholdOfTraceLogger - trace logger
  - getTimeThresholdOfServerTracer
```
public int getTimeThresholdOfServerTracer()
```
    Returns the current server-side Tracer time threshold setting (unit: milliseconds). When a request takes longer than this threshold to execute on the server side, the SDK will receive tracer information from the server and record it. This feature depends on relevant server-side configurations.
    
    返回:
    
    Time threshold
  - setTimeThresholdOfServerTracer
```
public void setTimeThresholdOfServerTracer(int timeThresholdOfServerTracer)
```
    Set the time threshold for the server Tracer (unit: milliseconds). When the execution time of a request on the server exceeds this threshold, the SDK will receive tracer information from the server and record it. This feature depends on the relevant server configuration.
    
    参数:
    
    timeThresholdOfServerTracer - trace logger
  - getProxyHost
```
public String getProxyHost()
```
    Returns the proxy server host address.
    
    返回:
    
    The proxy server host address.
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    Set the proxy server host address.
    
    参数:
    
    proxyHost - The proxy server host address.
  - getProxyPort
```
public int getProxyPort()
```
    Returns the proxy server port.
    
    返回:
    
    The proxy server port.
  - setProxyPort
```
public void setProxyPort(int proxyPort)
```
    Set the proxy server port.
    
    参数:
    
    proxyPort - The proxy server port.
  - getProxyUsername
```
public String getProxyUsername()
```
    Returns the username verified by the proxy server.
    
    返回:
    
    Username.
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
    Set the username for proxy server authentication.
    
    参数:
    
    proxyUsername - The username.
  - getProxyPassword
```
public String getProxyPassword()
```
    Returns the password for proxy server authentication.
    
    返回:
    
    The password.
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    Set the password for proxy server authentication.
    
    参数:
    
    proxyPassword - The password.
  - getProxyDomain
```
public String getProxyDomain()
```
    Returns the Windows domain name for accessing the NTLM authenticated proxy server (optional).
    
    返回:
    
    The domain name.
  - setProxyDomain
```
public void setProxyDomain(String proxyDomain)
```
    Set the Windows domain name for accessing the NTLM authentication proxy server (optional).
    
    参数:
    
    proxyDomain - The domain name.
  - getProxyWorkstation
```
public String getProxyWorkstation()
```
    Returns the Windows workstation name of the NTLM proxy server.
    
    返回:
    
    The Windows workstation name of the NTLM proxy server.
  - setProxyWorkstation
```
public void setProxyWorkstation(String proxyWorkstation)
```
    Set the Windows workstation name for the NTLM proxy server. (Optional, this parameter does not need to be set if the proxy server is not NTLM).
    
    参数:
    
    proxyWorkstation - The Windows workstation name for the NTLM proxy server.
  - getSyncClientWaitFutureTimeoutInMillis
```
public long getSyncClientWaitFutureTimeoutInMillis()
```
    Get the maximum timeout for waiting asynchronous call returns in the sync Client.
    
    返回:
  - setSyncClientWaitFutureTimeoutInMillis
```
public void setSyncClientWaitFutureTimeoutInMillis(long syncClientWaitFutureTimeoutInMillis)
```
    Set the maximum timeout for waiting for asynchronous calls to return within the sync Client.
    
    参数:
    
    syncClientWaitFutureTimeoutInMillis -
  - getTimeseriesConfiguration
```
public TimeseriesConfiguration getTimeseriesConfiguration()
```
    Get the configuration of the time series Client.
    
    返回:
  - setTimeseriesConfiguration
```
public void setTimeseriesConfiguration(TimeseriesConfiguration timeseriesConfiguration)
```
    Set the configuration for the timeseries Client.
    
    参数:
    
    timeseriesConfiguration -
  - getConnectionRequestTimeoutInMillisecond
```
public int getConnectionRequestTimeoutInMillisecond()
```
  - setConnectionRequestTimeoutInMillisecond
```
public void setConnectionRequestTimeoutInMillisecond(int connectionRequestTimeoutInMillisecond)
```
    Set the ConnectionRequestTimeout configuration for HttpAsyncClient.
    
    参数:
    
    connectionRequestTimeoutInMillisecond -
  - isEnableRequestTracer
```
public boolean isEnableRequestTracer()
```
    Get the status of the link tracking system.
  - setEnableRequestTracer
```
public void setEnableRequestTracer(boolean enableRequestTracer)
```
    Set whether the link tracing system is enabled
    
    参数:
    
    enableRequestTracer -
  - isEnableDnsCache
```
public boolean isEnableDnsCache()
```
    Get the status of DNS cache
  - setEnableDnsCache
```
public void setEnableDnsCache(boolean enableDnsCache)
```
    Set whether to enable DNS cache
    
    参数:
    
    enableDnsCache - Control the configuration of whether to turn on DNS cache
  - getDnsCacheMaxSize
```
public int getDnsCacheMaxSize()
```
    Get the number of entries in the DNS cache
  - getDnsCacheExpireAfterWriteSec
```
public int getDnsCacheExpireAfterWriteSec()
```
    Get the expiration time of DNS cache, in seconds.
  - setDnsCacheExpireAfterWriteSec
```
public void setDnsCacheExpireAfterWriteSec(int dnsCacheExpireAfterWriteSec)
```
    Set the expiration time for DNS cache, in seconds.
  - getDnsCacheRefreshAfterWriteSec
```
public int getDnsCacheRefreshAfterWriteSec()
```
    Get the refresh frequency of DNS cache, in seconds.
  - setDnsCacheRefreshAfterWriteSec
```
public void setDnsCacheRefreshAfterWriteSec(int dnsCacheRefreshAfterWriteSec)
```
    Set the refresh frequency of DNS cache, in seconds.
  - setRequestTracer
```
public void setRequestTracer(RequestTracer requestTracer)
```
    Set the interface for the link tracing system
    
    参数:
    
    requestTracer - Interface for the link tracing system
  - getRequestTracer
```
public RequestTracer getRequestTracer()
```
    Get the link tracking system interface
    
    返回:
    
    Implementation of the link tracking system interface
  - setSslSessionCacheSize
```
public void setSslSessionCacheSize(int sslSessionCacheSize)
```
    Set the cache size of the ssl session
    
    参数:
    
    sslSessionCacheSize - the cache size of the ssl session
  - getSslSessionCacheSize
```
public int getSslSessionCacheSize()
```
    Get the cache size of the ssl session
    
    返回:
    
    sslSessionCacheSize
  - setSslSessionTimeoutInSec
```
public void setSslSessionTimeoutInSec(int seconds)
```
    Set the timeout for the SSL session
    
    参数:
    
    seconds - The timeout for the SSL session, 0 means no limit; the timeout should be no less than 0, in seconds
  - getSslSessionTimeoutInSec
```
public int getSslSessionTimeoutInSec()
```
    Get the timeout of the ssl session
    
    返回:
    
    sslSessionTimeout The timeout of the ssl session, 0 means no limit, -1 means not configured; timeout is in seconds

类 ClientConfiguration

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ClientConfiguration

方法详细资料

setEnableRequestCompression

isEnableRequestCompression

setEnableResponseCompression

isEnableResponseCompression

isEnableResponseValidation

setEnableResponseValidation

getIoThreadCount

setIoThreadCount

getMaxConnections

setMaxConnections

getSocketTimeoutInMillisecond

setSocketTimeoutInMillisecond

getConnectionTimeoutInMillisecond

setConnectionTimeoutInMillisecond

getRetryThreadCount

setRetryThreadCount

isEnableResponseContentMD5Checking

setEnableResponseContentMD5Checking

getRetryStrategy

setRetryStrategy

getTimeThresholdOfTraceLogger

setTimeThresholdOfTraceLogger

getTimeThresholdOfServerTracer

setTimeThresholdOfServerTracer

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getProxyUsername

setProxyUsername

getProxyPassword

setProxyPassword

getProxyDomain

setProxyDomain

getProxyWorkstation

setProxyWorkstation

getSyncClientWaitFutureTimeoutInMillis

setSyncClientWaitFutureTimeoutInMillis

getTimeseriesConfiguration

setTimeseriesConfiguration

getConnectionRequestTimeoutInMillisecond

setConnectionRequestTimeoutInMillisecond

isEnableRequestTracer

setEnableRequestTracer

isEnableDnsCache

setEnableDnsCache

getDnsCacheMaxSize

getDnsCacheExpireAfterWriteSec

setDnsCacheExpireAfterWriteSec

getDnsCacheRefreshAfterWriteSec

setDnsCacheRefreshAfterWriteSec

setRequestTracer

getRequestTracer

setSslSessionCacheSize

getSslSessionCacheSize

setSslSessionTimeoutInSec

getSslSessionTimeoutInSec