ClientConfig (cos-java-sdk 5.6.255 API)

java.lang.Object
- com.qcloud.cos.ClientConfig

public class ClientConfig
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static BackoffStrategy DEFAULT_BACKOFF_STRATEGY
The sleep time interval between exception occured and retry

Fields
Modifier and Type	Field and Description
`static BackoffStrategy`	`DEFAULT_BACKOFF_STRATEGY` The sleep time interval between exception occured and retry

Constructor Summary

Constructors
Constructor and Description

ClientConfig()

ClientConfig(Region region)

Constructors
Constructor and Description
`ClientConfig()`
`ClientConfig(Region region)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BackoffStrategy`	`getBackoffStrategy()`
`boolean`	`getCiSpecialRequest()`
`long`	`getConnectionMaxIdleMillis()`
`int`	`getConnectionRequestTimeout()`
`int`	`getConnectionTimeout()`
`COSSigner`	`getCosSigner()`
`EndpointBuilder`	`getEndpointBuilder()`
`EndpointResolver`	`getEndpointResolver()`
`String`	`getEndPointSuffix()` Deprecated.
`int`	`getErrorLogStatusCodeThresh()`
`HandlerAfterProcess`	`getHandlerAfterProcess()`
`HttpProtocol`	`getHttpProtocol()`
`String`	`getHttpProxyIp()`
`int`	`getHttpProxyPort()`
`int`	`getIdleConnectionAlive()`
`boolean`	`getIsDistinguishHost()`
`int`	`getMaxConnectionsCount()`
`int`	`getMaxErrorRetry()`
`int`	`getMaxErrorRetryForCopyRequest()`
`long`	`getPreflightStatusUpdateInterval()`
`String`	`getProxyPassword()`
`String`	`getProxyUsername()`
`int`	`getReadLimit()`
`Region`	`getRegion()`
`int`	`getRequestTimeout()`
`boolean`	`getRequestTimeOutEnable()`
`RetryPolicy`	`getRetryPolicy()`
`int`	`getShutdownTimeout()`
`long`	`getSignExpired()`
`int`	`getSocketTimeout()`
`int`	`getTimeoutClientThreadSize()`
`String`	`getUserAgent()`
`boolean`	`isAddLogDebugHeader()`
`boolean`	`isChangeEndpointRetry()`
`boolean`	`isCheckPreflightStatus()`
`boolean`	`isCheckRequestPath()`
`boolean`	`isCheckSSLCertificate()`
`boolean`	`isPrintShutdownStackTrace()`
`boolean`	`isRedirectsEnabled()`
`boolean`	`IsRefreshEndpointAddr()`
`boolean`	`isRenameFaultTolerant()`
`boolean`	`isRetryAfterPreflight()`
`boolean`	`isShortConnection()`
`boolean`	`isThrow304Directly()`
`boolean`	`isThrow412Directly()`
`boolean`	`isUseConnectionMonitor()`
`boolean`	`isUseDefaultDnsResolver()`
`void`	`setAddLogDebugHeader(boolean addLogDebugHeader)`
`void`	`setBackoffStrategy(BackoffStrategy backoffStrategy)`
`void`	`setChangeEndpointRetry(boolean changeEndpointRetry)`
`void`	`setCheckPreflightStatus(boolean checkPreflightStatus)`
`void`	`setCheckRequestPath(boolean isCheck)`
`void`	`setCheckSSLCertificate(boolean isCheckSSLCertificate)`
`void`	`setCiSpecialRequest(boolean ciSpecialRequest)`
`void`	`setConnectionMaxIdleMillis(long connectionMaxIdleMillis)`
`void`	`setConnectionRequestTimeout(int connectionRequestTimeout)`
`void`	`setConnectionTimeout(int connectionTimeout)`
`void`	`setCosSigner(COSSigner cosSigner)`
`void`	`setEndpointBuilder(EndpointBuilder endpointBuilder)`
`void`	`setEndpointResolver(EndpointResolver endpointResolver)`
`void`	`setEndPointSuffix(String endPointSuffix)`
`void`	`setErrorLogStatusCodeThresh(int statusCode)`
`void`	`setHandlerAfterProcess(HandlerAfterProcess handler)`
`void`	`setHttpProtocol(HttpProtocol httpProtocol)`
`void`	`setHttpProxyIp(String httpProxyIp)`
`void`	`setHttpProxyPort(int httpProxyPort)`
`void`	`setIdleConnectionAlive(int idleConnectionAlive)`
`void`	`setIsDistinguishHost(boolean isDistinguishHost)`
`void`	`setMaxConnectionsCount(int maxConnectionsCount)`
`void`	`setMaxErrorRetry(int maxErrorRetry)`
`void`	`setMaxErrorRetryForCopyRequest(int maxErrorRetry)`
`void`	`setPrintShutdownStackTrace(boolean printShutdownStackTrace)`
`void`	`setProxyPassword(String proxyPassword)`
`void`	`setProxyUsername(String proxyUsername)`
`void`	`setReadLimit(int readLimit)`
`void`	`setRedirectsEnabled(boolean redirectsEnabled)`
`void`	`setRegion(Region region)`
`void`	`setRenameFaultTolerant(boolean renameFaultTolerant)`
`void`	`setRequestTimeout(int requestTimeout)`
`void`	`setRequestTimeOutEnable(boolean requestTimeOutEnable)`
`void`	`setRetryAfterPreflight(boolean retryAfterPreflight)`
`void`	`setRetryPolicy(RetryPolicy retryPolicy)`
`void`	`setShortConnection()` 显示的设置使用短链接，在请求头中增加"Connection: close" HTTP 1.1默认使用长链接
`void`	`setShutdownTimeout(int shutdownTimeout)`
`void`	`setSignExpired(long signExpired)`
`void`	`setSocketTimeout(int socketTimeout)`
`void`	`setThrow304Directly(boolean throw304Directly)`
`void`	`setThrow412Directly(boolean throw412Directly)`
`void`	`setTimeoutClientThreadSize(int poolSize)`
`void`	`setUseBasicAuth(boolean useBasicAuth)`
`void`	`setUseConnectionMonitor(boolean isUseConnectionMonitor)`
`void`	`setUseDefaultDnsResolver(boolean useDefaultDnsResolver)`
`void`	`setUserAgent(String userAgent)`
`void`	`turnOnRefreshEndpointAddrSwitch()`
`boolean`	`useBasicAuth()`

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

Field Detail
- DEFAULT_BACKOFF_STRATEGY
```
public static final BackoffStrategy DEFAULT_BACKOFF_STRATEGY
```
  The sleep time interval between exception occured and retry

Constructor Detail

ClientConfig
```
public ClientConfig()
```

ClientConfig
```
public ClientConfig(Region region)
```

Method Detail

getIdleConnectionAlive
```
public int getIdleConnectionAlive()
```

setIdleConnectionAlive

public void setIdleConnectionAlive(int idleConnectionAlive)

getRegion
```
public Region getRegion()
```

setRegion
```
public void setRegion(Region region)
```

getHttpProtocol
```
public HttpProtocol getHttpProtocol()
```

setHttpProtocol

public void setHttpProtocol(HttpProtocol httpProtocol)

getHttpProxyIp
```
public String getHttpProxyIp()
```

setHttpProxyIp

public void setHttpProxyIp(String httpProxyIp)

getHttpProxyPort
```
public int getHttpProxyPort()
```

setHttpProxyPort

public void setHttpProxyPort(int httpProxyPort)

getSignExpired
```
public long getSignExpired()
```

setSignExpired

public void setSignExpired(long signExpired)

getConnectionRequestTimeout

public int getConnectionRequestTimeout()

setConnectionRequestTimeout

public void setConnectionRequestTimeout(int connectionRequestTimeout)

getConnectionTimeout
```
public int getConnectionTimeout()
```

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

getSocketTimeout
```
public int getSocketTimeout()
```

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

getMaxConnectionsCount
```
public int getMaxConnectionsCount()
```

setMaxConnectionsCount

public void setMaxConnectionsCount(int maxConnectionsCount)

setUserAgent

public void setUserAgent(String userAgent)

getUserAgent
```
public String getUserAgent()
```

getEndPointSuffix

@Deprecated
public String getEndPointSuffix()

Deprecated.

setEndPointSuffix

public void setEndPointSuffix(String endPointSuffix)

getReadLimit
```
public int getReadLimit()
```

setReadLimit

public void setReadLimit(int readLimit)

getEndpointBuilder

public EndpointBuilder getEndpointBuilder()

setEndpointBuilder

public void setEndpointBuilder(EndpointBuilder endpointBuilder)

getEndpointResolver

public EndpointResolver getEndpointResolver()

setEndpointResolver

public void setEndpointResolver(EndpointResolver endpointResolver)

getProxyUsername
```
public String getProxyUsername()
```

setProxyUsername

public void setProxyUsername(String proxyUsername)

getProxyPassword
```
public String getProxyPassword()
```

setProxyPassword

public void setProxyPassword(String proxyPassword)

setUseBasicAuth

public void setUseBasicAuth(boolean useBasicAuth)

useBasicAuth
```
public boolean useBasicAuth()
```

getMaxErrorRetry
```
public int getMaxErrorRetry()
```

setMaxErrorRetry

public void setMaxErrorRetry(int maxErrorRetry)

getMaxErrorRetryForCopyRequest

public int getMaxErrorRetryForCopyRequest()

setMaxErrorRetryForCopyRequest

public void setMaxErrorRetryForCopyRequest(int maxErrorRetry)

getRetryPolicy
```
public RetryPolicy getRetryPolicy()
```

setRetryPolicy

public void setRetryPolicy(RetryPolicy retryPolicy)

getBackoffStrategy

public BackoffStrategy getBackoffStrategy()

setBackoffStrategy

public void setBackoffStrategy(BackoffStrategy backoffStrategy)

getCosSigner
```
public COSSigner getCosSigner()
```

setCosSigner

public void setCosSigner(COSSigner cosSigner)

getCiSpecialRequest
```
public boolean getCiSpecialRequest()
```

setCiSpecialRequest

public void setCiSpecialRequest(boolean ciSpecialRequest)

setIsDistinguishHost

public void setIsDistinguishHost(boolean isDistinguishHost)

getIsDistinguishHost
```
public boolean getIsDistinguishHost()
```

setShortConnection
```
public void setShortConnection()
```
显示的设置使用短链接，在请求头中增加"Connection: close" HTTP 1.1默认使用长链接

isShortConnection
```
public boolean isShortConnection()
```

getRequestTimeout
```
public int getRequestTimeout()
```

setRequestTimeout

public void setRequestTimeout(int requestTimeout)

setRequestTimeOutEnable

public void setRequestTimeOutEnable(boolean requestTimeOutEnable)

getRequestTimeOutEnable

public boolean getRequestTimeOutEnable()

setShutdownTimeout

public void setShutdownTimeout(int shutdownTimeout)

getShutdownTimeout
```
public int getShutdownTimeout()
```

isChangeEndpointRetry

public boolean isChangeEndpointRetry()

setChangeEndpointRetry

public void setChangeEndpointRetry(boolean changeEndpointRetry)

isPrintShutdownStackTrace

public boolean isPrintShutdownStackTrace()

setPrintShutdownStackTrace

public void setPrintShutdownStackTrace(boolean printShutdownStackTrace)

setCheckRequestPath

public void setCheckRequestPath(boolean isCheck)

isCheckRequestPath
```
public boolean isCheckRequestPath()
```

getTimeoutClientThreadSize

public int getTimeoutClientThreadSize()

setTimeoutClientThreadSize

public void setTimeoutClientThreadSize(int poolSize)

setErrorLogStatusCodeThresh

public void setErrorLogStatusCodeThresh(int statusCode)

getErrorLogStatusCodeThresh

public int getErrorLogStatusCodeThresh()

setCheckSSLCertificate

public void setCheckSSLCertificate(boolean isCheckSSLCertificate)

isCheckSSLCertificate

public boolean isCheckSSLCertificate()

setUseDefaultDnsResolver

public void setUseDefaultDnsResolver(boolean useDefaultDnsResolver)

isUseDefaultDnsResolver

public boolean isUseDefaultDnsResolver()

setHandlerAfterProcess

public void setHandlerAfterProcess(HandlerAfterProcess handler)

getHandlerAfterProcess

public HandlerAfterProcess getHandlerAfterProcess()

turnOnRefreshEndpointAddrSwitch

public void turnOnRefreshEndpointAddrSwitch()

IsRefreshEndpointAddr

public boolean IsRefreshEndpointAddr()

isCheckPreflightStatus

public boolean isCheckPreflightStatus()

setCheckPreflightStatus

public void setCheckPreflightStatus(boolean checkPreflightStatus)

getPreflightStatusUpdateInterval

public long getPreflightStatusUpdateInterval()

isRedirectsEnabled
```
public boolean isRedirectsEnabled()
```

setRedirectsEnabled

public void setRedirectsEnabled(boolean redirectsEnabled)

isUseConnectionMonitor

public boolean isUseConnectionMonitor()

setUseConnectionMonitor

public void setUseConnectionMonitor(boolean isUseConnectionMonitor)

getConnectionMaxIdleMillis

public long getConnectionMaxIdleMillis()

setConnectionMaxIdleMillis

public void setConnectionMaxIdleMillis(long connectionMaxIdleMillis)

isRetryAfterPreflight

public boolean isRetryAfterPreflight()

setRetryAfterPreflight

public void setRetryAfterPreflight(boolean retryAfterPreflight)

isAddLogDebugHeader
```
public boolean isAddLogDebugHeader()
```

setAddLogDebugHeader

public void setAddLogDebugHeader(boolean addLogDebugHeader)

isThrow412Directly
```
public boolean isThrow412Directly()
```

setThrow412Directly

public void setThrow412Directly(boolean throw412Directly)

isThrow304Directly
```
public boolean isThrow304Directly()
```

setThrow304Directly

public void setThrow304Directly(boolean throw304Directly)

isRenameFaultTolerant

public boolean isRenameFaultTolerant()

setRenameFaultTolerant

public void setRenameFaultTolerant(boolean renameFaultTolerant)

Class ClientConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BACKOFF_STRATEGY

Constructor Detail

ClientConfig

ClientConfig

Method Detail

getIdleConnectionAlive

setIdleConnectionAlive

getRegion

setRegion

getHttpProtocol

setHttpProtocol

getHttpProxyIp

setHttpProxyIp

getHttpProxyPort

setHttpProxyPort

getSignExpired

setSignExpired

getConnectionRequestTimeout

setConnectionRequestTimeout

getConnectionTimeout

setConnectionTimeout

getSocketTimeout

setSocketTimeout

getMaxConnectionsCount

setMaxConnectionsCount

setUserAgent

getUserAgent

getEndPointSuffix

setEndPointSuffix

getReadLimit

setReadLimit

getEndpointBuilder

setEndpointBuilder

getEndpointResolver

setEndpointResolver

getProxyUsername

setProxyUsername

getProxyPassword

setProxyPassword

setUseBasicAuth

useBasicAuth

getMaxErrorRetry

setMaxErrorRetry

getMaxErrorRetryForCopyRequest

setMaxErrorRetryForCopyRequest

getRetryPolicy

setRetryPolicy

getBackoffStrategy

setBackoffStrategy

getCosSigner

setCosSigner

getCiSpecialRequest

setCiSpecialRequest

setIsDistinguishHost

getIsDistinguishHost

setShortConnection

isShortConnection

getRequestTimeout

setRequestTimeout

setRequestTimeOutEnable

getRequestTimeOutEnable

setShutdownTimeout

getShutdownTimeout

isChangeEndpointRetry

setChangeEndpointRetry

isPrintShutdownStackTrace

setPrintShutdownStackTrace

setCheckRequestPath

isCheckRequestPath

getTimeoutClientThreadSize

setTimeoutClientThreadSize

setErrorLogStatusCodeThresh

getErrorLogStatusCodeThresh

setCheckSSLCertificate