|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.baidubce.BceClientConfiguration
com.baidubce.services.sms.SmsClientConfiguration
public class SmsClientConfiguration
All client configurations for SMS clients.
Default configurations inherit super class BceClientConfiguration
.
Field Summary |
---|
Fields inherited from class com.baidubce.BceClientConfiguration |
---|
DEFAULT_CONNECTION_TIMEOUT_IN_MILLIS, DEFAULT_MAX_CONNECTIONS, DEFAULT_PROTOCOL, DEFAULT_REGION, DEFAULT_SOCKET_TIMEOUT_IN_MILLIS, DEFAULT_USER_AGENT |
Constructor Summary | |
---|---|
SmsClientConfiguration()
|
Method Summary | |
---|---|
SmsClientConfiguration |
withConnectionTimeoutInMillis(int connectionTimeoutInMillis)
Sets the connection timeout in milliseconds, and returns the updated configuration instance. |
SmsClientConfiguration |
withCredentials(BceCredentials credentials)
Sets the BCE credentials used by the client to sign HTTP requests, and returns the updated configuration instance. |
SmsClientConfiguration |
withEndpoint(String endpoint)
Sets the service endpoint URL to which the client will connect, and returns the updated configuration instance. |
SmsClientConfiguration |
withLocalAddress(InetAddress localAddress)
Sets the optional local address to bind when connecting to BCE services, and returns the updated configuration instance. |
SmsClientConfiguration |
withMaxConnections(int maxConnections)
Sets the maximum number of open HTTP connections, and returns the updated configuration instance. |
SmsClientConfiguration |
withProtocol(Protocol protocol)
Sets the protocol (HTTP/HTTPS) to use when connecting to BCE services, and returns the updated configuration instance. |
SmsClientConfiguration |
withProxyDomain(String proxyDomain)
Sets the optional Windows domain to use when connecting through a Windows NTLM proxy, and returns the updated configuration instance. |
SmsClientConfiguration |
withProxyHost(String proxyHost)
Sets the optional proxy host the client will connect through, and returns the updated configuration instance. |
SmsClientConfiguration |
withProxyPassword(String proxyPassword)
Sets the optional password to use when connecting through a proxy, and returns the updated configuration instance. |
SmsClientConfiguration |
withProxyPort(int proxyPort)
Sets the optional proxy port the client will connect through, and returns the updated configuration instance. |
SmsClientConfiguration |
withProxyPreemptiveAuthenticationEnabled(boolean proxyPreemptiveAuthenticationEnabled)
Sets whether to enable proxy preemptive authentication, and returns the updated configuration instance. |
SmsClientConfiguration |
withProxyUsername(String proxyUsername)
Sets the optional user name to use when connecting through a proxy, and returns the updated configuration instance. |
SmsClientConfiguration |
withProxyWorkstation(String proxyWorkstation)
Sets the optional Windows workstation to use when connecting through a Windows NTLM proxy, and returns the updated configuration instance. |
SmsClientConfiguration |
withRegion(Region region)
Sets the region of service, and returns the updated configuration instance. |
SmsClientConfiguration |
withRetryPolicy(RetryPolicy retryPolicy)
Sets the retry policy for failed requests, and returns the updated configuration instance. |
SmsClientConfiguration |
withSocketBufferSizeInBytes(int socketBufferSizeInBytes)
Sets the optional size (in bytes) for the low level TCP socket buffer, and returns the updated configuration instance. |
SmsClientConfiguration |
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. |
SmsClientConfiguration |
withUserAgent(String userAgent)
Sets the User-Agent header value to use when sending requests to BCE services, and returns the updated configuration instance. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SmsClientConfiguration()
Method Detail |
---|
public SmsClientConfiguration withCredentials(BceCredentials credentials)
BceClientConfiguration
withCredentials
in class BceClientConfiguration
credentials
- the BCE credentials used by the client to sign HTTP requests.
public SmsClientConfiguration withEndpoint(String endpoint)
BceClientConfiguration
withEndpoint
in class BceClientConfiguration
endpoint
- the service endpoint URL to which the client will connect.
public SmsClientConfiguration withProtocol(Protocol protocol)
BceClientConfiguration
withProtocol
in class BceClientConfiguration
protocol
- the protocol (HTTP/HTTPS) to use when connecting to BCE services.
public SmsClientConfiguration withMaxConnections(int maxConnections)
BceClientConfiguration
withMaxConnections
in class BceClientConfiguration
maxConnections
- the maximum number of open HTTP connections.
public SmsClientConfiguration withUserAgent(String userAgent)
BceClientConfiguration
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.
withUserAgent
in class BceClientConfiguration
userAgent
- the User-Agent header value to use when sending requests to BCE services.
public SmsClientConfiguration withLocalAddress(InetAddress localAddress)
BceClientConfiguration
withLocalAddress
in class BceClientConfiguration
localAddress
- the optional local address to bind when connecting to BCE services.
public SmsClientConfiguration withProxyHost(String proxyHost)
BceClientConfiguration
The client will connect through the proxy only if the host is not null and the port is positive.
withProxyHost
in class BceClientConfiguration
proxyHost
- the optional proxy host the client will connect through.
public SmsClientConfiguration withProxyPort(int proxyPort)
BceClientConfiguration
The client will connect through the proxy only if the host is not null and the port is positive.
withProxyPort
in class BceClientConfiguration
proxyPort
- the optional proxy port the client will connect through.
public SmsClientConfiguration withProxyUsername(String proxyUsername)
BceClientConfiguration
withProxyUsername
in class BceClientConfiguration
proxyUsername
- the optional user name to use when connecting through a proxy.
public SmsClientConfiguration withProxyPassword(String proxyPassword)
BceClientConfiguration
withProxyPassword
in class BceClientConfiguration
proxyPassword
- the optional password to use when connecting through a proxy.
public SmsClientConfiguration withProxyDomain(String proxyDomain)
BceClientConfiguration
withProxyDomain
in class BceClientConfiguration
proxyDomain
- the optional Windows domain to use when connecting through a Windows NTLM proxy.
public SmsClientConfiguration withProxyWorkstation(String proxyWorkstation)
BceClientConfiguration
withProxyWorkstation
in class BceClientConfiguration
proxyWorkstation
- the optional Windows workstation to use when connecting through a Windows NTLM proxy.
public SmsClientConfiguration withProxyPreemptiveAuthenticationEnabled(boolean proxyPreemptiveAuthenticationEnabled)
BceClientConfiguration
withProxyPreemptiveAuthenticationEnabled
in class BceClientConfiguration
proxyPreemptiveAuthenticationEnabled
- whether to enable proxy preemptive authentication.
public SmsClientConfiguration withRetryPolicy(RetryPolicy retryPolicy)
BceClientConfiguration
withRetryPolicy
in class BceClientConfiguration
retryPolicy
- the retry policy for failed requests.
public SmsClientConfiguration withSocketTimeoutInMillis(int socketTimeoutInMillis)
BceClientConfiguration
withSocketTimeoutInMillis
in class BceClientConfiguration
socketTimeoutInMillis
- the socket timeout (SO_TIMEOUT) in milliseconds.
public SmsClientConfiguration withConnectionTimeoutInMillis(int connectionTimeoutInMillis)
BceClientConfiguration
withConnectionTimeoutInMillis
in class BceClientConfiguration
connectionTimeoutInMillis
- the connection timeout in milliseconds.
public SmsClientConfiguration withSocketBufferSizeInBytes(int socketBufferSizeInBytes)
BceClientConfiguration
withSocketBufferSizeInBytes
in class BceClientConfiguration
socketBufferSizeInBytes
- the optional size (in bytes) for the low level TCP socket buffer.
public SmsClientConfiguration withRegion(Region region)
BceClientConfiguration
If the specified region is null, sets to DEFAULT_REGION.
withRegion
in class BceClientConfiguration
region
- the region of service.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |