类 CosXmlServiceConfig.Builder
- java.lang.Object
-
- com.tencent.cos.xml.CosXmlServiceConfig.Builder
-
- 封闭类:
- CosXmlServiceConfig
public static final class CosXmlServiceConfig.Builder extends java.lang.ObjectSDK服务配置构造器
用于构造CosXmlServiceConfig
-
-
构造器概要
构造器 构造器 说明 Builder()Builder(CosXmlServiceConfig config)
-
方法概要
所有方法 实例方法 具体方法 已过时的方法 修饰符和类型 方法 说明 CosXmlServiceConfig.BuilderaddHeader(java.lang.String key, java.lang.String value)给所有的请求统一添加 HeaderCosXmlServiceConfig.BuilderaddNoSignHeaders(java.lang.String key)CosXmlServiceConfigbuilder()CosXmlServiceConfig.BuilderdnsCache(boolean dnsCache)是否开启 DNS 解析缓存,开启后,将 DNS 解析的结果缓存在本地, 当系统 DNS 解析失败后,会使用本地缓存的 DNS 结果CosXmlServiceConfig.BuilderenableQuic(boolean isEnable)是否使能 Quic 协议,使能后,还需要额外引入 quic sdk 才能正常使用CosXmlServiceConfig.BuilderisHttps(boolean isHttps)设置是否 Https 协议,默认为 HttpsCosXmlServiceConfig.BuildersetAccelerate(boolean accelerate)是否使用全球加速域名CosXmlServiceConfig.BuildersetAppidAndRegion(java.lang.String appid, java.lang.String region)已过时。CosXmlServiceConfig.BuildersetBucketInPath(boolean bucketInPath)已过时。CosXmlServiceConfig.BuildersetClientCertificate(byte[] certificateBytes, java.lang.String password)设置tls客户端证书CosXmlServiceConfig.BuildersetConnectionTimeout(int connectionTimeoutMills)设置连接超时时间CosXmlServiceConfig.BuildersetCustomizeNetworkClient(com.tencent.qcloud.core.http.NetworkClient customizeNetworkClient)CosXmlServiceConfig.BuildersetDebuggable(boolean isDebuggable)是否打印 Debug 日志CosXmlServiceConfig.BuildersetDomainSwitch(boolean domainSwitch)CosXmlServiceConfig.BuildersetDownloadMaxThreadCount(int downloadMaxThreadCount)设置下载时线程并发的最大值CosXmlServiceConfig.BuildersetEndpointSuffix(java.lang.String endpointSuffix)已过时。CosXmlServiceConfig.BuildersetExecutor(java.util.concurrent.Executor excutor)自定义线程池CosXmlServiceConfig.BuildersetHost(android.net.Uri uri)设置除了 GetService 请求外的 Uri,用于解析 host、port 和 protocolCosXmlServiceConfig.BuildersetHost(java.lang.String host)设置除了 GetService 请求外的 hostCosXmlServiceConfig.BuildersetHostFormat(java.lang.String hostFormat)设置 Host 的格式化字符串,sdk 会将 ${bucket} 替换为真正的 bucket,${region} 替换为真正的 region, 比如将 hostFormat 设置为 ${bucket}.CosXmlServiceConfig.BuildersetNetworkSwitchStrategy(CosXmlServiceConfig.RequestNetworkStrategy networkSwitchStrategy)配置网络切换策略,包括Quic协议、加速Host 一般用于降低成本CosXmlServiceConfig.BuildersetObserveExecutor(java.util.concurrent.Executor observeExecutor)CosXmlServiceConfig.BuildersetPathStyle(boolean pathStyle)设置 Bucket 参数在请求 Url 的 path 中,而是不 host 中, 比如 cos.ap-shanghai.myqcloud.com/1250000000-bucket/readMe.txtCosXmlServiceConfig.BuildersetPort(int port)CosXmlServiceConfig.BuildersetRedirectEnable(boolean redirectEnable)设置是否开启重定向,默认不开启CosXmlServiceConfig.BuildersetRegion(java.lang.String region)设置默认地域CosXmlServiceConfig.BuildersetRetryHandler(com.tencent.qcloud.core.http.QCloudHttpRetryHandler qCloudHttpRetryHandler)自定义重试策略CosXmlServiceConfig.BuildersetRetryStrategy(com.tencent.qcloud.core.task.RetryStrategy retryStrategy)自定义重试策略CosXmlServiceConfig.BuildersetSignInUrl(boolean signInUrl)是否将签名放在 URL 中,默认放在 Header 中CosXmlServiceConfig.BuildersetSocketTimeout(int socketTimeoutMills)设置 Socket 超时时间CosXmlServiceConfig.BuildersetTransferThreadControl(boolean transferThreadControl)设置传输时是否进行线程并发控制CosXmlServiceConfig.BuildersetUploadMaxThreadCount(int uploadMaxThreadCount)设置上传时线程并发的最大值CosXmlServiceConfig.BuildersetUserAgentExtended(java.lang.String userAgentExtended)设置ua拓展参数CosXmlServiceConfig.BuildersetVerifySSLEnable(boolean verifySSLEnable)设置是否开启TLS证书校验,默认开启
-
-
-
构造器详细资料
-
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- 线程并发的最大值
-
setDomainSwitch
public CosXmlServiceConfig.Builder setDomainSwitch(boolean domainSwitch)
-
setVerifySSLEnable
public CosXmlServiceConfig.Builder setVerifySSLEnable(boolean verifySSLEnable)
设置是否开启TLS证书校验,默认开启
-
setClientCertificate
public CosXmlServiceConfig.Builder setClientCertificate(byte[] certificateBytes, java.lang.String password)
设置tls客户端证书- 参数:
certificateBytes- 客户端证书字节数组, 需要为BKS格式password- BKS文件的密码,如果你的BKS文件没有密码,请传入null
-
setRedirectEnable
public CosXmlServiceConfig.Builder setRedirectEnable(boolean redirectEnable)
设置是否开启重定向,默认不开启
-
setCustomizeNetworkClient
public CosXmlServiceConfig.Builder setCustomizeNetworkClient(com.tencent.qcloud.core.http.NetworkClient customizeNetworkClient)
-
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- appidregion- 存储桶地域- 返回:
- 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(com.tencent.qcloud.core.task.RetryStrategy retryStrategy)
自定义重试策略- 参数:
retryStrategy- 重试策略- 返回:
- Builder 对象
-
setRetryHandler
public CosXmlServiceConfig.Builder setRetryHandler(com.tencent.qcloud.core.http.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 对象
-
setNetworkSwitchStrategy
public CosXmlServiceConfig.Builder setNetworkSwitchStrategy(CosXmlServiceConfig.RequestNetworkStrategy networkSwitchStrategy)
配置网络切换策略,包括Quic协议、加速Host 一般用于降低成本- 返回:
- 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 keyvalue- http header value
-
addNoSignHeaders
public CosXmlServiceConfig.Builder addNoSignHeaders(java.lang.String key)
-
-