ObjectListing

The name of the Amazon S3 bucket containing the listed objects

A list of the common prefixes included in this object listing - common prefixes will only be populated for requests that specified a delimiter

The delimiter parameter originally specified by the caller when this object listing was returned

The encodingType parameter originally specified by the caller when this object listing was returned.

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

The marker parameter originally specified by the caller when this object listing was returned

The maxKeys parameter originally specified by the caller when this object listing was returned

The marker to use in order to request the next page of results - only populated if the isTruncated member indicates that this object listing is truncated

A list of summary information describing the objects stored in the bucket

The prefix parameter originally specified by the caller when this object listing was returned

Gets the name of the Amazon S3 bucket containing the objects listed in this ObjectListing.

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"

Gets the delimiter parameter originally used to request this object listing, or 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.

Gets the encoding type used by Amazon S3 to encode object key names in the XML response. If you specify 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.

Gets 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 alphabetically after the specified marker.

Gets 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.

Gets 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. For truncated requests, this value is equal to the greatest lexicographical value of the object keys and common prefixes included in this listing.

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 the isTruncated() 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 to listNextBatchOfObjects(ObjectListing) to get additional results.

Gets 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.

Gets whether or not this object listing is complete.

For internal use only. Sets the name of the Amazon S3 bucket containing the objects listed in this S3ObjectListing.

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.

For internal use only. Sets the delimiter parameter originally used to request this object listing.

For internal use only. Sets the encoding type used by Amazon S3 to encode object key names in the XML response.

For internal use only. Sets the marker parameter originally used to request this object listing.

For internal use only. 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.

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.

For internal use only. Sets the prefix parameter originally used to request this object listing.

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.