public class VersionListing extends Object implements Serializable, S3RequesterChargedResult
S3VersionSummary
objects describing each version,
information describing if this is a complete or partial listing, and the
original request parameters.Constructor and Description |
---|
VersionListing() |
Modifier and Type | Method and Description |
---|---|
String |
getBucketName()
Gets the name of the Amazon S3 bucket containing the versions listed
in this
VersionListing . |
List<String> |
getCommonPrefixes()
Gets the common prefixes included in this version listing.
|
String |
getDelimiter()
Gets the value of the
delimiter parameter used to request this version
listing. |
String |
getEncodingType()
Gets the encoding type used by Amazon S3 to encode object key names in
the XML response.
|
String |
getKeyMarker()
The key marker parameter originally used to request this version listing,
or
null if no key marker was specified. |
int |
getMaxKeys()
Gets the value of the
maxKeys parameter used to request this version
listing. |
String |
getNextKeyMarker()
Gets the key marker to use in
the next
listVersions request in order to obtain the next page of results. |
String |
getNextVersionIdMarker()
Gets the version ID marker to
use in the next
listVersions request in order to obtain the next page of
results. |
String |
getPrefix()
The prefix parameter originally used to request this version listing, or
null if no prefix was specified. |
String |
getVersionIdMarker()
Gets the value of the version ID marker parameter used to request this version
listing.
|
List<S3VersionSummary> |
getVersionSummaries()
Gets the list of version summaries describing the versions stored in
the associated S3 bucket.
|
boolean |
isRequesterCharged()
Returns true if the user has enabled Requester Pays option when
conducting this operation from Requester Pays Bucket; else false.
|
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.
|
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 |
setPrefix(String prefix)
For internal use only.
|
void |
setRequesterCharged(boolean isRequesterCharged)
Used for conducting this operation from a Requester Pays Bucket.
|
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.
|
public List<S3VersionSummary> getVersionSummaries()
AmazonS3.listVersions(ListVersionsRequest)
to get additional
results. Callers should always check isTruncated()
to
determine if a listing is truncated or not.public void setVersionSummaries(List<S3VersionSummary> versionSummaries)
versionSummaries
- The version summaries describing the versions stored in the
associated S3 bucket.public List<String> getCommonPrefixes()
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:
listVersions
with a prefix value of "foo/" and a delimiter
value of "/" on this
bucket, the returned VersionListing
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.
public void setCommonPrefixes(List<String> commonPrefixes)
commonPrefixes
- The common prefixes for this version listing.public String getBucketName()
VersionListing
.public void setBucketName(String bucketName)
bucketName
- The name of the Amazon S3 bucket containing the versions
listed in this S3VersionListing.public String getPrefix()
null
if no prefix was specified. All object keys included in this version
listing start with the specified prefix.null
if no prefix was specified.public void setPrefix(String prefix)
prefix
- The prefix parameter originally used to request this version
listing.public String getKeyMarker()
null
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.null
if no key marker was specified.public void setKeyMarker(String keyMarker)
keyMarker
- The key marker parameter originally used to request this
version listing.public String getVersionIdMarker()
null
if no version ID marker was otherwise specified.null
if no version ID marker otherwise was specified.public void setVersionIdMarker(String versionIdMarker)
versionIdMarker
- The version ID marker parameter originally used to request
this version listing.public int getMaxKeys()
maxKeys
parameter used to request this version
listing. Returns the default maxKeys
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 by maxKeys
, but can
contain less.
maxKeys
parameter used to request this version
listing. Returns the default maxKeys
value provided by Amazon S3 if no
parameter value was otherwise specified.public void setMaxKeys(int maxKeys)
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.public String getDelimiter()
delimiter
parameter used to request this version
listing. Returns null
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.
null
if none was specified.public void setDelimiter(String delimiter)
delimiter
- The delimiter parameter originally used to request this
version listing.public String getNextKeyMarker()
listVersions
request in order to obtain the next page of results.
Returns null
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.listVersions
request in order to obtain the next page of results.
Returns null
if the version listing is not truncated.isTruncated()
public void setNextKeyMarker(String marker)
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.public String getNextVersionIdMarker()
listVersions
request in order to obtain the next page of
results. Returns null
if the version listing is not truncated.listVersions
request in
order to see the next page of results.
Returns null
if the version listing is not truncated.isTruncated()
public void setNextVersionIdMarker(String marker)
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.public boolean isTruncated()
true
if this version listing is not complete, indicating
additional calls to Amazon S3 are needed to obtain
complete version listing results. Returns the value false
if otherwise.public void setTruncated(boolean isTruncated)
isTruncated
- True if this version listing is not complete and the
caller needs to make additional S3 calls to get additional
version summaries.public String getEncodingType()
encodingType
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
.Null
if encodingType
is not specified
in the request parameter.public void setEncodingType(String encodingType)
encodingType
- Null
if encodingType
is not
specified in the request parameter.public boolean isRequesterCharged()
S3RequesterChargedResult
If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket
isRequesterCharged
in interface S3RequesterChargedResult
public void setRequesterCharged(boolean isRequesterCharged)
S3RequesterChargedResult
If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
setRequesterCharged
in interface S3RequesterChargedResult
isRequesterCharged
- Indicates requester is charged for this operation.