|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.baidubce.model.AbstractBceRequest
com.baidubce.services.bos.model.GenericBucketRequest
com.baidubce.services.bos.model.ListObjectsRequest
public class ListObjectsRequest
Contains options to return a list of summary information about the objects in the specified bucket. Depending on the request parameters, additional information is returned, such as common prefixes if a delimiter was specified. List results are always returned in lexicographic (alphabetical) order.
Constructor Summary | |
---|---|
ListObjectsRequest(String bucketName)
Constructs a new ListObjectsRequest object and initializes all required and optional object fields. |
|
ListObjectsRequest(String bucketName,
String prefix)
Constructs a new ListObjectsRequest object and initializes all required and optional object fields. |
Method Summary | |
---|---|
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. |
String |
getMarker()
Gets the optional marker parameter indicating where in the bucket to begin listing. |
int |
getMaxKeys()
Gets the optional maxKeys parameter indicating the maximum number of keys to
include in the response. |
String |
getPrefix()
Gets the optional prefix parameter and restricts the response to keys that begin with the specified prefix. |
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. |
void |
setMarker(String marker)
Sets the optional marker parameter indicating where in the bucket to begin listing. |
void |
setMaxKeys(int maxKeys)
Sets the optional maxKeys parameter indicating the maximum number of keys 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. |
ListObjectsRequest |
withBucketName(String bucketName)
Sets the name of the Baidu Bos bucket whose objects are to be listed. |
ListObjectsRequest |
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 rolled up into a single result element. |
ListObjectsRequest |
withMarker(String marker)
Sets the optional marker parameter indicating where in the bucket to begin listing. |
ListObjectsRequest |
withMaxKeys(int maxKeys)
Sets the optional maxKeys parameter indicating the maximum number of keys to
include in the response. |
ListObjectsRequest |
withPrefix(String prefix)
Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix. |
ListObjectsRequest |
withRequestCredentials(BceCredentials credentials)
|
Methods inherited from class com.baidubce.services.bos.model.GenericBucketRequest |
---|
getBucketName, setBucketName |
Methods inherited from class com.baidubce.model.AbstractBceRequest |
---|
getRequestCredentials, setRequestCredentials |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ListObjectsRequest(String bucketName)
bucketName
- The name of the bucket whose objects are to be listed.public ListObjectsRequest(String bucketName, String prefix)
bucketName
- The name of the bucket whose objects are to be listed.prefix
- The prefix restricting what keys will be listed.Method Detail |
---|
public ListObjectsRequest withRequestCredentials(BceCredentials credentials)
withRequestCredentials
in class AbstractBceRequest
public ListObjectsRequest withBucketName(String bucketName)
withBucketName
in class GenericBucketRequest
bucketName
- The name of the Baidu Bos bucket whose objects are to be listed.
ListObjectsRequest
, enabling additional method calls to be chained together.public String getPrefix()
public void setPrefix(String prefix)
prefix
- The optional prefix parameter, restricting the response to keys
that begin with the specified prefix.public ListObjectsRequest withPrefix(String prefix)
prefix
- The optional prefix parameter restricting the response to keys
that begin with the specified prefix.
public String getMarker()
public void setMarker(String marker)
marker
- The optional marker parameter indicating where in the bucket to begin
listing. The list will only include keys that occur lexicographically after the marker.public ListObjectsRequest withMarker(String marker)
marker
- The optional parameter indicating where in the bucket to begin
listing. The list will only include keys that occur lexicographically after the marker.
public String getDelimiter()
public void setDelimiter(String delimiter)
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.public ListObjectsRequest withDelimiter(String delimiter)
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 rolled up into a single result element.
getDelimiter()
,
setDelimiter(String)
public int getMaxKeys()
maxKeys
parameter indicating the maximum number of keys to
include in the response. Baidu Bos might return fewer keys than specified, but will
never return more. Even if the optional parameter is not specified,
Baidu Bos will limit the number of results in the response.
public void setMaxKeys(int maxKeys)
maxKeys
parameter indicating the maximum number of keys to
include in the response.
maxKeys
- The optional parameter indicating the maximum number of keys to include in the response.public ListObjectsRequest withMaxKeys(int maxKeys)
maxKeys
parameter indicating the maximum number of keys to
include in the response.
Returns this ListObjectsRequest, enabling additional method calls to be chained together.
maxKeys
- The optional parameter indicating the maximum number of keys to include in the response.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |