Class VersionListing
- All Implemented Interfaces:
Serializable
S3VersionSummary
objects describing each version,
information describing if this is a complete or partial listing, and the
original request parameters.- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the name of the Amazon S3 bucket containing the versions listed in thisVersionListing
.Gets the common prefixes included in this version listing.Gets the value of thedelimiter
parameter used to request this version listing.Gets the encoding type used by Amazon S3 to encode object key names in the XML response.The key marker parameter originally used to request this version listing, ornull
if no key marker was specified.int
Gets the value of themaxKeys
parameter used to request this version listing.Gets the key marker to use in the nextlistVersions
request in order to obtain the next page of results.Gets the version ID marker to use in the nextlistVersions
request in order to obtain the next page of results.The prefix parameter originally used to request this version listing, ornull
if no prefix was specified.Gets the value of the version ID marker parameter used to request this version listing.Gets the list of version summaries describing the versions stored in the associated S3 bucket.boolean
Gets whether or not the version listing is complete, indicating if additional calls to Amazon S3 are needed to obtain complete version listing results.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
setKeyMarker
(String keyMarker) For internal use only.void
setMaxKeys
(int maxKeys) For internal use only.void
setNextKeyMarker
(String marker) For internal use only.void
setNextVersionIdMarker
(String marker) For internal use only.void
For internal use only.void
setTruncated
(boolean isTruncated) For internal use only.void
setVersionIdMarker
(String versionIdMarker) For internal use only.void
setVersionSummaries
(List<S3VersionSummary> versionSummaries) For internal use only.
-
Constructor Details
-
VersionListing
public VersionListing()
-
-
Method Details
-
getVersionSummaries
Gets the list of version summaries describing the versions stored in the associated S3 bucket. Callers should remember that listings for large buckets can be truncated for performance reasons, so callers might need to make additional calls toAmazonS3.listVersions(ListVersionsRequest)
to get additional results. Callers should always checkisTruncated()
to determine if a listing is truncated or not.- Returns:
- A list of the version summaries describing the versions stored in the associated S3 bucket.
-
setVersionSummaries
For internal use only. Sets the list of version summaries describing the versions stored in the associated S3 bucket.- Parameters:
versionSummaries
- The version summaries describing the versions stored in the associated S3 bucket.
-
getCommonPrefixes
Gets the common prefixes included in this version 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 version 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 keys:
- "foo/bar/baz"
- "foo/bar/bash"
- "foo/bar/bang"
- "foo/boo"
listVersions
with a prefix value of "foo/" and a delimiter value of "/" on this bucket, the returnedVersionListing
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 version summaries list.- Returns:
- The list of common prefixes included in this version listing. Returns an empty list if no common prefixes are found.
-
setCommonPrefixes
For internal use only. Sets the common prefixes for this version listing, representing the key prefixes that were rolled up because of the request's delimiter parameter.- Parameters:
commonPrefixes
- The common prefixes for this version listing.
-
getBucketName
Gets the name of the Amazon S3 bucket containing the versions listed in thisVersionListing
.- Returns:
- The name of the Amazon S3 bucket containing the versions listed in this S3VersionListing.
-
setBucketName
For internal use only. Sets the name of the Amazon S3 bucket containing the versions listed in this S3VersionListing.- Parameters:
bucketName
- The name of the Amazon S3 bucket containing the versions listed in this S3VersionListing.
-
getPrefix
The prefix parameter originally used to request this version listing, ornull
if no prefix was specified. All object keys included in this version listing start with the specified prefix.- Returns:
- The prefix parameter originally used to request this version
listing, or
null
if no prefix was specified.
-
setPrefix
For internal use only. Sets the prefix parameter originally used to request this version listing.- Parameters:
prefix
- The prefix parameter originally used to request this version listing.
-
getKeyMarker
The key marker parameter originally used to request this version listing, ornull
if no key marker was specified. If specified, all object keys included in this version listing will occur lexically (alphabetically) after the specified key marker.- Returns:
- The key marker parameter originally used to request this version
listing, or
null
if no key marker was specified.
-
setKeyMarker
For internal use only. Sets the key marker parameter originally used to request this version listing.- Parameters:
keyMarker
- The key marker parameter originally used to request this version listing.
-
getVersionIdMarker
Gets the value of the version ID marker parameter used to request this version listing. Returnsnull
if no version ID marker was otherwise specified.- Returns:
- The version ID marker parameter originally used to request this
version listing. Returns
null
if no version ID marker otherwise was specified.
-
setVersionIdMarker
For internal use only. Sets the version ID marker parameter originally used to request this version listing.- Parameters:
versionIdMarker
- The version ID marker parameter originally used to request this version listing.
-
getMaxKeys
public int getMaxKeys()Gets the value of themaxKeys
parameter used to request this version listing. Returns the defaultmaxKeys
value provided by Amazon S3 if no parameter value was otherwise specified.The
maxKeys
parameter limits the number of versions included in this version listing. A version listing will never contain more versions than indicated bymaxKeys
, but can contain less.- Returns:
- The value of the
maxKeys
parameter used to request this version listing. Returns the defaultmaxKeys
value provided by Amazon S3 if no parameter value was otherwise specified.
-
setMaxKeys
public void setMaxKeys(int maxKeys) 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.- Parameters:
maxKeys
- The maxKeys parameter originally used to request this version listing, or the default maxKeys value applied by Amazon S3 if the requester didn't specify a value.
-
getDelimiter
Gets the value of thedelimiter
parameter used to request this version listing. Returnsnull
if no parameter value was otherwise 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; instead, the common prefixes list will have one entry for the common prefix.
- Returns:
- The delimiter parameter originally used to request this version
listing, or
null
if none was specified.
-
setDelimiter
For internal use only. Sets the delimiter parameter originally used to request this version listing.- Parameters:
delimiter
- The delimiter parameter originally used to request this version listing.
-
getNextKeyMarker
Gets the key marker to use in the nextlistVersions
request in order to obtain the next page of results. Returnsnull
if the version listing is not truncated. For truncated requests, this value is equal to the greatest (lexicographically) value of the object keys included in this listing.- Returns:
- The key marker to use in
the next
listVersions
request in order to obtain the next page of results. Returnsnull
if the version listing is not truncated. - See Also:
-
setNextKeyMarker
For internal use only. Sets the key marker to use in the next listVersions request in order to see the next page of results for a truncated version listing.- Parameters:
marker
- The key marker to use in the next listVersions request in order to see the next page of results for a truncated version listing.
-
getNextVersionIdMarker
Gets the version ID marker to use in the nextlistVersions
request in order to obtain the next page of results. Returnsnull
if the version listing is not truncated.- Returns:
- The version ID marker to use in the next
listVersions
request in order to see the next page of results. Returnsnull
if the version listing is not truncated. - See Also:
-
setNextVersionIdMarker
For internal use only. Sets the version ID marker to use in the next listVersions request in order to see the next page of results for a truncated version listing.- Parameters:
marker
- The version ID marker to use in the next listVersions request in order to obtain the next page of results for a truncated version listing.
-
isTruncated
public boolean isTruncated()Gets whether or not the version listing is complete, indicating if additional calls to Amazon S3 are needed to obtain complete version listing results.- Returns:
- The value
true
if this version listing is complete, indicating additional calls to Amazon S3 to Amazon S3 are needed to obtain complete version listing results. Returns the valuefalse
if otherwise.
-
setTruncated
public void setTruncated(boolean isTruncated) For internal use only. Sets the truncated property for this version listing, indicating if this is a complete listing or not and whether the caller needs to make additional calls to S3 to get more version summaries.- Parameters:
isTruncated
- True if this version listing is not complete and the caller needs to make additional S3 calls to get additional version summaries.
-
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:KeyMarker, NextKeyMarker, Prefix, Key, Delimiter
.- 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.
-