com.tencent.cos.xml.model.object

类 PostObjectRequest

java.lang.Object

com.tencent.cos.xml.model.CosXmlRequest

com.tencent.cos.xml.model.object.ObjectRequest

com.tencent.cos.xml.model.object.PostObjectRequest

public class PostObjectRequest
extends ObjectRequest

使用表单请求上传对象的请求.

另请参阅:

SimpleCosXml.postObject(PostObjectRequest), SimpleCosXml.postObjectAsync(PostObjectRequest, CosXmlResultListener)

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	PostObjectRequest.Policy 策略 详情请参考：POST Object中的 构造“策略”（Policy）

从类继承的嵌套类/接口 com.tencent.cos.xml.model.CosXmlRequest

CosXmlRequest.OnRequestWeightListener

字段概要

从类继承的字段 com.tencent.cos.xml.model.object.ObjectRequest

cosPath

从类继承的字段 com.tencent.cos.xml.model.CosXmlRequest

bucket, noSignHeaders, noSignParams, priority, qCloudTaskStateListener, queryParameters, region, requestHeaders, requestURL, signSourceProvider

构造器概要

构造器

构造器和说明
PostObjectRequest(java.lang.String bucket, java.lang.String cosPath, byte[] data)
PostObjectRequest(java.lang.String bucket, java.lang.String cosPath, java.io.InputStream inputStream)
PostObjectRequest(java.lang.String bucket, java.lang.String cosPath, java.lang.String srcPath)

方法概要

限定符和类型	方法和说明
void	checkParameters() sdk 参数校验
java.lang.String	getMethod() 获取HTTP请求方法 RequestMethod
CosXmlProgressListener	getProgressListener() 获取上传进度回调监听
RequestBodySerializer	getRequestBody() 获取请求体
QCloudSignSourceProvider	getSignSourceProvider() 获取签名原料提供器
void	setAcl(java.lang.String acl) 定义对象的访问控制列表（ACL）属性。
void	setCacheControl(java.lang.String cacheControl) 设置Cache-Control头部
void	setContentDisposition(java.lang.String contentDisposition) 设置Content-Disposition头部
void	setContentEncoding(java.lang.String contentEncoding) 设置Content-Encoding头部
void	setContentType(java.lang.String contentType) 设置Content-Type头部
void	setCosStorageClass(java.lang.String cosStorageClass) 设置对象的存储类型。
void	setCustomerHeader(java.lang.String key, java.lang.String value) 设置from表单内容
void	setExpires(java.lang.String expires) 设置Expires头部
void	setHeader(java.lang.String key, java.lang.String value) 设置HTTP头部
void	setPolicy(PostObjectRequest.Policy policy) 设置策略
void	setProgressListener(CosXmlProgressListener progressListener) 设置上传进度回调监听
void	setRange(long offset, long contentSize) 设置文件长度范围
void	setSignParamsAndHeaders(java.util.Set<java.lang.String> parameters, java.util.Set<java.lang.String> headers) 设置参与签名的参数字段和头部字段
void	setStroageClass(COSStorageClass stroageClass) 设置对象的存储类型。
void	setSuccessActionRedirect(java.lang.String redirectHost) 设置上传成功时重定向的目标 URL 地址
void	setSuccessActionStatus(int successHttpCode) 设置上传成功时返回的 HTTP 状态码
void	setTrafficLimit(long limit) 单链接限速，单位为bit/s 限速值设置范围为819200~838860800，即100KB/s~100MB/s，如果超出该范围会返回400错误。

从类继承的方法 com.tencent.cos.xml.model.object.ObjectRequest

getContentType, getCosPath, getPath, setCosPath, setCOSServerSideEncryption, setCOSServerSideEncryptionWithCustomerKey, setCOSServerSideEncryptionWithKMS

从类继承的方法 com.tencent.cos.xml.model.CosXmlRequest

addHeader, addNoSignHeader, addNoSignParams, addQuery, attachMetrics, getBucket, getHttpTask, getKeyTime, getMetrics, getNoSignHeaders, getNoSignParams, getPriority, getQueryEncodedString, getQueryString, getRegion, getRequestHeaders, getRequestHost, getRequestURL, getSTSCredentialScope, getWeight, headersHasUnsafeNonAscii, isNeedMD5, isSignInUrl, isSupportAccelerate, isSupportAccelerate, setNeedMD5, setOnRequestWeightListener, setQueryEncodedString, setQueryParameters, setRegion, setRequestHeaders, setRequestHeaders, setRequestHeaders, setRequestURL, setSign, setSign, setSign, setSign, setSign, setSignInUrl, setSignKeyTime, setSignSourceProvider, setTask, setTaskStateListener, xmlBuilder

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

PostObjectRequest

public PostObjectRequest(java.lang.String bucket,
                         java.lang.String cosPath,
                         java.lang.String srcPath)

PostObjectRequest

public PostObjectRequest(java.lang.String bucket,
                         java.lang.String cosPath,
                         byte[] data)

PostObjectRequest

public PostObjectRequest(java.lang.String bucket,
                         java.lang.String cosPath,
                         java.io.InputStream inputStream)

方法详细资料

setRange

public void setRange(long offset,
                     long contentSize)

设置文件长度范围

getMethod

public java.lang.String getMethod()

从类复制的说明: CosXmlRequest

获取HTTP请求方法 RequestMethod

指定者:

getMethod 在类中 CosXmlRequest

返回:

HTTP请求方法

getRequestBody

public RequestBodySerializer getRequestBody()
                                     throws CosXmlClientException

从类复制的说明: CosXmlRequest

获取请求体

覆盖:

getRequestBody 在类中 CosXmlRequest

返回:

请求体

抛出:

CosXmlClientException - 客户异常

setSignParamsAndHeaders

public void setSignParamsAndHeaders(java.util.Set<java.lang.String> parameters,
                                    java.util.Set<java.lang.String> headers)

从类复制的说明: CosXmlRequest

设置参与签名的参数字段和头部字段

覆盖:

setSignParamsAndHeaders 在类中 CosXmlRequest

参数:

parameters - 参与签名的参数字段

headers - 参与签名的头部字段

getSignSourceProvider

public QCloudSignSourceProvider getSignSourceProvider()

从类复制的说明: CosXmlRequest

获取签名原料提供器

覆盖:

getSignSourceProvider 在类中 CosXmlRequest

返回:

签名原料提供器

checkParameters

public void checkParameters()
                     throws CosXmlClientException

从类复制的说明: CosXmlRequest

sdk 参数校验

覆盖:

checkParameters 在类中 ObjectRequest

抛出:

CosXmlClientException - cosXmlClientException

setProgressListener

public void setProgressListener(CosXmlProgressListener progressListener)

设置上传进度回调监听

参数:

progressListener - 进度监听器 CosXmlProgressListener

getProgressListener

public CosXmlProgressListener getProgressListener()

获取上传进度回调监听

返回:

上传进度回调监听

setAcl

public void setAcl(java.lang.String acl)

定义对象的访问控制列表（ACL）属性。 枚举值请参见 ACL 概述 文档中对象的预设 ACL 部分，例如 default，private，public-read 等，默认为 default

参数:

acl - COS 访问权限

setCacheControl

public void setCacheControl(java.lang.String cacheControl)

设置Cache-Control头部

参数:

cacheControl - Cache-Control头部

setContentType

public void setContentType(java.lang.String contentType)

设置Content-Type头部

参数:

contentType - Content-Type头部

setContentDisposition

public void setContentDisposition(java.lang.String contentDisposition)

设置Content-Disposition头部

参数:

contentDisposition - Content-Disposition头部

setContentEncoding

public void setContentEncoding(java.lang.String contentEncoding)

设置Content-Encoding头部

参数:

contentEncoding - Content-Encoding头部

setExpires

public void setExpires(java.lang.String expires)

设置Expires头部

参数:

expires - Expires头部

setStroageClass

public void setStroageClass(COSStorageClass stroageClass)

设置对象的存储类型。 枚举值请参见 存储类型 文档，例如 STANDARD_IA，ARCHIVE。默认值：STANDARD

参数:

stroageClass - COS存储类型

setHeader

public void setHeader(java.lang.String key,
                      java.lang.String value)

设置HTTP头部

参数:

key - 键

value - 值

setCustomerHeader

public void setCustomerHeader(java.lang.String key,
                              java.lang.String value)

设置from表单内容

参数:

key - 键

value - 值

setCosStorageClass

public void setCosStorageClass(java.lang.String cosStorageClass)

设置对象的存储类型。 枚举值请参见 存储类型 文档，例如 STANDARD_IA，ARCHIVE。默认值：STANDARD

参数:

cosStorageClass - COS存储类型

setSuccessActionRedirect

public void setSuccessActionRedirect(java.lang.String redirectHost)

设置上传成功时重定向的目标 URL 地址

参数:

redirectHost - 上传成功时重定向的目标 URL 地址

setSuccessActionStatus

public void setSuccessActionStatus(int successHttpCode)

设置上传成功时返回的 HTTP 状态码

参数:

successHttpCode - 上传成功时返回的 HTTP 状态码

setPolicy

public void setPolicy(PostObjectRequest.Policy policy)

设置策略

参数:

policy - 策略

setTrafficLimit

public void setTrafficLimit(long limit)

单链接限速，单位为bit/s 限速值设置范围为819200~838860800，即100KB/s~100MB/s，如果超出该范围会返回400错误。