public class ListObjectsV2Result
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
bucketName
The name of the Amazon S3 bucket containing the listed objects
|
private java.util.List<java.lang.String> |
commonPrefixes
A list of the common prefixes included in this object listing - common
prefixes will only be populated for requests that specified a delimiter
|
private java.lang.String |
continuationToken
Optional parameter which allows list to be continued from a specific point.
|
private java.lang.String |
delimiter
The delimiter parameter originally specified by the caller when this
object listing was returned
|
private java.lang.String |
encodingType
The encodingType parameter originally specified by the caller when this
object listing was returned.
|
private boolean |
isTruncated
Indicates if this is a complete listing, or if the caller needs to make
additional requests to Amazon S3 to see the full object listing for an S3
bucket
|
private int |
keyCount
KeyCount is the number of keys returned with this response
|
private int |
maxKeys
The maxKeys parameter originally specified by the caller when this object
listing was returned
|
private java.lang.String |
nextContinuationToken
NextContinuationToken is sent when isTruncated is true meaning there are
more keys in the bucket that can be listed.
|
private java.util.List<S3ObjectSummary> |
objectSummaries
A list of summary information describing the objects stored in the bucket
|
private java.lang.String |
prefix
The prefix parameter originally specified by the caller when this object
listing was returned
|
private java.lang.String |
startAfter
Optional parameter indicating where you want Amazon S3 to start the object listing
from.
|
Constructor and Description |
---|
ListObjectsV2Result() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBucketName()
Gets the name of the Amazon S3 bucket containing the objects listed in
this
ListObjectsV2Result . |
java.util.List<java.lang.String> |
getCommonPrefixes()
Gets the common prefixes included in this object listing.
|
java.lang.String |
getContinuationToken()
Gets the optional continuation token.
|
java.lang.String |
getDelimiter()
Gets the delimiter parameter originally used to request this object
listing, or
null if no delimiter specified. |
java.lang.String |
getEncodingType()
Gets the encoding type used by Amazon S3 to encode object key names in
the XML response.
|
int |
getKeyCount()
Gets the number of keys returned with this response.
|
int |
getMaxKeys()
Gets the optional
maxKeys parameter indicating the maximum number of keys to
include in the response. |
java.lang.String |
getNextContinuationToken()
Gets the optional NextContinuationToken.
|
java.util.List<S3ObjectSummary> |
getObjectSummaries()
Gets the list of object summaries describing the objects stored in the
S3 bucket.
|
java.lang.String |
getPrefix()
Gets the prefix parameter originally used to request this object listing, or
null if no prefix was specified. |
java.lang.String |
getStartAfter()
Returns optional parameter indicating where you want Amazon S3 to start the object
listing from.
|
boolean |
isTruncated()
Gets whether or not this object listing is complete.
|
void |
setBucketName(java.lang.String bucketName)
For internal use only.
|
void |
setCommonPrefixes(java.util.List<java.lang.String> commonPrefixes)
For internal use only.
|
void |
setContinuationToken(java.lang.String continuationToken)
Sets the optional continuation token.
|
void |
setDelimiter(java.lang.String delimiter)
For internal use only.
|
void |
setEncodingType(java.lang.String encodingType)
For internal use only.
|
void |
setKeyCount(int keyCount)
Sets the number of keys returned with this response.
|
void |
setMaxKeys(int maxKeys)
Sets the optional
maxKeys parameter indicating the maximum number of keys to
include in the response. |
void |
setNextContinuationToken(java.lang.String nextContinuationToken)
Sets the optional NextContinuationToken.
|
void |
setPrefix(java.lang.String prefix)
For internal use only.
|
void |
setStartAfter(java.lang.String startAfter)
Sets the optional parameter indicating where you want Amazon S3 to start the object
listing from.
|
void |
setTruncated(boolean isTruncated)
For internal use only.
|
private java.util.List<S3ObjectSummary> objectSummaries
private java.util.List<java.lang.String> commonPrefixes
private boolean isTruncated
private java.lang.String bucketName
private int keyCount
private java.lang.String nextContinuationToken
private java.lang.String prefix
private java.lang.String delimiter
private int maxKeys
private java.lang.String encodingType
private java.lang.String continuationToken
private java.lang.String startAfter
public boolean isTruncated()
true
if the object listing is not complete.
Returns the value false
if otherwise.
When returning true
,
additional calls to Amazon S3 may be needed in order to
obtain more results.public void setTruncated(boolean isTruncated)
isTruncated
- The value true
if the object listing is not complete.
The value false
if otherwise.public java.lang.String getBucketName()
ListObjectsV2Result
.ListObjectsV2Result
.public void setBucketName(java.lang.String bucketName)
ListObjectsV2Result
.bucketName
- The name of the Amazon S3 bucket containing the objects listed
in this ListObjectsV2Result
.public java.lang.String getPrefix()
null
if no prefix was specified.
All objects and common prefixes included
in this object listing start with the specified prefix.null
if no prefix was specified.public void setPrefix(java.lang.String prefix)
prefix
- The prefix parameter originally used to request this object
listing.public java.lang.String getDelimiter()
null
if no delimiter specified.
The delimiter value allows callers to condense S3 keys into common prefix listings. For example, if a caller specifies a delimiter of "/" (a common used value for delimiter), any keys that contain a common prefix between the start of the key and the first occurrence of "/" will not be included in the list of object summaries. Instead, the common prefixes list will have one entry for the common prefix.
null
if no delimiter was specified.public void setDelimiter(java.lang.String delimiter)
delimiter
- The delimiter parameter originally used to request this object
listing.public java.lang.String getEncodingType()
encodingType
request
parameter, Amazon S3 includes this element in the response, and returns
encoded key name values in the following response elements:
Delimiter, Marker, Prefix,
NextMarker, Key
.Null
if encodingType
is not specified
in the request parameter.public void setEncodingType(java.lang.String encodingType)
encodingType
- Null
if encodingType
is not
specified in the request parameter.public java.lang.String getContinuationToken()
public void setContinuationToken(java.lang.String continuationToken)
continuationToken
- The optional continuation token to associate with this request.public java.lang.String getNextContinuationToken()
public void setNextContinuationToken(java.lang.String nextContinuationToken)
nextContinuationToken
- The optional NextContinuationToken parameter to associate with this request.public int getKeyCount()
public void setKeyCount(int keyCount)
keyCount
- The number of keys that were returned with this response.public int getMaxKeys()
maxKeys
parameter indicating the maximum number of keys to
include in the response. Amazon S3 might return fewer keys than specified, but will
never return more. Even if the optional parameter is not specified,
Amazon S3 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 java.lang.String getStartAfter()
public void setStartAfter(java.lang.String startAfter)
startAfter
- The optional startAfter parameter. This can be any key in the bucket.public java.util.List<S3ObjectSummary> getObjectSummaries()
isTruncated()
method to see if the returned
listing is complete or if additional calls are needed to get
more results. Callers can pass the nextContinuationToken into subsequent
requests to get additional results.public java.util.List<java.lang.String> getCommonPrefixes()
Gets the common prefixes included in this object listing. Common prefixes are only present if a delimiter was specified in the original request.
Each common prefix represents a set of keys in the S3 bucket that have been condensed and omitted from the object summary results. This allows applications to organize and browse their keys hierarchically, similar to how a file system organizes files into directories.
For example, consider a bucket that contains the following keys:
listObjects
with the prefix="foo/" and the delimiter="/" on
this bucket, the returned S3ObjectListing
will contain one entry in the common
prefixes list ("foo/bar/") and none of the keys beginning with that
common prefix will be included in the object summaries list.public void setCommonPrefixes(java.util.List<java.lang.String> commonPrefixes)
commonPrefixes
- The common prefixes for this object listing.