CosXmlServiceConfig.Builder

java.lang.Object
- com.tencent.cos.xml.CosXmlServiceConfig.Builder

封闭类:

CosXmlServiceConfig
```
public static final class CosXmlServiceConfig.Builder
extends java.lang.Object
```
SDK服务配置构造器
用于构造CosXmlServiceConfig

构造器概要

构造器
构造器和说明

Builder()

Builder(CosXmlServiceConfig config)

构造器
构造器和说明
`Builder()`
`Builder(CosXmlServiceConfig config)`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`CosXmlServiceConfig.Builder`	`addHeader(java.lang.String key, java.lang.String value)` 给所有的请求统一添加 Header
`CosXmlServiceConfig.Builder`	`addNoSignHeaders(java.lang.String key)`
`CosXmlServiceConfig`	`builder()`
`CosXmlServiceConfig.Builder`	`dnsCache(boolean dnsCache)` 是否开启 DNS 解析缓存，开启后，将 DNS 解析的结果缓存在本地，当系统 DNS 解析失败后，会使用本地缓存的 DNS 结果
`CosXmlServiceConfig.Builder`	`enableQuic(boolean isEnable)` 是否使能 Quic 协议，使能后，还需要额外引入 quic sdk 才能正常使用
`CosXmlServiceConfig.Builder`	`isHttps(boolean isHttps)` 设置是否 Https 协议，默认为 Https
`CosXmlServiceConfig.Builder`	`setAccelerate(boolean accelerate)` 是否使用全球加速域名
`CosXmlServiceConfig.Builder`	`setAppidAndRegion(java.lang.String appid, java.lang.String region)` 已过时。
`CosXmlServiceConfig.Builder`	`setBucketInPath(boolean bucketInPath)` 已过时。
`CosXmlServiceConfig.Builder`	`setConnectionTimeout(int connectionTimeoutMills)` 设置连接超时时间
`CosXmlServiceConfig.Builder`	`setDebuggable(boolean isDebuggable)` 是否打印 Debug 日志
`CosXmlServiceConfig.Builder`	`setDownloadMaxThreadCount(int downloadMaxThreadCount)` 设置下载时线程并发的最大值
`CosXmlServiceConfig.Builder`	`setEndpointSuffix(java.lang.String endpointSuffix)` 已过时。
`CosXmlServiceConfig.Builder`	`setExecutor(java.util.concurrent.Executor excutor)` 自定义线程池
`CosXmlServiceConfig.Builder`	`setHost(java.lang.String host)` 设置除了 GetService 请求外的 host
`CosXmlServiceConfig.Builder`	`setHost(android.net.Uri uri)` 设置除了 GetService 请求外的 Uri，用于解析 host、port 和 protocol
`CosXmlServiceConfig.Builder`	`setHostFormat(java.lang.String hostFormat)` 设置 Host 的格式化字符串，sdk 会将 ${bucket} 替换为真正的 bucket，${region} 替换为真正的 region，比如将 hostFormat 设置为 ${bucket}.
`CosXmlServiceConfig.Builder`	`setObserveExecutor(java.util.concurrent.Executor observeExecutor)`
`CosXmlServiceConfig.Builder`	`setPathStyle(boolean pathStyle)` 设置 Bucket 参数在请求 Url 的 path 中，而是不 host 中，比如 cos.ap-shanghai.myqcloud.com/1250000000-bucket/readMe.txt
`CosXmlServiceConfig.Builder`	`setPort(int port)`
`CosXmlServiceConfig.Builder`	`setRegion(java.lang.String region)` 设置默认地域
`CosXmlServiceConfig.Builder`	`setRetryHandler(QCloudHttpRetryHandler qCloudHttpRetryHandler)` 自定义重试策略
`CosXmlServiceConfig.Builder`	`setRetryStrategy(RetryStrategy retryStrategy)` 自定义重试策略
`CosXmlServiceConfig.Builder`	`setSignInUrl(boolean signInUrl)` 是否将签名放在 URL 中，默认放在 Header 中
`CosXmlServiceConfig.Builder`	`setSocketTimeout(int socketTimeoutMills)` 设置 Socket 超时时间
`CosXmlServiceConfig.Builder`	`setTransferThreadControl(boolean transferThreadControl)` 设置传输时是否进行线程并发控制
`CosXmlServiceConfig.Builder`	`setUploadMaxThreadCount(int uploadMaxThreadCount)` 设置上传时线程并发的最大值
`CosXmlServiceConfig.Builder`	`setUserAgentExtended(java.lang.String userAgentExtended)` 设置ua拓展参数

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

- 构造器详细资料
  - Builder
```
public Builder()
```
  - Builder
```
public Builder(CosXmlServiceConfig config)
```
- 方法详细资料
  - setConnectionTimeout
```
public CosXmlServiceConfig.Builder setConnectionTimeout(int connectionTimeoutMills)
```
    设置连接超时时间
    
    参数:
    
    connectionTimeoutMills - 超时时间
    
    返回:
    
    Builder 对象
  - setSocketTimeout
```
public CosXmlServiceConfig.Builder setSocketTimeout(int socketTimeoutMills)
```
    设置 Socket 超时时间
    
    参数:
    
    socketTimeoutMills - 超时时间
    
    返回:
    
    Builder 对象
  - setTransferThreadControl
```
public CosXmlServiceConfig.Builder setTransferThreadControl(boolean transferThreadControl)
```
    设置传输时是否进行线程并发控制
    
    参数:
    
    transferThreadControl - 是否进行线程并发控制
  - setUploadMaxThreadCount
```
public CosXmlServiceConfig.Builder setUploadMaxThreadCount(int uploadMaxThreadCount)
```
    设置上传时线程并发的最大值
    
    参数:
    
    uploadMaxThreadCount - 线程并发的最大值
  - setDownloadMaxThreadCount
```
public CosXmlServiceConfig.Builder setDownloadMaxThreadCount(int downloadMaxThreadCount)
```
    设置下载时线程并发的最大值
    
    参数:
    
    downloadMaxThreadCount - 线程并发的最大值
  - isHttps
```
public CosXmlServiceConfig.Builder isHttps(boolean isHttps)
```
    设置是否 Https 协议，默认为 Https
    
    参数:
    
    isHttps - 是否 Https
    
    返回:
    
    Builder 对象
  - setHostFormat
```
public CosXmlServiceConfig.Builder setHostFormat(java.lang.String hostFormat)
```
    设置 Host 的格式化字符串，sdk 会将 ${bucket} 替换为真正的 bucket，${region} 替换为真正的 region，比如将 hostFormat 设置为 ${bucket}.${region}.tencent.com，并且您的存储桶和地域分别为 bucket-1250000000 和 ap-shanghai，那么最终的请求地址为 bucket-1250000000.ap-shanghai.tencent.com 注意，这个设置不会影响 GetService 请求，GetService 请求 Host 通过 CosXmlBaseService.setDomain(String) 设置
    
    参数:
    
    hostFormat - host 格式化字符串
    
    返回:
    
    Builder 对象
  - setAppidAndRegion
```
@Deprecated
public CosXmlServiceConfig.Builder setAppidAndRegion(java.lang.String appid,
                                                                 java.lang.String region)
```
    已过时。
    
    设置用户的 appid 和存储桶的地域。
    COS 服务的存储桶名称的格式为 bucketName-appid ，如果您调用了这个方法设置了 appid，那么后续在使用存储桶名称时，只需要填写 bucketName 即可，当 SDK 检测到没有以 -appid 结尾时，会进行自动拼接。
    该方法已不推荐使用。建议使用 setRegion(String) 来设置存储桶的地域，后续的存储桶名称需要严格按照 bucketName-appid 的格式，否则会报存储桶不存在的错误，这种方式下SDK 不会对您填写的存储桶名称做任何处理。
    
    参数:
    
    appid - appid
    
    region - 存储桶地域
    
    返回:
    
    Builder 对象
  - setRegion
```
public CosXmlServiceConfig.Builder setRegion(java.lang.String region)
```
    设置默认地域
    
    参数:
    
    region - 默认地域
    
    返回:
    
    Builder 对象
  - setEndpointSuffix
```
@Deprecated
public CosXmlServiceConfig.Builder setEndpointSuffix(java.lang.String endpointSuffix)
```
    已过时。
    
    已废弃，请换用 setHostFormat(String) 方法
    
    参数:
    
    endpointSuffix - Host 的 suffix
    
    返回:
    
    Builder 对象
  - setHost
```
public CosXmlServiceConfig.Builder setHost(java.lang.String host)
```
    设置除了 GetService 请求外的 host
    
    参数:
    
    host - sdk 请求的 host，优先级比 hostFormat 更高
    
    返回:
    
    Builder 对象
  - setHost
```
public CosXmlServiceConfig.Builder setHost(android.net.Uri uri)
```
    设置除了 GetService 请求外的 Uri，用于解析 host、port 和 protocol
    
    参数:
    
    uri - sdk 请求的地址，优先级比 hostFormat 更高
    
    返回:
    
    Builder 对象
  - setPort
```
public CosXmlServiceConfig.Builder setPort(int port)
```
  - setDebuggable
```
public CosXmlServiceConfig.Builder setDebuggable(boolean isDebuggable)
```
    是否打印 Debug 日志
    
    参数:
    
    isDebuggable - 是否打印 Debug 日志
    
    返回:
    
    Builder 对象
  - setSignInUrl
```
public CosXmlServiceConfig.Builder setSignInUrl(boolean signInUrl)
```
    是否将签名放在 URL 中，默认放在 Header 中
    
    参数:
    
    signInUrl -
    
    返回:
    
    Builder 对象
  - setRetryStrategy
```
public CosXmlServiceConfig.Builder setRetryStrategy(RetryStrategy retryStrategy)
```
    自定义重试策略
    
    参数:
    
    retryStrategy - 重试策略
    
    返回:
    
    Builder 对象
  - setRetryHandler
```
public CosXmlServiceConfig.Builder setRetryHandler(QCloudHttpRetryHandler qCloudHttpRetryHandler)
```
    自定义重试策略
    
    参数:
    
    qCloudHttpRetryHandler - 重试策略
    
    返回:
    
    Builder 对象
  - setBucketInPath
```
@Deprecated
public CosXmlServiceConfig.Builder setBucketInPath(boolean bucketInPath)
```
    已过时。
    
    已废弃，请使用 setPathStyle(boolean) 方法
    
    参数:
    
    bucketInPath -
    
    返回:
    
    Builder 对象
  - setPathStyle
```
public CosXmlServiceConfig.Builder setPathStyle(boolean pathStyle)
```
    设置 Bucket 参数在请求 Url 的 path 中，而是不 host 中，比如 cos.ap-shanghai.myqcloud.com/1250000000-bucket/readMe.txt
    
    参数:
    
    pathStyle - 参数是否在path中
    
    返回:
    
    Builder 对象
  - setExecutor
```
public CosXmlServiceConfig.Builder setExecutor(java.util.concurrent.Executor excutor)
```
    自定义线程池
    
    参数:
    
    excutor - 线程池
    
    返回:
    
    Builder 对象
  - setObserveExecutor
```
public CosXmlServiceConfig.Builder setObserveExecutor(java.util.concurrent.Executor observeExecutor)
```
  - enableQuic
```
public CosXmlServiceConfig.Builder enableQuic(boolean isEnable)
```
    是否使能 Quic 协议，使能后，还需要额外引入 quic sdk 才能正常使用
    
    参数:
    
    isEnable - 是否使能
    
    返回:
    
    Builder 对象
  - setUserAgentExtended
```
public CosXmlServiceConfig.Builder setUserAgentExtended(java.lang.String userAgentExtended)
```
    设置ua拓展参数
    
    参数:
    
    userAgentExtended - ua拓展参数()会拼接在ua后面
  - dnsCache
```
public CosXmlServiceConfig.Builder dnsCache(boolean dnsCache)
```
    是否开启 DNS 解析缓存，开启后，将 DNS 解析的结果缓存在本地，当系统 DNS 解析失败后，会使用本地缓存的 DNS 结果
    
    参数:
    
    dnsCache - 是否使能
    
    返回:
    
    Builder 对象
  - setAccelerate
```
public CosXmlServiceConfig.Builder setAccelerate(boolean accelerate)
```
    是否使用全球加速域名
    
    参数:
    
    accelerate - 是否加速
    
    返回:
    
    Builder 对象
  - builder
```
public CosXmlServiceConfig builder()
```
  - addHeader
```
public CosXmlServiceConfig.Builder addHeader(java.lang.String key,
                                             java.lang.String value)
```
    给所有的请求统一添加 Header
    
    参数:
    
    key - http header key
    
    value - http header value
  - addNoSignHeaders
```
public CosXmlServiceConfig.Builder addNoSignHeaders(java.lang.String key)
```

类 CosXmlServiceConfig.Builder

构造器概要

方法概要

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

构造器详细资料

Builder

Builder

方法详细资料

setConnectionTimeout

setSocketTimeout

setTransferThreadControl

setUploadMaxThreadCount

setDownloadMaxThreadCount

isHttps

setHostFormat

setAppidAndRegion

setRegion

setEndpointSuffix

setHost

setHost

setPort

setDebuggable

setSignInUrl

setRetryStrategy

setRetryHandler

setBucketInPath

setPathStyle

setExecutor

setObserveExecutor

enableQuic

setUserAgentExtended

dnsCache

setAccelerate

builder

addHeader

addNoSignHeaders