com.tencent.cos.xml.model.bucket

类 PutBucketInventoryRequest

java.lang.Object

com.tencent.cos.xml.model.CosXmlRequest

com.tencent.cos.xml.model.bucket.BucketRequest

com.tencent.cos.xml.model.bucket.PutBucketInventoryRequest

public class PutBucketInventoryRequest
extends BucketRequest

在存储桶中创建清单任务的请求.

另请参阅:

CosXml.putBucketInventory(PutBucketInventoryRequest), CosXml.putBucketInventoryAsync(PutBucketInventoryRequest, CosXmlResultListener)

嵌套类概要

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

CosXmlRequest.OnRequestWeightListener

字段概要

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

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

构造器概要

构造器

构造器和说明
PutBucketInventoryRequest(java.lang.String bucket)

方法概要

限定符和类型	方法和说明
void	checkParameters() sdk 参数校验
java.lang.String	getMethod() 获取HTTP请求方法 RequestMethod
java.util.Map<java.lang.String,java.lang.String>	getQueryString() 获取url query集合
void	isEnable(boolean isEnabled) 设置清单是否启用
boolean	isNeedMD5() 针对有请求体的 PUT 和 POST 请求，此头部是必选项。
void	setDestination(java.lang.String format, java.lang.String accountId, java.lang.String bucket, java.lang.String region, java.lang.String prefix) 设置存放清单结果的存储桶信息
void	setFilter(java.lang.String prefix) 设置筛选待分析的对象前缀
void	setIncludedObjectVersions(InventoryConfiguration.IncludedObjectVersions includedObjectVersions) 设置是否在清单中包含对象版本 如果设置为 All ，清单中将会包含所有对象版本，并在清单中增加 VersionId， IsLatest， DeleteMarker 这几个字段 如果设置为 Current，则清单中不包含对象版本信息
void	setInventoryId(java.lang.String inventoryId) 设置清单的名称
void	setOptionalFields(InventoryConfiguration.Field field) 添加清单结果中应包含的分析维度
void	setScheduleFrequency(java.lang.String frequency) 设置清单任务周期
protected RequestBodySerializer	xmlBuilder() 收拢xml解析

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

getPath

从类继承的方法 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, getSTSCredentialScope, 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

构造器详细资料

PutBucketInventoryRequest

public PutBucketInventoryRequest(java.lang.String bucket)

方法详细资料

setInventoryId

public void setInventoryId(java.lang.String inventoryId)

设置清单的名称

参数:

inventoryId - 清单的名称

isEnable

public void isEnable(boolean isEnabled)

设置清单是否启用

参数:

isEnabled - 清单是否启用的标识

setFilter

public void setFilter(java.lang.String prefix)

设置筛选待分析的对象前缀

参数:

prefix - 筛选待分析的对象前缀

setDestination

public void setDestination(java.lang.String format,
                           java.lang.String accountId,
                           java.lang.String bucket,
                           java.lang.String region,
                           java.lang.String prefix)

设置存放清单结果的存储桶信息

参数:

format - 清单分析结果的文件形式，可选项为 CSV 格式和 ORC 格式

accountId - 存储桶的所有者 ID

bucket - 清单分析结果的存储桶名

region - 清单分析结果的存储桶区域

prefix - 清单分析结果的前缀

setScheduleFrequency

public void setScheduleFrequency(java.lang.String frequency)

设置清单任务周期

参数:

frequency - 清单任务周期，可选项为按日或者按周

setOptionalFields

public void setOptionalFields(InventoryConfiguration.Field field)

添加清单结果中应包含的分析维度

参数:

field - 清单结果中应包含的分析维度

setIncludedObjectVersions

public void setIncludedObjectVersions(InventoryConfiguration.IncludedObjectVersions includedObjectVersions)

设置是否在清单中包含对象版本 如果设置为 All ，清单中将会包含所有对象版本，并在清单中增加 VersionId， IsLatest， DeleteMarker 这几个字段 如果设置为 Current，则清单中不包含对象版本信息

参数:

includedObjectVersions - 是否在清单中包含对象版本

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

isNeedMD5

public boolean isNeedMD5()

从类复制的说明: CosXmlRequest

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

覆盖:

isNeedMD5 在类中 CosXmlRequest

checkParameters

public void checkParameters()
                     throws CosXmlClientException

从类复制的说明: CosXmlRequest

sdk 参数校验

覆盖:

checkParameters 在类中 BucketRequest

抛出:

CosXmlClientException - cosXmlClientException