com.aliyun.oss.model

类 ListObjectsRequest

java.lang.Object

com.aliyun.oss.model.WebServiceRequest

com.aliyun.oss.model.GenericRequest

com.aliyun.oss.model.ListObjectsRequest

public class ListObjectsRequest
extends GenericRequest

包含获取object列表的请求信息。

字段概要

从类继承的字段 com.aliyun.oss.model.WebServiceRequest

NOOP

构造器概要

构造器

构造器和说明
ListObjectsRequest()
ListObjectsRequest(String bucketName)
ListObjectsRequest(String bucketName, String prefix, String marker, String delimiter, Integer maxKeys) 构造函数。

方法概要

方法

限定符和类型	方法和说明
String	getDelimiter() 获取一个用于对Object名字进行分组的字符。
String	getEncodingType() 获取应用于请求响应体中Object名称的编码方式。
String	getMarker() 返回marker，用户设定结果从marker之后按字母排序的第一个开始返回。
Integer	getMaxKeys() 返回用于限定此次返回object的最大数，如果不设定，默认为100。
String	getPrefix() 返回prefix，限定返回的object key必须以prefix作为前缀。
void	setDelimiter(String delimiter) 设置一个用于对Object名字进行分组的字符。
void	setEncodingType(String encodingType) 设置应用于请求响应体中Object名称的编码方式。
void	setMarker(String marker) 设置marker, 用户设定结果从marker之后按字母排序的第一个开始返回。
void	setMaxKeys(Integer maxKeys) 设置用于限定此次返回object的最大数，如果不设定，默认为100。
void	setPrefix(String prefix) 设置prefix，限定返回的object key必须以prefix作为前缀。
ListObjectsRequest	withDelimiter(String delimiter) 设置一个用于对Object名字进行分组的字符。
ListObjectsRequest	withEncodingType(String encodingType) 设置应用于请求响应体中Object名称的编码方式。
ListObjectsRequest	withMarker(String marker) 设置marker, 用户设定结果从marker之后按字母排序的第一个开始返回。
ListObjectsRequest	withMaxKeys(Integer maxKeys) 设置用于限定此次返回object的最大数，如果不设定，默认为100。
ListObjectsRequest	withPrefix(String prefix) 设置prefix，限定返回的object key必须以prefix作为前缀。

从类继承的方法 com.aliyun.oss.model.GenericRequest

getBucketName, getKey, setBucketName, setKey, withBucketName, withKey

从类继承的方法 com.aliyun.oss.model.WebServiceRequest

addHeader, addParameter, getHeaders, getParameters, getProgressListener, setHeaders, setParameters, setProgressListener, withProgressListener

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

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

构造器详细资料

ListObjectsRequest

public ListObjectsRequest()

ListObjectsRequest

public ListObjectsRequest(String bucketName)

ListObjectsRequest

public ListObjectsRequest(String bucketName,
                  String prefix,
                  String marker,
                  String delimiter,
                  Integer maxKeys)

构造函数。

参数:

bucketName - bucket 名称。

prefix - prefix限定返回的object key必须以prefix作为前缀。

marker - maker用户设定结果从marker之后按字母排序的第一个开始返回。

maxKeys - 用于限定此次返回object的最大数，如果不设定，默认为100。

delimiter - delimiter是一个用于对Object名字进行分组的字符。

方法详细资料

getPrefix

public String getPrefix()

返回prefix，限定返回的object key必须以prefix作为前缀。

返回:

prefix

setPrefix

public void setPrefix(String prefix)

设置prefix，限定返回的object key必须以prefix作为前缀。

参数:

prefix - 前缀prefix。

withPrefix

public ListObjectsRequest withPrefix(String prefix)

设置prefix，限定返回的object key必须以prefix作为前缀。

参数:

prefix - 前缀prefix。

getMarker

public String getMarker()

返回marker，用户设定结果从marker之后按字母排序的第一个开始返回。

返回:

marker

setMarker

public void setMarker(String marker)

设置marker, 用户设定结果从marker之后按字母排序的第一个开始返回。

参数:

marker - marker

withMarker

public ListObjectsRequest withMarker(String marker)

设置marker, 用户设定结果从marker之后按字母排序的第一个开始返回。

参数:

marker - marker

getMaxKeys

public Integer getMaxKeys()

返回用于限定此次返回object的最大数，如果不设定，默认为100。

返回:

用于限定此次返回object的最大数。

setMaxKeys

public void setMaxKeys(Integer maxKeys)

设置用于限定此次返回object的最大数，如果不设定，默认为100。最大值为1000。

参数:

maxKeys - 用于限定此次返回object的最大数。最大值为1000。

withMaxKeys

public ListObjectsRequest withMaxKeys(Integer maxKeys)

设置用于限定此次返回object的最大数，如果不设定，默认为100。最大值为1000。

参数:

maxKeys - 用于限定此次返回object的最大数。最大值为1000。

getDelimiter

public String getDelimiter()

获取一个用于对Object名字进行分组的字符。

返回:

the delimiter

setDelimiter

public void setDelimiter(String delimiter)

设置一个用于对Object名字进行分组的字符。

参数:

delimiter - the delimiter to set

withDelimiter

public ListObjectsRequest withDelimiter(String delimiter)

设置一个用于对Object名字进行分组的字符。

参数:

delimiter - the delimiter to set

getEncodingType

public String getEncodingType()

获取应用于请求响应体中Object名称的编码方式。

返回:

请求响应体中Object名称的编码方式。

setEncodingType

public void setEncodingType(String encodingType)

设置应用于请求响应体中Object名称的编码方式。

参数:

encodingType - 请求响应体中Object名称的编码方式。 有效值: null (不进行编码处理) 或 "url".

withEncodingType

public ListObjectsRequest withEncodingType(String encodingType)

设置应用于请求响应体中Object名称的编码方式。

参数:

encodingType - 请求响应体中Object名称的编码方式。 有效值: null (不进行编码处理) 或 "url".