com.amazonaws.services.s3.model
Class ObjectListing

java.lang.Object
  com.amazonaws.services.s3.model.ObjectListing

public class ObjectListing
extends Object

Contains the results of listing the objects in an Amazon S3 bucket, including a list of S3ObjectSummary objects describing the objects stored in the bucket, a list of common prefixes (if a delimiter was specified in the request), as well as information describing if this is a complete or partial listing and the the original request parameters.

See Also:

AmazonS3.listObjects(String, String), AmazonS3.listObjects(ListObjectsRequest), AmazonS3.listNextBatchOfObjects(ObjectListing)

Constructor Summary

ObjectListing()

Method Summary

String	getBucketName() Returns the name of the Amazon S3 bucket containing the objects listed in this S3ObjectListing.
List<String>	getCommonPrefixes() Returns the common prefixes included in this object listing.
String	getDelimiter() Returns the delimiter parameter originally used to request this object listing, or null if none was specified.
String	getMarker() The marker parameter originally used to request this object listing, or null if no marker was specified.
int	getMaxKeys() Returns the maxKeys parameter originally used to request this object listing, or the default maxKeys value provided by Amazon S3 if the requester didn't specify a value.
String	getNextMarker() For truncated object listings (see isTruncated()) returns the marker to use in the next listObjects request in order to see the next page of results.
List<S3ObjectSummary>	getObjectSummaries() Returns the list of object summaries describing the objects stored in the S3 bucket.
String	getPrefix() The prefix parameter originally used to request this object listing, or null if no prefix was specified.
boolean	isTruncated() Returns true if this object listing is not complete and indicates that the caller needs to make additional calls to Amazon S3 to get more results.
void	setBucketName(String bucketName) Not intended for direct use by callers.
void	setCommonPrefixes(List<String> commonPrefixes) Not intended for direct use by callers.
void	setDelimiter(String delimiter) Not intended for direct use by callers.
void	setMarker(String marker) Not intended for direct use by callers.
void	setMaxKeys(int maxKeys) Not intended for direct use by callers.
void	setNextMarker(String nextMarker) Not intended for direct use by callers.
void	setPrefix(String prefix) Not intended for direct use by callers.
void	setTruncated(boolean isTruncated) Not intended for direct use by callers.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectListing

public ObjectListing()

Method Detail

getObjectSummaries

public List<S3ObjectSummary> getObjectSummaries()

Returns the list of object summaries describing the objects stored in the S3 bucket. Callers should remember that listings for large buckets can be truncated for performance reasons, so callers might need to make additional calls to AmazonS3.listNextBatchOfObjects(ObjectListing) to get additional results. Callers should always check the isTruncated() method to determine if a listing is truncated or not.

Returns:

A list of the object summaries describing the objects stored in the S3 bucket.

getCommonPrefixes

public List<String> getCommonPrefixes()

Returns 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, much like how you would organize your files into directories in a file system.

For example, consider a bucket that contains the keys:

• "foo/bar/baz"
• "foo/bar/bash"
• "foo/bar/bang"
• "foo/boo"

If you call listObjects with prefix="foo/" and 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.

Returns:

The list of common prefixes included in this object listing, which might be an empty list if no common prefixes were found.

setCommonPrefixes

public void setCommonPrefixes(List<String> commonPrefixes)

Not intended for direct use by callers. 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

public String getNextMarker()

For truncated object listings (see isTruncated()) returns the marker to use in the next listObjects request in order to see the next page of results. If an object listing is not truncated, this method will return null since there is no need for a next marker. For truncated requests, this value is equal to the greatest (lexicographically) 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, otherwise null if this object listing isn't truncated.

setNextMarker

public void setNextMarker(String nextMarker)

Not intended for direct use by callers. Sets the marker to use in the next listObjects 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

public String getBucketName()

Returns the name of the Amazon S3 bucket containing the objects listed in this S3ObjectListing.

Returns:

The name of the Amazon S3 bucket containing the objects listed in this S3ObjectListing.

setBucketName

public void setBucketName(String bucketName)

Not intended for direct use by callers. 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

public String getPrefix()

The prefix parameter originally used to request this object listing, or null 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, or null if no prefix was specified.

setPrefix

public void setPrefix(String prefix)

Not intended for direct use by callers. Sets the prefix parameter originally used to request this object listing.

Parameters:

prefix - The prefix parameter originally used to request this object listing.

getMarker

public String getMarker()

The marker parameter originally used to request this object listing, or null if no marker was specified. If specified, all objects and common prefixes included in this object listing will occur lexically (alphabetically) after the specified marker.

Returns:

The marker parameter originally used to request this object listing, or null if no marker was specified.

setMarker

public void setMarker(String marker)

Not intended for direct use by callers. 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()

Returns the maxKeys parameter originally used to request this object listing, or the default maxKeys value provided by Amazon S3 if the requester didn't specify a value. The maxKeys 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 the maxKeys, but can of course contain less.

Returns:

The maxKeys parameter originally used to request this object listing, or the default maxKeys value applied by Amazon S3 if the requester didn't specify a value.

setMaxKeys

public void setMaxKeys(int maxKeys)

Not intended for direct use by callers. Sets the maxKeys 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 - he maxKeys parameter originally used to request this object listing, or the default maxKeys value applied by Amazon S3 if the requester didn't specify a value.

getDelimiter

public String getDelimiter()

Returns the delimiter parameter originally used to request this object listing, or null if none was 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), then 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, but instead, the common prefixes list will have one entry for the common prefix.

Returns:

The delimiter parameter originally used to request this object listing, or null if none was specified.

setDelimiter

public void setDelimiter(String delimiter)

Not intended for direct use by callers. 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()

Returns true if this object listing is not complete and indicates that the caller needs to make additional calls to Amazon S3 to get more results.

Returns:

True if this object listing is not complete and indicates that the caller needs to make additional calls to Amazon S3 to get additional object summaries or common prefixes.

setTruncated

public void setTruncated(boolean isTruncated)

Not intended for direct use by callers. 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 - True if this object listing is not complete and the caller needs to make additional S3 calls to get additional object summaries or common prefixes.