Class ObjectListing
- All Implemented Interfaces:
Serializable
S3ObjectSummary
objects describing the objects stored in
the bucket, a list of common prefixes if a delimiter was specified in the
request, information describing if this is a complete or partial
listing, and the original request parameters.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the name of the Amazon S3 bucket containing the objects listed in thisObjectListing
.Gets the common prefixes included in this object listing.Gets the delimiter parameter originally used to request this object listing, ornull
if no delimiter specified.Gets the encoding type used by Amazon S3 to encode object key names in the XML response.Gets the marker parameter originally used to request this object listing, ornull
if no marker was specified.int
Gets themaxKeys
parameter originally used to request this object listing, or the defaultmaxKeys
value provided by Amazon S3 if the requester didn't specify a value.Gets the marker to use in the nextlistObjects
request in order to see the next page of results.Gets the list of object summaries describing the objects stored in the S3 bucket.Gets the prefix parameter originally used to request this object listing, ornull
if no prefix was specified.boolean
Gets whether or not this object listing is complete.void
setBucketName
(String bucketName) For internal use only.void
setCommonPrefixes
(List<String> commonPrefixes) For internal use only.void
setDelimiter
(String delimiter) For internal use only.void
setEncodingType
(String encodingType) For internal use only.void
For internal use only.void
setMaxKeys
(int maxKeys) For internal use only.void
setNextMarker
(String nextMarker) For internal use only.void
For internal use only.void
setTruncated
(boolean isTruncated) For internal use only.
-
Constructor Details
-
ObjectListing
public ObjectListing()
-
-
Method Details
-
getObjectSummaries
Gets the list of object summaries describing the objects stored in the S3 bucket. Listings for large buckets can be truncated for performance reasons. Always check theisTruncated()
method to see if the returned listing is complete or if additional calls are needed to get more results. Callers might need to make additional calls toAmazonS3.listNextBatchOfObjects(ObjectListing)
to get additional results.- Returns:
- A list of the object summaries describing the objects stored in the S3 bucket.
-
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:
- "foo/bar/baz"
- "foo/bar/bash"
- "foo/bar/bang"
- "foo/boo"
listObjects
with the prefix="foo/" and the delimiter="/" on this bucket, the returnedS3ObjectListing
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.- Returns:
- The list of common prefixes included in this object listing, which might be an empty list if no common prefixes were found.
-
setCommonPrefixes
For internal use only. Sets the common prefixes for this object listing, representing the key prefixes that were rolled up because of the request's delimiter parameter.- Parameters:
commonPrefixes
- The common prefixes for this object listing.
-
getNextMarker
Gets the marker to use in the nextlistObjects
request in order to see the next page of results. If an object listing is not truncated, this method will returnnull
. For truncated requests, this value is equal to the greatest lexicographical value of the object keys and common prefixes included in this listing.- Returns:
- The marker to use in the next
listObjects
request in order to see the next page of results if this object listing is truncated. Returnsnull
if this object listing isn't truncated.
-
setNextMarker
For internal use only. Sets the marker to use in the next list objects request in order to see the next page of results for a truncated object listing.- Parameters:
nextMarker
- The marker to use in the next listObjects request in order to see the next page of results for a truncated object listing.
-
getBucketName
Gets the name of the Amazon S3 bucket containing the objects listed in thisObjectListing
.- Returns:
- The name of the Amazon S3 bucket containing the objects listed in
this
ObjectListing
.
-
setBucketName
For internal use only. Sets the name of the Amazon S3 bucket containing the objects listed in this S3ObjectListing.- Parameters:
bucketName
- The name of the Amazon S3 bucket containing the objects listed in this S3ObjectListing.
-
getPrefix
Gets the prefix parameter originally used to request this object listing, ornull
if no prefix was specified. All objects and common prefixes included in this object listing start with the specified prefix.- Returns:
- The prefix parameter originally used to request this object
listing. Returns
null
if no prefix was specified.
-
setPrefix
For internal use only. Sets the prefix parameter originally used to request this object listing.- Parameters:
prefix
- The prefix parameter originally used to request this object listing.
-
getMarker
Gets the marker parameter originally used to request this object listing, ornull
if no marker was specified. If specified, all objects and common prefixes included in this object listing will occur alphabetically after the specified marker.- Returns:
- The marker parameter originally used to request this object
listing. Returns
null
if no marker was specified.
-
setMarker
For internal use only. Sets the marker parameter originally used to request this object listing.- Parameters:
marker
- The marker parameter originally used to request this object listing.
-
getMaxKeys
public int getMaxKeys()Gets themaxKeys
parameter originally used to request this object listing, or the defaultmaxKeys
value provided by Amazon S3 if the requester didn't specify a value. ThemaxKeys
parameter limits the combined number of objects and common prefixes included in this object listing. An object listing will never contain more objects plus common prefixes than indicated by themaxKeys
, but can of course contain less.- Returns:
- The
maxKeys
parameter originally used to request this object listing. Returns the defaultmaxKeys
value applied by Amazon S3 if no value was specified.
-
setMaxKeys
public void setMaxKeys(int maxKeys) For internal use only. Sets themaxKeys
parameter originally used to request this object listing, or the default maxKeys applied by Amazon S3 if the requester didn't specify a value.- Parameters:
maxKeys
- ThemaxKeys
parameter originally used to request this object listing, or the defaultmaxKeys
value applied by Amazon S3 if the requester didn't specify a value.
-
getDelimiter
Gets the delimiter parameter originally used to request this object listing, ornull
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.
- Returns:
- The delimiter parameter originally used to request this object
listing. Returns
null
if no delimiter was specified.
-
setDelimiter
For internal use only. Sets the delimiter parameter originally used to request this object listing.- Parameters:
delimiter
- The delimiter parameter originally used to request this object listing.
-
isTruncated
public boolean isTruncated()Gets whether or not this object listing is complete.- Returns:
- The value
true
if the object listing is not complete. Returns the valuefalse
if otherwise. When returningtrue
, additional calls to Amazon S3 may be needed in order to obtain more results.
-
setTruncated
public void setTruncated(boolean isTruncated) For internal use only. Sets the truncated property for this object listing, indicating if this is a complete listing or not and whether the caller needs to make additional calls to S3 to get more object summaries.- Parameters:
isTruncated
- The valuetrue
if the object listing is not complete. The valuefalse
if otherwise.
-
getEncodingType
Gets the encoding type used by Amazon S3 to encode object key names in the XML response. If you specifyencodingType
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
.- Returns:
Null
ifencodingType
is not specified in the request parameter.
-
setEncodingType
For internal use only. Sets the encoding type used by Amazon S3 to encode object key names in the XML response.- Parameters:
encodingType
-Null
ifencodingType
is not specified in the request parameter.
-