com.amazonaws.services.s3.model

## クラス ListVersionsRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.s3.model.ListVersionsRequest

-     public class ListVersionsRequest
      extends AmazonWebServiceRequest

  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 `AmazonS3Client.listNextBatchOfVersions(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 `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(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 `AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)`.

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `ListVersionsRequest()` Constructs a new `ListVersionsRequest` object.
    `ListVersionsRequest(java.lang.String bucketName, java.lang.String prefix, java.lang.String keyMarker, java.lang.String versionIdMarker, java.lang.String delimiter, java.lang.Integer maxResults)` Constructs a new `ListVersionsRequest` object and initializes all required and optional fields.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `java.lang.String` | `getBucketName()` Gets the name of the Amazon S3 bucket whose versions are to be listed.
    `java.lang.String` | `getDelimiter()` 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.
    `java.lang.String` | `getKeyMarker()` Gets the optional `keyMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
    `java.lang.Integer` | `getMaxResults()` Gets the optional `maxResults` parameter indicating the maximum number of results to include in the response.
    `java.lang.String` | `getPrefix()` Gets the optional prefix parameter restricting the response to keys that begin with the specified prefix.
    `java.lang.String` | `getVersionIdMarker()` Gets the optional `versionIdMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
    `void` | `setBucketName(java.lang.String bucketName)` Sets the name of the Amazon S3 bucket whose versions are to be listed.
    `void` | `setDelimiter(java.lang.String 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.
    `void` | `setKeyMarker(java.lang.String keyMarker)` Sets the optional `keyMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
    `void` | `setMaxResults(java.lang.Integer maxResults)` Sets the optional `maxResults` parameter indicating the maximum number of results to include in the response.
    `void` | `setPrefix(java.lang.String prefix)` Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix.
    `void` | `setVersionIdMarker(java.lang.String versionIdMarker)` Sets the optional `versionIdMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
    `ListVersionsRequest` | `withBucketName(java.lang.String bucketName)` Sets the name of the Amazon S3 bucket whose versions are to be listed.
    `ListVersionsRequest` | `withDelimiter(java.lang.String 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.
    `ListVersionsRequest` | `withKeyMarker(java.lang.String keyMarker)` Sets the optional `keyMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
    `ListVersionsRequest` | `withMaxResults(java.lang.Integer maxResults)` Sets the optional `maxResults` parameter indicating the maximum number of results to include in the response.
    `ListVersionsRequest` | `withPrefix(java.lang.String prefix)` Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix.
    `ListVersionsRequest` | `withVersionIdMarker(java.lang.String versionIdMarker)` Sets the optional `versionIdMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### ListVersionsRequest

          public ListVersionsRequest()

      Constructs a new `ListVersionsRequest` object. The caller must populate the fields before the request is executed.
      関連項目:
        `ListVersionsRequest(String, String, String, String, String, Integer)`

    - #### ListVersionsRequest

          public ListVersionsRequest(java.lang.String bucketName,
                             java.lang.String prefix,
                             java.lang.String keyMarker,
                             java.lang.String versionIdMarker,
                             java.lang.String delimiter,
                             java.lang.Integer maxResults)

      Constructs a new `ListVersionsRequest` object and initializes all required and optional fields.
      パラメータ:
        `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.
      関連項目:
        `ListVersionsRequest()`

  - ### メソッドの詳細

    - #### getBucketName

          public java.lang.String getBucketName()

      Gets the name of the Amazon S3 bucket whose versions are to be listed.
      戻り値:
        The name of the Amazon S3 bucket whose versions are to be listed.
      関連項目:
        `setBucketName(String)`, `withBucketName(String)`

    - #### setBucketName

          public void setBucketName(java.lang.String bucketName)

      Sets the name of the Amazon S3 bucket whose versions are to be listed.
      パラメータ:
        `bucketName` - The name of the Amazon S3 bucket whose versions are to be listed.
      関連項目:
        `getBucketName()`, `withBucketName(String)`

    - #### withBucketName

          public ListVersionsRequest withBucketName(java.lang.String 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.
      パラメータ:
        `bucketName` - The name of the Amazon S3 bucket whose versions are to be listed.
      戻り値:
        This `ListVersionsRequest`, enabling additional method calls to be chained together.
      関連項目:
        `getBucketName()`, `setBucketName(String)`

    - #### getPrefix

          public java.lang.String getPrefix()

      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.
      戻り値:
        The optional prefix parameter restricting the response to keys that begin with the specified prefix.
      関連項目:
        `setPrefix(String)`, `withPrefix(String)`

    - #### setPrefix

          public void setPrefix(java.lang.String prefix)

      Sets the optional prefix parameter restricting the response to keys that begin with the specified prefix.
      パラメータ:
        `prefix` - The optional prefix parameter restricting the response to keys that begin with the specified prefix.
      関連項目:
        `getPrefix()`, `withPrefix(String)`

    - #### withPrefix

          public ListVersionsRequest withPrefix(java.lang.String 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.
      パラメータ:
        `prefix` - The optional prefix parameter restricting the response to keys that begin with the specified prefix.
      戻り値:
        This `ListVersionsRequest`, enabling additional method calls to be chained together.
      関連項目:
        `getPrefix()`, `setPrefix(String)`

    - #### getKeyMarker

          public java.lang.String getKeyMarker()

      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.

      戻り値:
        The optional `keyMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
      関連項目:
        `setKeyMarker(String)`, `withKeyMarker(String)`

    - #### setKeyMarker

          public void setKeyMarker(java.lang.String keyMarker)

      Sets the optional `keyMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
      パラメータ:
        `keyMarker` - The optional `keyMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
      関連項目:
        `getKeyMarker()`, `withKeyMarker(String)`

    - #### withKeyMarker

          public ListVersionsRequest withKeyMarker(java.lang.String 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.
      パラメータ:
        `keyMarker` - The optional `keyMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
      戻り値:
        This `ListVersionsRequest`, enabling additional method calls to be chained together.
      関連項目:
        `getKeyMarker()`, `setKeyMarker(String)`

    - #### getVersionIdMarker

          public java.lang.String getVersionIdMarker()

      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.

      戻り値:
        The optional `versionIdMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
      関連項目:
        `setVersionIdMarker(String)`, `withVersionIdMarker(String)`

    - #### setVersionIdMarker

          public void setVersionIdMarker(java.lang.String versionIdMarker)

      Sets the optional `versionIdMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
      パラメータ:
        `versionIdMarker` - The optional `versionIdMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
      関連項目:
        `getVersionIdMarker()`, `withVersionIdMarker(String)`

    - #### withVersionIdMarker

          public ListVersionsRequest withVersionIdMarker(java.lang.String 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.
      パラメータ:
        `versionIdMarker` - The optional `versionIdMarker` parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results.
      戻り値:
        This `ListVersionsRequest`, enabling additional method calls to be chained together.
      関連項目:
        `getVersionIdMarker()`, `setVersionIdMarker(String)`

    - #### getDelimiter

          public java.lang.String getDelimiter()

      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.

      戻り値:
        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.
      関連項目:
        `setDelimiter(String)`, `withDelimiter(String)`

    - #### setDelimiter

          public void setDelimiter(java.lang.String 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.
      パラメータ:
        `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.
      関連項目:
        `getDelimiter()`, `withDelimiter(String)`

    - #### withDelimiter

          public ListVersionsRequest withDelimiter(java.lang.String 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.
      パラメータ:
        `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.
      戻り値:
        This `ListVersionsRequest`, enabling additional method calls to be chained together.
      関連項目:
        `getDelimiter()`, `setDelimiter(String)`

    - #### getMaxResults

          public java.lang.Integer getMaxResults()

      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.
      戻り値:
        The optional `maxResults` parameter indicating the maximum number of results
      関連項目:
        `setMaxResults(Integer)`, `withMaxResults(Integer)`

    - #### setMaxResults

          public void setMaxResults(java.lang.Integer maxResults)

      Sets the optional `maxResults` parameter indicating the maximum number of results to include in the response.
      パラメータ:
        `maxResults` - The optional `maxResults` parameter indicating the maximum number of results to include in the response.
      関連項目:
        `getMaxResults()`, `withMaxResults(Integer)`

    - #### withMaxResults

          public ListVersionsRequest withMaxResults(java.lang.Integer 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.
      パラメータ:
        `maxResults` - The optional `maxResults` parameter indicating the maximum number of results to include in the response.
      戻り値:
        This `ListVersionsRequest`, enabling additional method calls to be chained together.
      関連項目:
        `getMaxResults()`, `setMaxResults(Integer)`