com.tencent.cos.xml.model.bucket

类 GetBucketRequest

java.lang.Object

com.tencent.cos.xml.model.CosXmlRequest

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

com.tencent.cos.xml.model.bucket.GetBucketRequest

public final class GetBucketRequest
extends BucketRequest

查询存储桶（Bucket) 下的部分或者全部对象的请求.

另请参阅:

CosXml.getBucket(GetBucketRequest), CosXml.getBucketAsync(GetBucketRequest, 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

构造器概要

构造器

构造器和说明
GetBucketRequest(java.lang.String bucket)
GetBucketRequest(java.lang.String region, java.lang.String bucket, java.lang.String prefix)

方法概要

限定符和类型	方法和说明
java.lang.String	getDelimiter() 获取请求的定界符
java.lang.String	getEncodingType() 获取返回值的编码类型。
java.lang.String	getMarker() 获取请求的marker
long	getMaxKeys() 获取请求的最大条目数
java.lang.String	getMethod() 获取HTTP请求方法 RequestMethod
java.lang.String	getPrefix() 获取请求的匹配前缀。
java.util.Map<java.lang.String,java.lang.String>	getQueryString() 获取url query集合
RequestBodySerializer	getRequestBody() 获取请求体
STSCredentialScope[]	getSTSCredentialScope(CosXmlServiceConfig config) 获取STS范围限制信息
void	setDelimiter(char delimiter) 已过时。
void	setDelimiter(java.lang.String delimiter)
void	setEncodingType(java.lang.String encodingType) 设置返回值的编码方式，可选值：url
void	setMarker(java.lang.String marker) 设置列出文件的marker 默认以 UTF-8 二进制顺序列出条目，所有列出条目从marker开始
void	setMaxKeys(long maxKeys) 设置单次返回的最大条目数。
void	setPrefix(java.lang.String prefix) 设置匹配前缀，用来规定返回的文件前缀地址。

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

checkParameters, getPath

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

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

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

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

构造器详细资料

GetBucketRequest

public GetBucketRequest(java.lang.String bucket)

GetBucketRequest

public GetBucketRequest(java.lang.String region,
                        java.lang.String bucket,
                        java.lang.String prefix)

方法详细资料

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集合

getRequestBody

public RequestBodySerializer getRequestBody()

从类复制的说明: CosXmlRequest

获取请求体

覆盖:

getRequestBody 在类中 CosXmlRequest

返回:

请求体

getSTSCredentialScope

public STSCredentialScope[] getSTSCredentialScope(CosXmlServiceConfig config)

从类复制的说明: CosXmlRequest

获取STS范围限制信息

覆盖:

getSTSCredentialScope 在类中 CosXmlRequest

参数:

config - SDK服务配置

返回:

STS范围限制信息

setPrefix

public void setPrefix(java.lang.String prefix)

设置匹配前缀，用来规定返回的文件前缀地址。

参数:

prefix - 前缀

getPrefix

public java.lang.String getPrefix()

获取请求的匹配前缀。

返回:

请求前缀

setDelimiter

@Deprecated
public void setDelimiter(char delimiter)

已过时。

设置定界符 delimiter

定界符为一个符号，如果有 Prefix，则将 Prefix 到 delimiter 之间的相同路径归为一类，定义为 Common Prefix，然后列出所有 Common Prefix。如果没有 Prefix，则从路径起点开始。

参数:

delimiter -

另请参阅:

setDelimiter(String)

setDelimiter

public void setDelimiter(java.lang.String delimiter)

getDelimiter

public java.lang.String getDelimiter()

获取请求的定界符

setEncodingType

public void setEncodingType(java.lang.String encodingType)

设置返回值的编码方式，可选值：url

参数:

encodingType -

getEncodingType

public java.lang.String getEncodingType()

获取返回值的编码类型。

setMarker

public void setMarker(java.lang.String marker)

设置列出文件的marker

默认以 UTF-8 二进制顺序列出条目，所有列出条目从marker开始

参数:

marker -

getMarker

public java.lang.String getMarker()

获取请求的marker

setMaxKeys

public void setMaxKeys(long maxKeys)

设置单次返回的最大条目数。默认为1000

参数:

maxKeys -

getMaxKeys

public long getMaxKeys()

获取请求的最大条目数