com.aliyun.oss.model

Class ListObjectsRequest

java.lang.Object

com.aliyun.oss.model.WebServiceRequest

com.aliyun.oss.model.GenericRequest

com.aliyun.oss.model.ListObjectsRequest

public class ListObjectsRequest
extends GenericRequest

This is the request class to list objects under a bucket.

Field Summary

Fields inherited from class com.aliyun.oss.model.WebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListObjectsRequest()
ListObjectsRequest(String bucketName)
ListObjectsRequest(String bucketName, String prefix, String marker, String delimiter, Integer maxKeys) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getDelimiter() Gets the delimiter of object names.
String	getEncodingType() Gets the encoding type of object names in response body.
String	getMarker() Gets the marker filter.
Integer	getMaxKeys() Gets the max objects to return.
String	getPrefix() Gets the prefix filter.
void	setDelimiter(String delimiter) Sets the delimiter.
void	setEncodingType(String encodingType) Sets the encoding type of object names in response body.
void	setMarker(String marker) Sets the marker filter.
void	setMaxKeys(Integer maxKeys) Sets the max objects to return.
void	setPrefix(String prefix) Sets the prefix filter.
ListObjectsRequest	withDelimiter(String delimiter) Sets the delimiter and returns the current ListObjectsRequest instance (this).
ListObjectsRequest	withEncodingType(String encodingType) Sets the encoding type of object names in response body and returns the current ListObjectsRequest instance (this).
ListObjectsRequest	withMarker(String marker) Sets the mark filter and returns the current ListObjectsRequest instance (this).
ListObjectsRequest	withMaxKeys(Integer maxKeys) Sets the max objects and returns the current ListObjectsRequest instance (this).
ListObjectsRequest	withPrefix(String prefix) Sets teh prefix filter and return the current ListObjectsRequest instance (this).

Methods inherited from class com.aliyun.oss.model.GenericRequest

getBucketName, getKey, getRequestPayer, getVersionId, setBucketName, setKey, setRequestPayer, setVersionId, withBucketName, withKey, withRequestPayer, withVersionId

Methods inherited from class com.aliyun.oss.model.WebServiceRequest

addAdditionalHeaderName, addHeader, addParameter, getAdditionalHeaderNames, getHeaders, getParameters, getProgressListener, isLogEnabled, setAdditionalHeaderNames, setHeaders, setLogEnabled, setParameters, setProgressListener, withProgressListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ListObjectsRequest

public ListObjectsRequest()

ListObjectsRequest

public ListObjectsRequest(String bucketName)

ListObjectsRequest

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

Constructor

Parameters:

bucketName - Bucket name.

prefix - The prefix filter---Objects to return must start with this prefix in their names.

marker - The marker filter---Objects to return whose names must be greater than this marker value.

maxKeys - The max object counts to return. The default is 100.

delimiter - The delimiter for the object names to return.

Method Detail

getPrefix

public String getPrefix()

Gets the prefix filter.

Returns:

The prefix filter.

setPrefix

public void setPrefix(String prefix)

Sets the prefix filter.

Parameters:

prefix - The prefix filter.

withPrefix

public ListObjectsRequest withPrefix(String prefix)

Sets teh prefix filter and return the current ListObjectsRequest instance (this).

Parameters:

prefix - The prefix filter.

getMarker

public String getMarker()

Gets the marker filter.

Returns:

The marker filter.

setMarker

public void setMarker(String marker)

Sets the marker filter.

Parameters:

marker - The marker filter.

withMarker

public ListObjectsRequest withMarker(String marker)

Sets the mark filter and returns the current ListObjectsRequest instance (this).

Parameters:

marker - marker

getMaxKeys

public Integer getMaxKeys()

Gets the max objects to return. By default it's 100.

Returns:

The max objects to return.

setMaxKeys

public void setMaxKeys(Integer maxKeys)

Sets the max objects to return. By default it's 100, the max is 1000.

Parameters:

maxKeys - The max objects to return. The max value is 1000.

withMaxKeys

public ListObjectsRequest withMaxKeys(Integer maxKeys)

Sets the max objects and returns the current ListObjectsRequest instance (this). By default it's 100, the max is 1000.

Parameters:

maxKeys - The max objects to return.

getDelimiter

public String getDelimiter()

Gets the delimiter of object names.

Returns:

the delimiter

setDelimiter

public void setDelimiter(String delimiter)

Sets the delimiter.

Parameters:

delimiter - the delimiter to set

withDelimiter

public ListObjectsRequest withDelimiter(String delimiter)

Sets the delimiter and returns the current ListObjectsRequest instance (this).

Parameters:

delimiter - the delimiter to set

getEncodingType

public String getEncodingType()

Gets the encoding type of object names in response body.

Returns:

The encoding type of object names in response body.

setEncodingType

public void setEncodingType(String encodingType)

Sets the encoding type of object names in response body.

Parameters:

encodingType - The encoding type of object names in response body. Valid values are 'null' or 'url'.

withEncodingType

public ListObjectsRequest withEncodingType(String encodingType)

Sets the encoding type of object names in response body and returns the current ListObjectsRequest instance (this).

Parameters:

encodingType - The encoding type of object names in response body. Valid values are 'null' or 'url'.