com.qcloud.cos.model

类 ListVersionsRequest

java.lang.Object

com.qcloud.cos.internal.CosServiceRequest

com.qcloud.cos.model.ListVersionsRequest

所有已实现的接口:

ReadLimitInfo, Serializable, Cloneable

public class ListVersionsRequest
extends CosServiceRequest
implements Serializable

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
ListVersionsRequest() Constructs a new ListVersionsRequest object.
ListVersionsRequest(String bucketName, String prefix, String keyMarker, String versionIdMarker, String delimiter, Integer maxResults) Constructs a new ListVersionsRequest object and initializes all required and optional fields.

方法概要

方法

限定符和类型	方法和说明
String	getBucketName() Gets the name of the COS bucket whose versions are to be listed.
String	getDelimiter() Gets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.
String	getEncodingType() Gets the optional encodingType parameter indicating the encoding method to be applied on the response.
String	getKeyMarker() Gets the optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
Integer	getMaxResults() Gets the optional maxResults parameter indicating the maximum number of results to include in the response.
String	getPrefix() Gets the optional prefix parameter restricting the response to keys that begin with the specified prefix.
String	getVersionIdMarker() Gets the optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
void	setBucketName(String bucketName) Sets the name of the COS bucket whose versions are to be listed.
void	setDelimiter(String delimiter) Sets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.
void	setEncodingType(String encodingType) Sets the optional encodingType parameter indicating the encoding method to be applied on the response.
void	setKeyMarker(String keyMarker) Sets the optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
void	setMaxResults(Integer maxResults) Sets the optional maxResults parameter indicating the maximum number of results to include in the response.
void	setPrefix(String prefix) Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix.
void	setVersionIdMarker(String versionIdMarker) Sets the optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
ListVersionsRequest	withBucketName(String bucketName) Sets the name of the COS bucket whose versions are to be listed.
ListVersionsRequest	withDelimiter(String delimiter) Sets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.
ListVersionsRequest	withEncodingType(String encodingType) Sets the optional encodingType parameter indicating the encoding method to be applied on the response.
ListVersionsRequest	withKeyMarker(String keyMarker) Sets the optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
ListVersionsRequest	withMaxResults(Integer maxResults) Sets the optional maxResults parameter indicating the maximum number of results to include in the response.
ListVersionsRequest	withPrefix(String prefix) Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix.
ListVersionsRequest	withVersionIdMarker(String versionIdMarker) Sets the optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

从类继承的方法 com.qcloud.cos.internal.CosServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, withGeneralProgressListener

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

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

构造器详细资料

ListVersionsRequest

public ListVersionsRequest()

Constructs a new ListVersionsRequest object. The caller must populate the fields before the request is executed.

另请参阅:

ListVersionsRequest(String, String, String, String, String, Integer)

ListVersionsRequest

public ListVersionsRequest(String bucketName,
                   String prefix,
                   String keyMarker,
                   String versionIdMarker,
                   String delimiter,
                   Integer maxResults)

Constructs a new ListVersionsRequest object and initializes all required and optional fields.

参数:

bucketName - The name of the bucket whose versions are to be listed.

prefix - The prefix restricting what keys will be listed.

keyMarker - The key marker indicating where results should begin.

versionIdMarker - The version ID marker indicating where results should begin.

delimiter - The delimiter for condensing common prefixes in returned results.

maxResults - The maximum number of results to return.

另请参阅:

ListVersionsRequest()

方法详细资料

getBucketName

public String getBucketName()

Gets the name of the COS bucket whose versions are to be listed.

返回:

The name of the COS bucket whose versions are to be listed.

另请参阅:

setBucketName(String), withBucketName(String)

setBucketName

public void setBucketName(String bucketName)

Sets the name of the COS bucket whose versions are to be listed.

参数:

bucketName - The name of the COS bucket whose versions are to be listed.

另请参阅:

getBucketName(), withBucketName(String)

withBucketName

public ListVersionsRequest withBucketName(String bucketName)

Sets the name of the COS bucket whose versions are to be listed. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

参数:

bucketName - The name of the COS bucket whose versions are to be listed.

返回:

This ListVersionsRequest, enabling additional method calls to be chained together.

另请参阅:

getBucketName(), setBucketName(String)

getPrefix

public String getPrefix()

Gets the optional prefix parameter restricting the response to keys that begin with the specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to how a file system organizes files into directories.

返回:

The optional prefix parameter restricting the response to keys that begin with the specified prefix.

另请参阅:

setPrefix(String), withPrefix(String)

setPrefix

public void setPrefix(String prefix)

Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix.

参数:

prefix - The optional prefix parameter restricting the response to keys that begin with the specified prefix.

另请参阅:

getPrefix(), withPrefix(String)

withPrefix

public ListVersionsRequest withPrefix(String prefix)

Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

参数:

prefix - The optional prefix parameter restricting the response to keys that begin with the specified prefix.

返回:

This ListVersionsRequest, enabling additional method calls to be chained together.

另请参阅:

getPrefix(), setPrefix(String)

getKeyMarker

public String getKeyMarker()

Gets the optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (i.e. alphabetically) and then from most recent version to least recent version.

If a keyMarker is used without a version ID marker, results begin immediately after that key's last version. When a keyMarker is used with a version ID marker, results begin immediately after the version with the specified key and version ID.

返回:

The optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

另请参阅:

setKeyMarker(String), withKeyMarker(String)

setKeyMarker

public void setKeyMarker(String keyMarker)

Sets the optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

参数:

keyMarker - The optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

另请参阅:

getKeyMarker(), withKeyMarker(String)

withKeyMarker

public ListVersionsRequest withKeyMarker(String keyMarker)

Sets the optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

参数:

keyMarker - The optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

返回:

This ListVersionsRequest, enabling additional method calls to be chained together.

另请参阅:

getKeyMarker(), setKeyMarker(String)

getVersionIdMarker

public String getVersionIdMarker()

Gets the optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (i.e. alphabetically) and then from most recent version to least recent version.

A key marker must be specified when specifying a versionIdMarker. Results begin immediately after the version with the specified key and version ID.

返回:

The optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

另请参阅:

setVersionIdMarker(String), withVersionIdMarker(String)

setVersionIdMarker

public void setVersionIdMarker(String versionIdMarker)

Sets the optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

参数:

versionIdMarker - The optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

另请参阅:

getVersionIdMarker(), withVersionIdMarker(String)

withVersionIdMarker

public ListVersionsRequest withVersionIdMarker(String versionIdMarker)

Sets the optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

参数:

versionIdMarker - The optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

返回:

This ListVersionsRequest, enabling additional method calls to be chained together.

另请参阅:

getVersionIdMarker(), setVersionIdMarker(String)

getDelimiter

public String getDelimiter()

Gets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list. These combined keys are not returned elsewhere in the response.

The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.

返回:

The optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.

另请参阅:

setDelimiter(String), withDelimiter(String)

setDelimiter

public void setDelimiter(String delimiter)

Sets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.

参数:

delimiter - The optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.

另请参阅:

getDelimiter(), withDelimiter(String)

withDelimiter

public ListVersionsRequest withDelimiter(String delimiter)

Sets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

参数:

delimiter - The optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.

返回:

This ListVersionsRequest, enabling additional method calls to be chained together.

另请参阅:

getDelimiter(), setDelimiter(String)

getMaxResults

public Integer getMaxResults()

Gets the optional maxResults parameter indicating the maximum number of results to include in the response. COS might return fewer than this, but will never return more. Even if maxResults is not specified, COS will limit the number of results in the response.

返回:

The optional maxResults parameter indicating the maximum number of results

另请参阅:

setMaxResults(Integer), withMaxResults(Integer)

setMaxResults

public void setMaxResults(Integer maxResults)

Sets the optional maxResults parameter indicating the maximum number of results to include in the response.

参数:

maxResults - The optional maxResults parameter indicating the maximum number of results to include in the response.

另请参阅:

getMaxResults(), withMaxResults(Integer)

withMaxResults

public ListVersionsRequest withMaxResults(Integer maxResults)

Sets the optional maxResults parameter indicating the maximum number of results to include in the response. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

参数:

maxResults - The optional maxResults parameter indicating the maximum number of results to include in the response.

返回:

This ListVersionsRequest, enabling additional method calls to be chained together.

另请参阅:

getMaxResults(), setMaxResults(Integer)

getEncodingType

public String getEncodingType()

Gets the optional encodingType parameter indicating the encoding method to be applied on the response.

返回:

The encoding method to be applied on the response.

setEncodingType

public void setEncodingType(String encodingType)

Sets the optional encodingType parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that COS encode the keys in the response.

参数:

encodingType - The encoding method to be applied on the response. Valid values: null (not encoded) or "url".

withEncodingType

public ListVersionsRequest withEncodingType(String encodingType)

Sets the optional encodingType parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that COS encode the keys in the response. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

参数:

encodingType - The encoding method to be applied on the response. Valid values: null (not encoded) or "url".