com.tencent.cos.xml.model.object

类 DeleteMultiObjectRequest

java.lang.Object

com.tencent.cos.xml.model.CosXmlRequest

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

com.tencent.cos.xml.model.object.DeleteMultiObjectRequest

public final class DeleteMultiObjectRequest
extends ObjectRequest

批量删除 COS 对象的请求.

另请参阅:

CosXml.deleteMultiObject(DeleteMultiObjectRequest), CosXml.deleteMultiObjectAsync(DeleteMultiObjectRequest, CosXmlResultListener)

嵌套类概要

从类继承的嵌套类/接口 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

构造器概要

构造器

构造器和说明
DeleteMultiObjectRequest(java.lang.String bucket)
DeleteMultiObjectRequest(java.lang.String bucket, java.util.List<java.lang.String> deleteObjectList)

方法概要

限定符和类型	方法和说明
void	checkParameters() sdk 参数校验
Delete	getDelete() 获取批量删除对象数据
java.lang.String	getMethod() 获取HTTP请求方法 RequestMethod
java.lang.String	getPath(CosXmlServiceConfig config) 支持 CSP 的 Bucket 可能在 path 上
java.util.Map<java.lang.String,java.lang.String>	getQueryString() 获取url query集合
STSCredentialScope[]	getSTSCredentialScope(CosXmlServiceConfig config) 获取STS范围限制信息
boolean	isNeedMD5() 针对有请求体的 PUT 和 POST 请求，此头部是必选项。
void	setObjectList(java.util.List<java.lang.String> objectList) 添加多个需要删除的Objects
void	setObjectList(java.util.Map<java.lang.String,java.lang.String> objectListWithVersionId) 添加多个需要删除的Objects
void	setObjectList(java.lang.String object) 添加需要删除的Object
void	setObjectList(java.lang.String object, java.lang.String versionId) 添加需要删除的Object
void	setQuiet(boolean quiet) 设置是否为quiet模式。
protected RequestBodySerializer	xmlBuilder() 收拢xml解析

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

getContentType, getCosPath, setCosPath, setCOSServerSideEncryption, setCOSServerSideEncryptionWithCustomerKey, setCOSServerSideEncryptionWithKMS

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

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

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

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

构造器详细资料

DeleteMultiObjectRequest

public DeleteMultiObjectRequest(java.lang.String bucket,
                                java.util.List<java.lang.String> deleteObjectList)

DeleteMultiObjectRequest

public DeleteMultiObjectRequest(java.lang.String bucket)

方法详细资料

getMethod

public java.lang.String getMethod()

从类复制的说明: CosXmlRequest

获取HTTP请求方法 RequestMethod

指定者:

getMethod 在类中 CosXmlRequest

返回:

HTTP请求方法

getQueryString

public java.util.Map<java.lang.String,java.lang.String> getQueryString()

从类复制的说明: CosXmlRequest

获取url query集合

覆盖:

getQueryString 在类中 CosXmlRequest

返回:

url query集合

xmlBuilder

protected RequestBodySerializer xmlBuilder()
                                    throws org.xmlpull.v1.XmlPullParserException,
                                           java.io.IOException

从类复制的说明: CosXmlRequest

收拢xml解析

覆盖:

xmlBuilder 在类中 CosXmlRequest

抛出:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

checkParameters

public void checkParameters()
                     throws CosXmlClientException

从类复制的说明: CosXmlRequest

sdk 参数校验

覆盖:

checkParameters 在类中 ObjectRequest

抛出:

CosXmlClientException - cosXmlClientException

getSTSCredentialScope

public STSCredentialScope[] getSTSCredentialScope(CosXmlServiceConfig config)

从类复制的说明: CosXmlRequest

获取STS范围限制信息

覆盖:

getSTSCredentialScope 在类中 CosXmlRequest

参数:

config - SDK服务配置

返回:

STS范围限制信息

getPath

public java.lang.String getPath(CosXmlServiceConfig config)

从类复制的说明: ObjectRequest

支持 CSP 的 Bucket 可能在 path 上

覆盖:

getPath 在类中 ObjectRequest

参数:

config - 服务配置

返回:

path

setQuiet

public void setQuiet(boolean quiet)

设置是否为quiet模式。

Quiet 模式只返回报错的 Object 信息。否则返回每个 Object 的删除结果。

默认false

参数:

quiet - 设置是否为quiet模式

setObjectList

public void setObjectList(java.lang.String object)

添加需要删除的Object

参数:

object - Object的路径

setObjectList

public void setObjectList(java.lang.String object,
                          java.lang.String versionId)

添加需要删除的Object

参数:

object - Object的路径

versionId - Object的版本

setObjectList

public void setObjectList(java.util.List<java.lang.String> objectList)

添加多个需要删除的Objects

参数:

objectList - Objects的路径列表

setObjectList

public void setObjectList(java.util.Map<java.lang.String,java.lang.String> objectListWithVersionId)

添加多个需要删除的Objects

参数:

objectListWithVersionId - Objects的路径列表(包含对象版本)

isNeedMD5

public boolean isNeedMD5()

从类复制的说明: CosXmlRequest

针对有请求体的 PUT 和 POST 请求，此头部是必选项。 针对 GET、HEAD、DELETE 和 OPTIONS 请求，不能指定此头部。 RFC 1864中定义的请求体内容的16字节二进制 MD5 哈希值的 Base64 编码形式，用于完整性检查， 验证请求体在传输过程中是否发生变化，最终的取值长度应为24个字符，请注意在编写代码时使用正确的方法和参数，例如ZzD3iDJdrMAAb00lgLLeig==

覆盖:

isNeedMD5 在类中 CosXmlRequest

getDelete

public Delete getDelete()

获取批量删除对象数据

返回:

批量删除对象数据