Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   *
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   *
   *  http://aws.amazon.com/apache2.0
   *
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.s3.model;
 
Provides options for returning a list of summary information about the versions in a specified bucket.

Returned version summaries are ordered first by key and then by version. Keys are sorted lexicographically (i.e. alphabetically from a-Z) and versions are sorted from the most recent to the least recent. Versions with data and versions with delete markers are included in the results.

Buckets can contain a virtually unlimited number of keys, and the complete results of a list query can be extremely large. To manage large result sets, Amazon S3 uses pagination to split them into multiple responses. Always check the ObjectListing.isTruncated() method to see if the returned listing is complete, or if callers need to make additional calls to get more results. Alternatively, use the com.amazonaws.services.s3.AmazonS3Client.listNextBatchOfVersions(com.amazonaws.services.s3.model.VersionListing) method as an easy way to get the next page of object listings.

Objects created before versioning was enabled or when versioning is suspended will be given the default null version ID (see com.amazonaws.services.s3.internal.Constants.NULL_VERSION_ID). Note that the null version ID is a valid version ID and is not the same as not having a version ID.

Calling setDelimiter(java.lang.String) sets the delimiter, allowing groups of keys that share the delimiter-terminated prefix to be included in the returned listing. This allows applications to organize and browse their keys hierarchically, similar to how a file system organizes files into directories. These common prefixes can be retrieved through the VersionListing.getCommonPrefixes() method.

For example, consider a bucket that contains the following keys:

  • "foo/bar/baz"
  • "foo/bar/bash"
  • "foo/bar/bang"
  • "foo/boo"
If calling listVersions with a prefix value of "foo/" and a delimiter value of "/" on this bucket, an VersionListing is returned that contains one key ("foo/boo") and one entry in the common prefixes list ("foo/bar/"). To see deeper into the virtual hierarchy, make another call to listVersions setting the prefix parameter to any interesting common prefix to list the individual keys under that prefix.

The total number of keys in a bucket doesn't substantially affect list performance, nor does the presence or absence of additional request parameters.

For more information about enabling versioning for a bucket, see com.amazonaws.services.s3.AmazonS3.setBucketVersioningConfiguration(com.amazonaws.services.s3.model.SetBucketVersioningConfigurationRequest).

 
 public class ListVersionsRequest extends AmazonWebServiceRequest {

    
The name of the Amazon S3 bucket whose versions are to be listed.
 
     private String bucketName;

    
Optional parameter restricting the response to keys which begin with the specified prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders.
 
     private String prefix;

    
Optional parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (i.e. alphabetically) and then from most recent version to least recent version. If a keyMarker is used without a versionIdMarker, results begin immediately after that key's last version. When a keyMarker is used with a versionIdMarker, results begin immediately after the version with the specified key and version ID.

This enables pagination; to get the next page of results use the next key marker and next version ID marker (from VersionListing.getNextKeyMarker() and VersionListing.getNextVersionIdMarker()) as the markers for the next request to list versions. Or use the convenience method com.amazonaws.services.s3.AmazonS3.listNextBatchOfVersions(com.amazonaws.services.s3.model.VersionListing)

    private String keyMarker;

    
Optional parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (i.e. alphabetically) and then from most recent version to least recent version. A keyMarker must be specified when specifying a versionIdMarker. Results begin immediately after the version with the specified key and version ID.

This enables pagination; to get the next page of results use the next key marker and next version ID marker (from VersionListing.getNextKeyMarker() and VersionListing.getNextVersionIdMarker()) as the markers for the next request to list versions. Or use the convenience method com.amazonaws.services.s3.AmazonS3.listNextBatchOfVersions(com.amazonaws.services.s3.model.VersionListing)

    private String versionIdMarker;

    
Optional parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the VersionListing.getCommonPrefixes() list. These rolled-up keys are not returned elsewhere in the response. The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.
    private String delimiter;

    
Optional parameter indicating the maximum number of results to include in the response. Amazon S3 might return fewer than this, but will not return more. Even if maxKeys is not specified, Amazon S3 will limit the number of results in the response.
    private Integer maxResults;

    
Optional parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
    private String encodingType;


    
Constructs a new ListVersionsRequest object. The caller must populate the fields before the request is executed.

    public ListVersionsRequest() {}

    
Constructs a new ListVersionsRequest object and initializes all required and optional fields.

Parameters:
bucketName The name of the bucket whose versions are to be listed.
prefix The prefix restricting what keys will be listed.
keyMarker The key marker indicating where results should begin.
versionIdMarker The version ID marker indicating where results should begin.
delimiter The delimiter for condensing common prefixes in returned results.
maxResults The maximum number of results to return.
See also:
ListVersionsRequest.ListVersionsRequest()
    public ListVersionsRequest(String bucketNameString prefixString keyMarkerString versionIdMarkerString delimiterInteger maxResults) {
        setBucketName(bucketName);
        setPrefix(prefix);
        setKeyMarker(keyMarker);
        setVersionIdMarker(versionIdMarker);
        setDelimiter(delimiter);
        setMaxResults(maxResults);
    }


    
Gets the name of the Amazon S3 bucket whose versions are to be listed.

Returns:
The name of the Amazon S3 bucket whose versions are to be listed.
See also:
setBucketName(java.lang.String)
withBucketName(java.lang.String)
    public String getBucketName() {
        return ;
    }

    
Sets the name of the Amazon S3 bucket whose versions are to be listed.

Parameters:
bucketName The name of the Amazon S3 bucket whose versions are to be listed.
See also:
getBucketName()
withBucketName(java.lang.String)
    public void setBucketName(String bucketName) {
        this. = bucketName;
    }

    
Sets the name of the Amazon S3 bucket whose versions are to be listed. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

Parameters:
bucketName The name of the Amazon S3 bucket whose versions are to be listed.
Returns:
This ListVersionsRequest, enabling additional method calls to be chained together.
See also:
getBucketName()
setBucketName(java.lang.String)
    public ListVersionsRequest withBucketName(String bucketName) {
        setBucketName(bucketName);
        return this;
    }

    
Gets the optional prefix parameter restricting the response to keys that begin with the specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to how a file system organizes files into directories.

Returns:
The optional prefix parameter restricting the response to keys that begin with the specified prefix.
See also:
setPrefix(java.lang.String)
withPrefix(java.lang.String)
    public String getPrefix() {
        return ;
    }

    
Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix.

Parameters:
prefix The optional prefix parameter restricting the response to keys that begin with the specified prefix.
See also:
getPrefix()
withPrefix(java.lang.String)
    public void setPrefix(String prefix) {
        this. = prefix;
    }

    
Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

Parameters:
prefix The optional prefix parameter restricting the response to keys that begin with the specified prefix.
Returns:
This ListVersionsRequest, enabling additional method calls to be chained together.
See also:
getPrefix()
setPrefix(java.lang.String)
    public ListVersionsRequest withPrefix(String prefix) {
        setPrefix(prefix);
        return this;
    }

    
Gets the optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (i.e. alphabetically) and then from most recent version to least recent version.

If a keyMarker is used without a version ID marker, results begin immediately after that key's last version. When a keyMarker is used with a version ID marker, results begin immediately after the version with the specified key and version ID.

Returns:
The optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
See also:
setKeyMarker(java.lang.String)
withKeyMarker(java.lang.String)
    public String getKeyMarker() {
        return ;
    }

    
Sets the optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

Parameters:
keyMarker The optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
See also:
getKeyMarker()
withKeyMarker(java.lang.String)
    public void setKeyMarker(String keyMarker) {
        this. = keyMarker;
    }

    
Sets the optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

Parameters:
keyMarker The optional keyMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
Returns:
This ListVersionsRequest, enabling additional method calls to be chained together.
See also:
getKeyMarker()
setKeyMarker(java.lang.String)
    public ListVersionsRequest withKeyMarker(String keyMarker) {
        setKeyMarker(keyMarker);
        return this;
    }

    
Gets the optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (i.e. alphabetically) and then from most recent version to least recent version.

A key marker must be specified when specifying a versionIdMarker. Results begin immediately after the version with the specified key and version ID.

Returns:
The optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
See also:
setVersionIdMarker(java.lang.String)
withVersionIdMarker(java.lang.String)
    public String getVersionIdMarker() {
        return ;
    }

    
Sets the optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

Parameters:
versionIdMarker The optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
See also:
getVersionIdMarker()
withVersionIdMarker(java.lang.String)
    public void setVersionIdMarker(String versionIdMarker) {
        this. = versionIdMarker;
    }

    
Sets the optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

Parameters:
versionIdMarker The optional versionIdMarker parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
Returns:
This ListVersionsRequest, enabling additional method calls to be chained together.
See also:
getVersionIdMarker()
setVersionIdMarker(java.lang.String)
    public ListVersionsRequest withVersionIdMarker(String versionIdMarker) {
        setVersionIdMarker(versionIdMarker);
        return this;
    }

    
Gets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list. These combined keys are not returned elsewhere in the response.

The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.

Returns:
The optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.
See also:
setDelimiter(java.lang.String)
withDelimiter(java.lang.String)
    public String getDelimiter() {
        return ;
    }

    
Sets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.

Parameters:
delimiter The optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.
See also:
getDelimiter()
withDelimiter(java.lang.String)
    public void setDelimiter(String delimiter) {
        this. = delimiter;
    }

    
Sets the optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

Parameters:
delimiter The optional delimiter parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the VersionListing.getCommonPrefixes() list.
Returns:
This ListVersionsRequest, enabling additional method calls to be chained together.
See also:
getDelimiter()
setDelimiter(java.lang.String)
    public ListVersionsRequest withDelimiter(String delimiter) {
        setDelimiter(delimiter);
        return this;
    }

    
Gets the optional maxResults parameter indicating the maximum number of results to include in the response. Amazon S3 might return fewer than this, but will never return more. Even if maxResults is not specified, Amazon S3 will limit the number of results in the response.

Returns:
The optional maxResults parameter indicating the maximum number of results
See also:
setMaxResults(java.lang.Integer)
withMaxResults(java.lang.Integer)
    public Integer getMaxResults() {
        return ;
    }

    
Sets the optional maxResults parameter indicating the maximum number of results to include in the response.

Parameters:
maxResults The optional maxResults parameter indicating the maximum number of results to include in the response.
See also:
getMaxResults()
withMaxResults(java.lang.Integer)
    public void setMaxResults(Integer maxResults) {
        this. = maxResults;
    }

    
Sets the optional maxResults parameter indicating the maximum number of results to include in the response. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

Parameters:
maxResults The optional maxResults parameter indicating the maximum number of results to include in the response.
Returns:
This ListVersionsRequest, enabling additional method calls to be chained together.
See also:
getMaxResults()
setMaxResults(java.lang.Integer)
    public ListVersionsRequest withMaxResults(Integer maxResults) {
        setMaxResults(maxResults);
        return this;
    }

    
Gets the optional encodingType parameter indicating the encoding method to be applied on the response.

Returns:
The encoding method to be applied on the response.
    public String getEncodingType() {
        return ;
    }

    
Sets the optional encodingType parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

Parameters:
encodingType The encoding method to be applied on the response. Valid values: null (not encoded) or "url".
    public void setEncodingType(String encodingType) {
        this. = encodingType;
    }
    
    
Sets the optional encodingType parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. Returns this ListVersionsRequest, enabling additional method calls to be chained together.

Parameters:
encodingType The encoding method to be applied on the response. Valid values: null (not encoded) or "url".
    public ListVersionsRequest withEncodingType(String encodingType) {
        setEncodingType(encodingType);
        return this;
    }
New to GrepCode? Check out our FAQ X