com.netease.cloud.services.nos.model
public class ListObjectsRequest extends WebServiceRequest
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.
Buckets can contain a virtually unlimited number of keys, and the complete
results of a list query can be extremely large. To manage large result sets,
Nos uses pagination to split them into multiple responses. Always check the
ObjectListing.isTruncated()
method to see if the returned listing is
complete, or if callers need to make additional calls to get more results.
Calling setDelimiter(String)
sets the delimiter,
allowing groups of keys that share the delimiter-terminated prefix to be
included in the returned listing. This allows applications to organize and
browse their keys hierarchically, similar to how a file system organizes
files into directories. These common prefixes can be retrieved through the
ObjectListing.getCommonPrefixes()
method.
For example, consider a bucket that contains the following keys:
listObjects
with a prefix value of "foo/" and a
delimiter value of "/" on this bucket, an ObjectListing
is
returned that contains one key ("foo/boo") and one entry in the common
prefixes list ("foo/bar/"). To see deeper into the virtual hierarchy, make
another call to listObjects
setting the prefix parameter to any
interesting common prefix to list the individual keys under that prefix.
The total number of keys in a bucket doesn't substantially affect list performance, nor does the presence or absence of additional request parameters.
logID, logSeq
Constructor and Description |
---|
ListObjectsRequest()
Constructs a new
ListObjectsRequest object. |
ListObjectsRequest(String bucketName,
String prefix,
String marker,
String delimiter,
Integer maxKeys)
Constructs a new
ListObjectsRequest object and initializes all
required and optional object fields. |
Modifier and Type | Method and Description |
---|---|
String |
getBucketName()
Gets the name of the Nos bucket whose objects 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
ObjectListing.getCommonPrefixes() list. |
String |
getMarker()
Gets the optional marker parameter indicating where in the bucket to
begin listing.
|
Integer |
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 |
setBucketName(String bucketName)
Sets the name of the Nos bucket whose objects 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
ObjectListing.getCommonPrefixes() list. |
void |
setMarker(String marker)
Sets the optional marker parameter indicating where in the bucket to
begin listing.
|
void |
setMaxKeys(Integer 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 Nos 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 in the
ObjectListing.getCommonPrefixes() list. |
ListObjectsRequest |
withMarker(String marker)
Sets the optional marker parameter indicating where in the bucket to
begin listing.
|
ListObjectsRequest |
withMaxKeys(Integer 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.
|
addSpecialHeader, copyPrivateRequestParameters, getAndIncrementLogSeq, getLogID, getLogSeq, getRequestClientOptions, getRequestCredentials, getToken, needSetLogInfo, setLogID, setLogSeq, setRequestCredentials, setToken
public ListObjectsRequest()
ListObjectsRequest
object. The caller must
populate the object fields before the request is ready to be executed.public ListObjectsRequest(String bucketName, String prefix, String marker, String delimiter, Integer maxKeys)
ListObjectsRequest
object and initializes all
required and optional object fields.bucketName
- The name of the bucket whose objects are to be listed.prefix
- The prefix restricting what keys will be listed.marker
- The key marker indicating where listing results should begin.delimiter
- The delimiter for condensing common prefixes in the returned
listing results.maxKeys
- The maximum number of results to return.ListObjectsRequest()
public String getBucketName()
setBucketName(String)
,
withBucketName(String)
public void setBucketName(String bucketName)
bucketName
- The name of the Nos bucket whose objects are to be listed.getBucketName()
,
withBucketName(String)
public ListObjectsRequest withBucketName(String bucketName)
ListObjectsRequest
, enabling additional method calls to be
chained together.bucketName
- The name of the Nos bucket whose objects are to be listed.ListObjectsRequest
, enabling additional method calls
to be chained together.getBucketName()
,
setBucketName(String)
public String getPrefix()
setPrefix(String)
public void setPrefix(String prefix)
prefix
- The optional prefix parameter, restricting the response to
keys that begin with the specified prefix.getPrefix()
public ListObjectsRequest withPrefix(String prefix)
ListObjectsRequest
,
enabling additional method calls to be chained together.prefix
- The optional prefix parameter restricting the response to keys
that begin with the specified prefix.ListObjectsRequest
, enabling additional method calls
to be chained together.getPrefix()
,
setPrefix(String)
public String getMarker()
setMarker(String)
,
withMarker(String)
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.getMarker()
,
withMarker(String)
public ListObjectsRequest withMarker(String marker)
ListObjectsRequest
, enabling
additional method calls to be chained together. The list will only
include keys that occur lexicographically after the 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.ListObjectsRequest
, enabling additional method calls
to be chained together.getMarker()
,
setMarker(String)
public String getDelimiter()
ObjectListing.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.ObjectListing.getCommonPrefixes()
list.setDelimiter(String)
,
withDelimiter(String)
public void setDelimiter(String delimiter)
ObjectListing.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 ObjectListing.getCommonPrefixes()
list.getDelimiter()
,
withDelimiter(String)
public ListObjectsRequest withDelimiter(String delimiter)
ObjectListing.getCommonPrefixes()
list. Returns this
ListObjectsRequest
, 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 rolled up into a single result element in
the ObjectListing.getCommonPrefixes()
list.ListObjectsRequest
, enabling additional method calls
to be chained together.getDelimiter()
,
setDelimiter(String)
public Integer getMaxKeys()
maxKeys
parameter indicating the maximum
number of keys to include in the response. Nos might return fewer keys
than specified, but will never return more. Even if the optional
parameter is not specified, Nos will limit the number of results in the
response.setMaxKeys(Integer)
,
withMaxKeys(Integer)
public void setMaxKeys(Integer 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.getMaxKeys()
,
withMaxKeys(Integer)
public ListObjectsRequest withMaxKeys(Integer 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.ListObjectsRequest
, enabling additional method calls
to be chained together.getMaxKeys()
,
setMaxKeys(Integer)
Copyright © 2017. All Rights Reserved.