ClientConfiguration (yop-java-sdk-base 4.4.12 API)

java.lang.Object
- com.yeepay.yop.sdk.client.ClientConfiguration

public class ClientConfiguration
extends Object

Basic client configurations for YOP clients.

字段概要

字段
限定符和类型	字段和说明
`static int`	`DEFAULT_CONNECTION_REQUEST_TIMEOUT_IN_MILLIS` The default timeout for request new connections form pool.
`static int`	`DEFAULT_CONNECTION_TIMEOUT_IN_MILLIS` The default timeout for creating new connections.
`static int`	`DEFAULT_MAX_CONNECTIONS` The default max connection pool size.
`static int`	`DEFAULT_MAX_CONNECTIONS_PER_ROUTE` The default max connections per route
`static Protocol`	`DEFAULT_PROTOCOL` The default protocol.
`static Region`	`DEFAULT_REGION` The default region.
`static int`	`DEFAULT_SOCKET_TIMEOUT_IN_MILLIS` The default timeout for reading from a connected socket.
`static String`	`DEFAULT_USER_AGENT` The default User-Agent header value when sending requests to the target service.

构造器概要

构造器
构造器和说明
`ClientConfiguration()` Constructs a new ClientConfiguration instance with default settings.
`ClientConfiguration(ClientConfiguration other)` Constructs a new ClientConfiguration instance with the same settings as the specified configuration.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`YopCircuitBreakerConfig`	`getCircuitBreakerConfig()`
`String`	`getClientImpl()` Returns the Http Client Impl
`int`	`getConnectionRequestTimeoutInMillis()` Returns the connection request timeout in milliseconds.
`int`	`getConnectionTimeoutInMillis()` Returns the connection timeout in milliseconds.
`YopCredentials<?>`	`getCredentials()` Returns the YOP credentials used by the client to sign HTTP requests.
`InetAddress`	`getLocalAddress()` Returns the optional local address to bind when connecting to YOP services.
`int`	`getMaxConnections()` Returns the maximum number of open HTTP connections.
`int`	`getMaxConnectionsPerRoute()`
`int`	`getMaxRetryCount()`
`Protocol`	`getProtocol()` Returns the protocol (HTTP/HTTPS) to use when connecting to YOP services.
`String`	`getProxyDomain()` Returns the optional Windows domain to use when connecting through a Windows NTLM proxy.
`String`	`getProxyHost()` Returns the optional proxy host the client will connect through.
`String`	`getProxyPassword()` Returns the optional password to use when connecting through a proxy.
`int`	`getProxyPort()` Returns the optional proxy port the client will connect through.
`String`	`getProxyScheme()` Returns the optional proxy scheme the client will connect through.
`String`	`getProxyUsername()` Returns the optional user name to use when connecting through a proxy.
`String`	`getProxyWorkstation()` Returns the optional Windows workstation to use when connecting through a Windows NTLM proxy.
`Region`	`getRegion()` Returns the region of service.
`Set<String>`	`getRetryExceptions()`
`RetryPolicy`	`getRetryPolicy()` Returns the retry policy for failed requests.
`int`	`getSocketBufferSizeInBytes()` Returns the optional size (in bytes) for the low level TCP socket buffer.
`int`	`getSocketTimeoutInMillis()` Returns the socket timeout (SO_TIMEOUT) in milliseconds, which is a maximum period inactivity between two consecutive data packets.
`String`	`getUserAgent()` Returns the User-Agent header value to use when sending requests to YOP services.
`boolean`	`isProxyPreemptiveAuthenticationEnabled()` Returns whether to enable proxy preemptive authentication.
`void`	`setCircuitBreakerConfig(YopCircuitBreakerConfig circuitBreakerConfig)`
`void`	`setClientImpl(String clientImpl)` Sets the Http Client Impl
`void`	`setConnectionRequestTimeoutInMillis(int connectionRequestTimeoutInMillis)` Sets the connection request timeout in milliseconds.
`void`	`setConnectionTimeoutInMillis(int connectionTimeoutInMillis)` Sets the connection timeout in milliseconds.
`void`	`setCredentials(YopCredentials<?> credentials)` Sets the YOP credentials used by the client to sign HTTP requests.
`void`	`setLocalAddress(InetAddress localAddress)` Sets the optional local address to bind when connecting to YOP services.
`void`	`setMaxConnections(int maxConnections)` Sets the maximum number of open HTTP connections.
`void`	`setMaxConnectionsPerRoute(int maxConnectionsPerRoute)`
`void`	`setMaxRetryCount(int maxRetryCount)`
`void`	`setProtocol(Protocol protocol)` Sets the protocol (HTTP/HTTPS) to use when connecting to YOP services.
`void`	`setProxyDomain(String proxyDomain)` Sets the optional Windows domain to use when connecting through a Windows NTLM proxy.
`void`	`setProxyHost(String proxyHost)` Sets the optional proxy host the client will connect through.
`void`	`setProxyPassword(String proxyPassword)` Sets the optional password to use when connecting through a proxy.
`void`	`setProxyPort(int proxyPort)` Sets the optional proxy port the client will connect through.
`void`	`setProxyPreemptiveAuthenticationEnabled(boolean proxyPreemptiveAuthenticationEnabled)` Sets whether to enable proxy preemptive authentication.
`void`	`setProxyScheme(String proxyScheme)` Sets the optional proxy scheme the client will connect through.
`void`	`setProxyUsername(String proxyUsername)` Sets the optional user name to use when connecting through a proxy.
`void`	`setProxyWorkstation(String proxyWorkstation)` Sets the optional Windows workstation to use when connecting through a Windows NTLM proxy.
`void`	`setRegion(Region region)` Sets the region of service.
`void`	`setRetryExceptions(Set<String> retryExceptions)`
`void`	`setRetryPolicy(RetryPolicy retryPolicy)` Sets the retry policy for failed requests.
`void`	`setSocketBufferSizeInBytes(int socketBufferSizeInBytes)` Sets the optional size (in bytes) for the low level TCP socket buffer.
`void`	`setSocketTimeoutInMillis(int socketTimeoutInMillis)` Sets the socket timeout (SO_TIMEOUT) in milliseconds, which is a maximum period inactivity between two consecutive data packets.
`void`	`setUserAgent(String userAgent)` Sets the User-Agent header value to use when sending requests to YOP services.
`String`	`toString()`
`ClientConfiguration`	`withCircuitBreakerConfig(YopCircuitBreakerConfig circuitBreakerConfig)`
`ClientConfiguration`	`withClientImpl(String clientImpl)` Sets the Http Client Impl.
`ClientConfiguration`	`withConnectionRequestTimeoutInMillis(int connectionRequestTimeoutInMillis)` Sets the connection request timeout in milliseconds, and returns the updated configuration instance.
`ClientConfiguration`	`withConnectionTimeoutInMillis(int connectionTimeoutInMillis)` Sets the connection timeout in milliseconds, and returns the updated configuration instance.
`ClientConfiguration`	`withCredentials(YopCredentials<?> credentials)` Sets the YOP credentials used by the client to sign HTTP requests, and returns the updated configuration instance.
`ClientConfiguration`	`withLocalAddress(InetAddress localAddress)` Sets the optional local address to bind when connecting to YOP services, and returns the updated configuration instance.
`ClientConfiguration`	`withMaxConnections(int maxConnections)` Sets the maximum number of open HTTP connections, and returns the updated configuration instance.
`ClientConfiguration`	`withMaxConnectionsPerRoute(int maxConnections)` Sets the maximum number of per route, and returns the updated configuration instance.
`ClientConfiguration`	`withMaxRetryCount(int maxRetryCount)`
`ClientConfiguration`	`withProtocol(Protocol protocol)` Sets the protocol (HTTP/HTTPS) to use when connecting to YOP services, and returns the updated configuration instance.
`ClientConfiguration`	`withProxyDomain(String proxyDomain)` Sets the optional Windows domain to use when connecting through a Windows NTLM proxy, and returns the updated configuration instance.
`ClientConfiguration`	`withProxyHost(String proxyHost)` Sets the optional proxy host the client will connect through, and returns the updated configuration instance.
`ClientConfiguration`	`withProxyPassword(String proxyPassword)` Sets the optional password to use when connecting through a proxy, and returns the updated configuration instance.
`ClientConfiguration`	`withProxyPort(int proxyPort)` Sets the optional proxy port the client will connect through, and returns the updated configuration instance.
`ClientConfiguration`	`withProxyPreemptiveAuthenticationEnabled(boolean proxyPreemptiveAuthenticationEnabled)` Sets whether to enable proxy preemptive authentication, and returns the updated configuration instance.
`ClientConfiguration`	`withProxyScheme(String proxyScheme)` Sets the optional proxy scheme the client will connect through, and returns the updated configuration instance.
`ClientConfiguration`	`withProxyUsername(String proxyUsername)` Sets the optional user name to use when connecting through a proxy, and returns the updated configuration instance.
`ClientConfiguration`	`withProxyWorkstation(String proxyWorkstation)` Sets the optional Windows workstation to use when connecting through a Windows NTLM proxy, and returns the updated configuration instance.
`ClientConfiguration`	`withRegion(Region region)` Sets the region of service, and returns the updated configuration instance.
`ClientConfiguration`	`withRetryExceptions(Set<String> retryExceptions)`
`ClientConfiguration`	`withRetryPolicy(RetryPolicy retryPolicy)` Sets the retry policy for failed requests, and returns the updated configuration instance.
`ClientConfiguration`	`withSocketBufferSizeInBytes(int socketBufferSizeInBytes)` Sets the optional size (in bytes) for the low level TCP socket buffer, and returns the updated configuration instance.
`ClientConfiguration`	`withSocketTimeoutInMillis(int socketTimeoutInMillis)` Sets the socket timeout (SO_TIMEOUT) in milliseconds, which is a maximum period inactivity between two consecutive data packets, and returns the updated configuration instance.
`ClientConfiguration`	`withUserAgent(String userAgent)` Sets the User-Agent header value to use when sending requests to YOP services, and returns the updated configuration instance.

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

- 字段详细资料
  - DEFAULT_CONNECTION_TIMEOUT_IN_MILLIS
```
public static final int DEFAULT_CONNECTION_TIMEOUT_IN_MILLIS
```
    The default timeout for creating new connections.
    
    另请参阅:
    
    常量字段值
  - DEFAULT_CONNECTION_REQUEST_TIMEOUT_IN_MILLIS
```
public static final int DEFAULT_CONNECTION_REQUEST_TIMEOUT_IN_MILLIS
```
    The default timeout for request new connections form pool.
    
    另请参阅:
    
    常量字段值
  - DEFAULT_SOCKET_TIMEOUT_IN_MILLIS
```
public static final int DEFAULT_SOCKET_TIMEOUT_IN_MILLIS
```
    The default timeout for reading from a connected socket.
    
    另请参阅:
    
    常量字段值
  - DEFAULT_MAX_CONNECTIONS
```
public static final int DEFAULT_MAX_CONNECTIONS
```
    The default max connection pool size.
    
    另请参阅:
    
    常量字段值
  - DEFAULT_MAX_CONNECTIONS_PER_ROUTE
```
public static final int DEFAULT_MAX_CONNECTIONS_PER_ROUTE
```
    The default max connections per route
    
    另请参阅:
    
    常量字段值
  - DEFAULT_USER_AGENT
```
public static final String DEFAULT_USER_AGENT
```
    The default User-Agent header value when sending requests to the target service. Initialized in the static initializer.
  - DEFAULT_REGION
```
public static Region DEFAULT_REGION
```
    The default region.
  - DEFAULT_PROTOCOL
```
public static Protocol DEFAULT_PROTOCOL
```
    The default protocol.
- 构造器详细资料
  - ClientConfiguration
```
public ClientConfiguration()
```
    Constructs a new ClientConfiguration instance with default settings.
  - ClientConfiguration
```
public ClientConfiguration(ClientConfiguration other)
```
    Constructs a new ClientConfiguration instance with the same settings as the specified configuration.
    
    参数:
    
    other - the configuration to copy settings from.
- 方法详细资料
  - getProtocol
```
public Protocol getProtocol()
```
    Returns the protocol (HTTP/HTTPS) to use when connecting to YOP services.
    
    返回:
    
    the protocol (HTTP/HTTPS) to use when connecting to YOP services.
  - setProtocol
```
public void setProtocol(Protocol protocol)
```
    Sets the protocol (HTTP/HTTPS) to use when connecting to YOP services.
    
    参数:
    
    protocol - the protocol (HTTP/HTTPS) to use when connecting to YOP services.
  - withProtocol
```
public ClientConfiguration withProtocol(Protocol protocol)
```
    Sets the protocol (HTTP/HTTPS) to use when connecting to YOP services, and returns the updated configuration instance.
    
    参数:
    
    protocol - the protocol (HTTP/HTTPS) to use when connecting to YOP services.
    
    返回:
    
    the updated configuration instance.
  - getMaxConnections
```
public int getMaxConnections()
```
    Returns the maximum number of open HTTP connections.
    
    返回:
    
    the maximum number of open HTTP connections.
  - setMaxConnections
```
public void setMaxConnections(int maxConnections)
```
    Sets the maximum number of open HTTP connections.
    
    参数:
    
    maxConnections - the maximum number of open HTTP connections.
    
    抛出:
    
    IllegalArgumentException - if maxConnections is negative.
  - getMaxConnectionsPerRoute
```
public int getMaxConnectionsPerRoute()
```
  - setMaxConnectionsPerRoute
```
public void setMaxConnectionsPerRoute(int maxConnectionsPerRoute)
```
  - withMaxConnections
```
public ClientConfiguration withMaxConnections(int maxConnections)
```
    Sets the maximum number of open HTTP connections, and returns the updated configuration instance.
    
    参数:
    
    maxConnections - the maximum number of open HTTP connections.
    
    返回:
    
    the updated configuration instance.
    
    抛出:
    
    IllegalArgumentException - if maxConnections is negative.
  - withMaxConnectionsPerRoute
```
public ClientConfiguration withMaxConnectionsPerRoute(int maxConnections)
```
    Sets the maximum number of per route, and returns the updated configuration instance.
    
    参数:
    
    maxConnections - the maximum number of per route.
    
    返回:
    
    the updated configuration instance.
    
    抛出:
    
    IllegalArgumentException - if maxConnections is negative.
  - getUserAgent
```
public String getUserAgent()
```
    Returns the User-Agent header value to use when sending requests to YOP services.
    
    返回:
    
    the User-Agent header value to use when sending requests to YOP services.
  - setUserAgent
```
public void setUserAgent(String userAgent)
```
    Sets the User-Agent header value to use when sending requests to YOP services.
    If the specified value is null, DEFAULT_USER_AGENT is used. If the specified value does not end with DEFAULT_USER_AGENT, DEFAULT_USER_AGENT is appended.
    
    参数:
    
    userAgent - the User-Agent header value to use when sending requests to YOP services.
  - withUserAgent
```
public ClientConfiguration withUserAgent(String userAgent)
```
    Sets the User-Agent header value to use when sending requests to YOP services, and returns the updated configuration instance.
    If the specified value is null, DEFAULT_USER_AGENT is used. If the specified value does not end with DEFAULT_USER_AGENT, DEFAULT_USER_AGENT is appended.
    
    参数:
    
    userAgent - the User-Agent header value to use when sending requests to YOP services.
    
    返回:
    
    the updated configuration instance.
  - getLocalAddress
```
public InetAddress getLocalAddress()
```
    Returns the optional local address to bind when connecting to YOP services.
    
    返回:
    
    the optional local address to bind when connecting to YOP services.
  - setLocalAddress
```
public void setLocalAddress(InetAddress localAddress)
```
    Sets the optional local address to bind when connecting to YOP services.
    
    参数:
    
    localAddress - the optional local address to bind when connecting to YOP services.
  - withLocalAddress
```
public ClientConfiguration withLocalAddress(InetAddress localAddress)
```
    Sets the optional local address to bind when connecting to YOP services, and returns the updated configuration instance.
    
    参数:
    
    localAddress - the optional local address to bind when connecting to YOP services.
    
    返回:
    
    the updated configuration instance.
  - getProxyHost
```
public String getProxyHost()
```
    Returns the optional proxy host the client will connect through.
    
    返回:
    
    the optional proxy host the client will connect through.
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    Sets the optional proxy host the client will connect through.
    The client will connect through the proxy only if the host is not null and the port is positive.
    
    参数:
    
    proxyHost - the optional proxy host the client will connect through.
  - withProxyHost
```
public ClientConfiguration withProxyHost(String proxyHost)
```
    Sets the optional proxy host the client will connect through, and returns the updated configuration instance.
    The client will connect through the proxy only if the host is not null and the port is positive.
    
    参数:
    
    proxyHost - the optional proxy host the client will connect through.
    
    返回:
    
    the updated configuration instance.
  - getProxyPort
```
public int getProxyPort()
```
    Returns the optional proxy port the client will connect through.
    
    返回:
    
    the optional proxy port the client will connect through.
  - setProxyPort
```
public void setProxyPort(int proxyPort)
```
    Sets the optional proxy port the client will connect through.
    The client will connect through the proxy only if the host is not null and the port is positive.
    
    参数:
    
    proxyPort - the optional proxy port the client will connect through.
  - withProxyPort
```
public ClientConfiguration withProxyPort(int proxyPort)
```
    Sets the optional proxy port the client will connect through, and returns the updated configuration instance.
    The client will connect through the proxy only if the host is not null and the port is positive.
    
    参数:
    
    proxyPort - the optional proxy port the client will connect through.
    
    返回:
    
    the updated configuration instance.
  - getProxyScheme
```
public String getProxyScheme()
```
    Returns the optional proxy scheme the client will connect through.
    
    返回:
    
    the optional proxy scheme the client will connect through.
  - setProxyScheme
```
public void setProxyScheme(String proxyScheme)
```
    Sets the optional proxy scheme the client will connect through.
    The client will connect through the proxy only if the host is not null and the port is positive.
    
    参数:
    
    proxyScheme - the optional proxy scheme the client will connect through.
  - withProxyScheme
```
public ClientConfiguration withProxyScheme(String proxyScheme)
```
    Sets the optional proxy scheme the client will connect through, and returns the updated configuration instance.
    The client will connect through the proxy only if the host is not null and the port is positive.
    
    参数:
    
    proxyScheme - the optional proxy port the client will connect through.
    
    返回:
    
    the updated configuration instance.
  - getProxyUsername
```
public String getProxyUsername()
```
    Returns the optional user name to use when connecting through a proxy.
    
    返回:
    
    the optional user name to use when connecting through a proxy.
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
    Sets the optional user name to use when connecting through a proxy.
    
    参数:
    
    proxyUsername - the optional user name to use when connecting through a proxy.
  - withProxyUsername
```
public ClientConfiguration withProxyUsername(String proxyUsername)
```
    Sets the optional user name to use when connecting through a proxy, and returns the updated configuration instance.
    
    参数:
    
    proxyUsername - the optional user name to use when connecting through a proxy.
    
    返回:
    
    the updated configuration instance.
  - getProxyPassword
```
public String getProxyPassword()
```
    Returns the optional password to use when connecting through a proxy.
    
    返回:
    
    the optional password to use when connecting through a proxy.
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    Sets the optional password to use when connecting through a proxy.
    
    参数:
    
    proxyPassword - the optional password to use when connecting through a proxy.
  - withProxyPassword
```
public ClientConfiguration withProxyPassword(String proxyPassword)
```
    Sets the optional password to use when connecting through a proxy, and returns the updated configuration instance.
    
    参数:
    
    proxyPassword - the optional password to use when connecting through a proxy.
    
    返回:
    
    the updated configuration instance.
  - getProxyDomain
```
public String getProxyDomain()
```
    Returns the optional Windows domain to use when connecting through a Windows NTLM proxy.
    
    返回:
    
    the optional Windows domain to use when connecting through a Windows NTLM proxy.
  - setProxyDomain
```
public void setProxyDomain(String proxyDomain)
```
    Sets the optional Windows domain to use when connecting through a Windows NTLM proxy.
    
    参数:
    
    proxyDomain - the optional Windows domain to use when connecting through a Windows NTLM proxy.
  - withProxyDomain
```
public ClientConfiguration withProxyDomain(String proxyDomain)
```
    Sets the optional Windows domain to use when connecting through a Windows NTLM proxy, and returns the updated configuration instance.
    
    参数:
    
    proxyDomain - the optional Windows domain to use when connecting through a Windows NTLM proxy.
    
    返回:
    
    the updated configuration instance.
  - getProxyWorkstation
```
public String getProxyWorkstation()
```
    Returns the optional Windows workstation to use when connecting through a Windows NTLM proxy.
    
    返回:
    
    the optional Windows workstation to use when connecting through a Windows NTLM proxy.
  - setProxyWorkstation
```
public void setProxyWorkstation(String proxyWorkstation)
```
    Sets the optional Windows workstation to use when connecting through a Windows NTLM proxy.
    
    参数:
    
    proxyWorkstation - the optional Windows workstation to use when connecting through a Windows NTLM proxy.
  - withProxyWorkstation
```
public ClientConfiguration withProxyWorkstation(String proxyWorkstation)
```
    Sets the optional Windows workstation to use when connecting through a Windows NTLM proxy, and returns the updated configuration instance.
    
    参数:
    
    proxyWorkstation - the optional Windows workstation to use when connecting through a Windows NTLM proxy.
    
    返回:
    
    the updated configuration instance.
  - isProxyPreemptiveAuthenticationEnabled
```
public boolean isProxyPreemptiveAuthenticationEnabled()
```
    Returns whether to enable proxy preemptive authentication. If it is true, the client will send the basic authentication response even before the proxy server gives an unauthorized response in certain situations, thus reducing the overhead of making the connection.
    
    返回:
    
    whether to enable proxy preemptive authentication.
  - setProxyPreemptiveAuthenticationEnabled
```
public void setProxyPreemptiveAuthenticationEnabled(boolean proxyPreemptiveAuthenticationEnabled)
```
    Sets whether to enable proxy preemptive authentication. If it is true, the client will send the basic authentication response even before the proxy server gives an unauthorized response in certain situations, thus reducing the overhead of making the connection.
    
    参数:
    
    proxyPreemptiveAuthenticationEnabled - whether to enable proxy preemptive authentication.
  - withProxyPreemptiveAuthenticationEnabled
```
public ClientConfiguration withProxyPreemptiveAuthenticationEnabled(boolean proxyPreemptiveAuthenticationEnabled)
```
    Sets whether to enable proxy preemptive authentication, and returns the updated configuration instance. If it is true, the client will send the basic authentication response even before the proxy server gives an unauthorized response in certain situations, thus reducing the overhead of making the connection.
    
    参数:
    
    proxyPreemptiveAuthenticationEnabled - whether to enable proxy preemptive authentication.
    
    返回:
    
    the updated configuration instance.
  - getRetryPolicy
```
public RetryPolicy getRetryPolicy()
```
    Returns the retry policy for failed requests.
    
    返回:
    
    the retry policy for failed requests.
  - setRetryPolicy
```
public void setRetryPolicy(RetryPolicy retryPolicy)
```
    Sets the retry policy for failed requests.
    
    参数:
    
    retryPolicy - the retry policy for failed requests.
  - withRetryPolicy
```
public ClientConfiguration withRetryPolicy(RetryPolicy retryPolicy)
```
    Sets the retry policy for failed requests, and returns the updated configuration instance.
    
    参数:
    
    retryPolicy - the retry policy for failed requests.
    
    返回:
    
    the updated configuration instance.
  - getSocketTimeoutInMillis
```
public int getSocketTimeoutInMillis()
```
    Returns the socket timeout (SO_TIMEOUT) in milliseconds, which is a maximum period inactivity between two consecutive data packets.
    
    返回:
    
    the socket timeout (SO_TIMEOUT) in milliseconds.
  - setSocketTimeoutInMillis
```
public void setSocketTimeoutInMillis(int socketTimeoutInMillis)
```
    Sets the socket timeout (SO_TIMEOUT) in milliseconds, which is a maximum period inactivity between two consecutive data packets. A value of 0 means infinity, and is not recommended.
    
    参数:
    
    socketTimeoutInMillis - the socket timeout (SO_TIMEOUT) in milliseconds.
    
    抛出:
    
    IllegalArgumentException - if socketTimeoutInMillis is negative.
  - withSocketTimeoutInMillis
```
public ClientConfiguration withSocketTimeoutInMillis(int socketTimeoutInMillis)
```
    Sets the socket timeout (SO_TIMEOUT) in milliseconds, which is a maximum period inactivity between two consecutive data packets, and returns the updated configuration instance. A value of 0 means infinity, and is not recommended.
    
    参数:
    
    socketTimeoutInMillis - the socket timeout (SO_TIMEOUT) in milliseconds.
    
    返回:
    
    the updated configuration instance.
    
    抛出:
    
    IllegalArgumentException - if socketTimeoutInMillis is negative.
  - getConnectionTimeoutInMillis
```
public int getConnectionTimeoutInMillis()
```
    Returns the connection timeout in milliseconds.
    
    返回:
    
    the connection timeout in milliseconds.
  - setConnectionTimeoutInMillis
```
public void setConnectionTimeoutInMillis(int connectionTimeoutInMillis)
```
    Sets the connection timeout in milliseconds. A value of 0 means infinity, and is not recommended.
    
    参数:
    
    connectionTimeoutInMillis - the connection timeout in milliseconds.
    
    抛出:
    
    IllegalArgumentException - if connectionTimeoutInMillis is negative.
  - withConnectionTimeoutInMillis
```
public ClientConfiguration withConnectionTimeoutInMillis(int connectionTimeoutInMillis)
```
    Sets the connection timeout in milliseconds, and returns the updated configuration instance. A value of 0 means infinity, and is not recommended.
    
    参数:
    
    connectionTimeoutInMillis - the connection timeout in milliseconds.
    
    返回:
    
    the updated configuration instance.
    
    抛出:
    
    IllegalArgumentException - if connectionTimeoutInMillis is negative.
  - getConnectionRequestTimeoutInMillis
```
public int getConnectionRequestTimeoutInMillis()
```
    Returns the connection request timeout in milliseconds.
    
    返回:
    
    the connection request timeout in milliseconds.
  - setConnectionRequestTimeoutInMillis
```
public void setConnectionRequestTimeoutInMillis(int connectionRequestTimeoutInMillis)
```
    Sets the connection request timeout in milliseconds. A value of 0 means infinity, and is not recommended.
    
    参数:
    
    connectionRequestTimeoutInMillis - the connection request timeout in milliseconds.
    
    抛出:
    
    IllegalArgumentException - if connectionRequestTimeoutInMillis is negative.
  - withConnectionRequestTimeoutInMillis
```
public ClientConfiguration withConnectionRequestTimeoutInMillis(int connectionRequestTimeoutInMillis)
```
    Sets the connection request timeout in milliseconds, and returns the updated configuration instance. A value of 0 means infinity, and is not recommended.
    
    参数:
    
    connectionRequestTimeoutInMillis - the connection request timeout in milliseconds.
    
    返回:
    
    the updated configuration instance.
    
    抛出:
    
    IllegalArgumentException - if connectionRequestTimeoutInMillis is negative.
  - getSocketBufferSizeInBytes
```
public int getSocketBufferSizeInBytes()
```
    Returns the optional size (in bytes) for the low level TCP socket buffer. This is an advanced option for advanced users who want to tune low level TCP parameters to try and squeeze out more performance. Ignored if not positive.
    
    返回:
    
    the optional size (in bytes) for the low level TCP socket buffer.
  - setSocketBufferSizeInBytes
```
public void setSocketBufferSizeInBytes(int socketBufferSizeInBytes)
```
    Sets the optional size (in bytes) for the low level TCP socket buffer. This is an advanced option for advanced users who want to tune low level TCP parameters to try and squeeze out more performance. Ignored if not positive.
    
    参数:
    
    socketBufferSizeInBytes - the optional size (in bytes) for the low level TCP socket buffer.
  - withSocketBufferSizeInBytes
```
public ClientConfiguration withSocketBufferSizeInBytes(int socketBufferSizeInBytes)
```
    Sets the optional size (in bytes) for the low level TCP socket buffer, and returns the updated configuration instance. This is an advanced option for advanced users who want to tune low level TCP parameters to try and squeeze out more performance. Ignored if not positive.
    
    参数:
    
    socketBufferSizeInBytes - the optional size (in bytes) for the low level TCP socket buffer.
    
    返回:
    
    the updated configuration instance.
  - getRegion
```
public Region getRegion()
```
    Returns the region of service. This value is used by the client to construct the endpoint URL automatically, and is ignored if endpoint is not null.
    
    返回:
    
    the region of service.
  - setRegion
```
public void setRegion(Region region)
```
    Sets the region of service. This value is used by the client to construct the endpoint URL automatically, and is ignored if endpoint is not null.
    If the specified region is null, sets to DEFAULT_REGION.
    
    参数:
    
    region - the region of service.
  - withRegion
```
public ClientConfiguration withRegion(Region region)
```
    Sets the region of service, and returns the updated configuration instance. This value is used by the client to construct the endpoint URL automatically, and is ignored if endpoint is not null.
    If the specified region is null, sets to DEFAULT_REGION.
    
    参数:
    
    region - the region of service.
    
    返回:
    
    the updated configuration instance.
  - getCredentials
```
public YopCredentials<?> getCredentials()
```
    Returns the YOP credentials used by the client to sign HTTP requests.
    
    返回:
    
    the YOP credentials used by the client to sign HTTP requests.
  - setCredentials
```
public void setCredentials(YopCredentials<?> credentials)
```
    Sets the YOP credentials used by the client to sign HTTP requests.
    
    参数:
    
    credentials - the YOP credentials used by the client to sign HTTP requests.
    
    抛出:
    
    NullPointerException - if credentials is null.
  - withCredentials
```
public ClientConfiguration withCredentials(YopCredentials<?> credentials)
```
    Sets the YOP credentials used by the client to sign HTTP requests, and returns the updated configuration instance.
    
    参数:
    
    credentials - the YOP credentials used by the client to sign HTTP requests.
    
    返回:
    
    the updated configuration instance.
    
    抛出:
    
    NullPointerException - if credentials is null.
  - getClientImpl
```
public String getClientImpl()
```
    Returns the Http Client Impl
    
    返回:
    
    the the Http Client Impl.
  - setClientImpl
```
public void setClientImpl(String clientImpl)
```
    Sets the Http Client Impl
    
    参数:
    
    clientImpl - the Http Client Impl
    
    抛出:
    
    NullPointerException - if clientImpl is null.
  - withClientImpl
```
public ClientConfiguration withClientImpl(String clientImpl)
```
    Sets the Http Client Impl.
    
    参数:
    
    clientImpl - the Http Client Impl.
    
    返回:
    
    the updated configuration instance.
    
    抛出:
    
    NullPointerException - if clientImpl is null.
  - getMaxRetryCount
```
public int getMaxRetryCount()
```
  - setMaxRetryCount
```
public void setMaxRetryCount(int maxRetryCount)
```
  - withMaxRetryCount
```
public ClientConfiguration withMaxRetryCount(int maxRetryCount)
```
  - getRetryExceptions
```
public Set<String> getRetryExceptions()
```
  - setRetryExceptions
```
public void setRetryExceptions(Set<String> retryExceptions)
```
  - withRetryExceptions
```
public ClientConfiguration withRetryExceptions(Set<String> retryExceptions)
```
  - getCircuitBreakerConfig
```
public YopCircuitBreakerConfig getCircuitBreakerConfig()
```
  - setCircuitBreakerConfig
```
public void setCircuitBreakerConfig(YopCircuitBreakerConfig circuitBreakerConfig)
```
  - withCircuitBreakerConfig
```
public ClientConfiguration withCircuitBreakerConfig(YopCircuitBreakerConfig circuitBreakerConfig)
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 ClientConfiguration

字段概要

构造器概要

方法概要

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

字段详细资料

DEFAULT_CONNECTION_TIMEOUT_IN_MILLIS

DEFAULT_CONNECTION_REQUEST_TIMEOUT_IN_MILLIS

DEFAULT_SOCKET_TIMEOUT_IN_MILLIS

DEFAULT_MAX_CONNECTIONS

DEFAULT_MAX_CONNECTIONS_PER_ROUTE

DEFAULT_USER_AGENT

DEFAULT_REGION

DEFAULT_PROTOCOL

构造器详细资料

ClientConfiguration

ClientConfiguration

方法详细资料

getProtocol

setProtocol

withProtocol

getMaxConnections

setMaxConnections

getMaxConnectionsPerRoute

setMaxConnectionsPerRoute

withMaxConnections

withMaxConnectionsPerRoute

getUserAgent

setUserAgent

withUserAgent

getLocalAddress

setLocalAddress

withLocalAddress

getProxyHost

setProxyHost

withProxyHost

getProxyPort

setProxyPort

withProxyPort

getProxyScheme

setProxyScheme

withProxyScheme

getProxyUsername

setProxyUsername

withProxyUsername

getProxyPassword

setProxyPassword

withProxyPassword

getProxyDomain

setProxyDomain

withProxyDomain

getProxyWorkstation

setProxyWorkstation

withProxyWorkstation

isProxyPreemptiveAuthenticationEnabled

setProxyPreemptiveAuthenticationEnabled

withProxyPreemptiveAuthenticationEnabled

getRetryPolicy

setRetryPolicy

withRetryPolicy

getSocketTimeoutInMillis

setSocketTimeoutInMillis

withSocketTimeoutInMillis

getConnectionTimeoutInMillis

setConnectionTimeoutInMillis

withConnectionTimeoutInMillis

getConnectionRequestTimeoutInMillis

setConnectionRequestTimeoutInMillis

withConnectionRequestTimeoutInMillis

getSocketBufferSizeInBytes

setSocketBufferSizeInBytes

withSocketBufferSizeInBytes

getRegion

setRegion

withRegion

getCredentials

setCredentials

withCredentials

getClientImpl

setClientImpl