com.amazonaws.services.s3.model

## クラス VersionListing

- java.lang.Object
- - com.amazonaws.services.s3.model.VersionListing

-     public class VersionListing
      extends java.lang.Object

  Contains the results of listing the versions in an Amazon S3 bucket, including a list of `S3VersionSummary` objects describing each version, information describing if this is a complete or partial listing, and the original request parameters.
  関連項目:
    `AmazonS3.listVersions(String, String)`, `AmazonS3.listVersions(ListVersionsRequest)`, `AmazonS3.listNextBatchOfVersions(VersionListing)`

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

    コンストラクタ
    コンストラクタと説明
    `VersionListing()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `java.lang.String` | `getBucketName()` Gets the name of the Amazon S3 bucket containing the versions listed in this `VersionListing`.
    `java.util.List<java.lang.String>` | `getCommonPrefixes()` Gets the common prefixes included in this version listing.
    `java.lang.String` | `getDelimiter()` Gets the value of the `delimiter` parameter used to request this version listing.
    `java.lang.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.
    `java.lang.String` | `getNextKeyMarker()` Gets the key marker to use in the next `listVersions` request in order to obtain the next page of results.
    `java.lang.String` | `getNextVersionIdMarker()` Gets the version ID marker to use in the next `listVersions` request in order to obtain the next page of results.
    `java.lang.String` | `getPrefix()` The prefix parameter originally used to request this version listing, or `null` if no prefix was specified.
    `java.lang.String` | `getVersionIdMarker()` Gets the value of the version ID marker parameter used to request this version listing.
    `java.util.List<S3VersionSummary>` | `getVersionSummaries()` Gets the list of version summaries describing the versions stored in the associated S3 bucket.
    `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(java.lang.String bucketName)` For internal use only.
    `void` | `setCommonPrefixes(java.util.List<java.lang.String> commonPrefixes)` For internal use only.
    `void` | `setDelimiter(java.lang.String delimiter)` For internal use only.
    `void` | `setKeyMarker(java.lang.String keyMarker)` For internal use only.
    `void` | `setMaxKeys(int maxKeys)` For internal use only.
    `void` | `setNextKeyMarker(java.lang.String marker)` For internal use only.
    `void` | `setNextVersionIdMarker(java.lang.String marker)` For internal use only.
    `void` | `setPrefix(java.lang.String prefix)` For internal use only.
    `void` | `setTruncated(boolean isTruncated)` For internal use only.
    `void` | `setVersionIdMarker(java.lang.String versionIdMarker)` For internal use only.
    `void` | `setVersionSummaries(java.util.List<S3VersionSummary> versionSummaries)` For internal use only.

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

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

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

    - #### VersionListing

          public VersionListing()

  - ### メソッドの詳細

    - #### getVersionSummaries

          public java.util.List<S3VersionSummary> 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 to `AmazonS3.listVersions(ListVersionsRequest)` to get additional results. Callers should always check `isTruncated()` to determine if a listing is truncated or not.
      戻り値:
        A list of the version summaries describing the versions stored in the associated S3 bucket.

    - #### setVersionSummaries

          public void setVersionSummaries(java.util.List<S3VersionSummary> versionSummaries)

      For internal use only. Sets the list of version summaries describing the versions stored in the associated S3 bucket.
      パラメータ:
        `versionSummaries` - The version summaries describing the versions stored in the associated S3 bucket.

    - #### getCommonPrefixes

          public java.util.List<java.lang.String> 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"
      If calling `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.
      戻り値:
        The list of common prefixes included in this version listing. Returns an empty list if no common prefixes are found.

    - #### setCommonPrefixes

          public void setCommonPrefixes(java.util.List<java.lang.String> commonPrefixes)

      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.
      パラメータ:
        `commonPrefixes` - The common prefixes for this version listing.

    - #### getBucketName

          public java.lang.String getBucketName()

      Gets the name of the Amazon S3 bucket containing the versions listed in this `VersionListing`.
      戻り値:
        The name of the Amazon S3 bucket containing the versions listed in this S3VersionListing.

    - #### setBucketName

          public void setBucketName(java.lang.String bucketName)

      For internal use only. Sets the name of the Amazon S3 bucket containing the versions listed in this S3VersionListing.
      パラメータ:
        `bucketName` - The name of the Amazon S3 bucket containing the versions listed in this S3VersionListing.

    - #### getPrefix

          public java.lang.String getPrefix()

      The prefix parameter originally used to request this version listing, or `null` if no prefix was specified. All object keys included in this version listing start with the specified prefix.
      戻り値:
        The prefix parameter originally used to request this version listing, or `null` if no prefix was specified.

    - #### setPrefix

          public void setPrefix(java.lang.String prefix)

      For internal use only. Sets the prefix parameter originally used to request this version listing.
      パラメータ:
        `prefix` - The prefix parameter originally used to request this version listing.

    - #### getKeyMarker

          public java.lang.String getKeyMarker()

      The key marker parameter originally used to request this version listing, or `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.
      戻り値:
        The key marker parameter originally used to request this version listing, or `null` if no key marker was specified.

    - #### setKeyMarker

          public void setKeyMarker(java.lang.String keyMarker)

      For internal use only. Sets the key marker parameter originally used to request this version listing.
      パラメータ:
        `keyMarker` - The key marker parameter originally used to request this version listing.

    - #### getVersionIdMarker

          public java.lang.String getVersionIdMarker()

      Gets the value of the version ID marker parameter used to request this version listing. Returns `null` if no version ID marker was otherwise specified.
      戻り値:
        The version ID marker parameter originally used to request this version listing. Returns `null` if no version ID marker otherwise was specified.

    - #### setVersionIdMarker

          public void setVersionIdMarker(java.lang.String versionIdMarker)

      For internal use only. Sets the version ID marker parameter originally used to request this version listing.
      パラメータ:
        `versionIdMarker` - The version ID marker parameter originally used to request this version listing.

    - #### getMaxKeys

          public int getMaxKeys()

      Gets the value of the `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.

      戻り値:
        The value of the `maxKeys` parameter used to request this version listing. Returns the default `maxKeys` 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.
      パラメータ:
        `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

          public java.lang.String getDelimiter()

      Gets the value of the `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.

      戻り値:
        The delimiter parameter originally used to request this version listing, or `null` if none was specified.

    - #### setDelimiter

          public void setDelimiter(java.lang.String delimiter)

      For internal use only. Sets the delimiter parameter originally used to request this version listing.
      パラメータ:
        `delimiter` - The delimiter parameter originally used to request this version listing.

    - #### getNextKeyMarker

          public java.lang.String getNextKeyMarker()

      Gets the key marker to use in the next `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.
      戻り値:
        The key marker to use in the next `listVersions` request in order to obtain the next page of results. Returns `null` if the version listing is not truncated.
      関連項目:
        `isTruncated()`

    - #### setNextKeyMarker

          public void setNextKeyMarker(java.lang.String marker)

      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.
      パラメータ:
        `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

          public java.lang.String getNextVersionIdMarker()

      Gets the version ID marker to use in the next `listVersions` request in order to obtain the next page of results. Returns `null` if the version listing is not truncated.
      戻り値:
        The version ID marker to use in the next `listVersions` request in order to see the next page of results. Returns `null` if the version listing is not truncated.
      関連項目:
        `isTruncated()`

    - #### setNextVersionIdMarker

          public void setNextVersionIdMarker(java.lang.String marker)

      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.
      パラメータ:
        `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.
      戻り値:
        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 value `false` 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.
      パラメータ:
        `isTruncated` - True if this version listing is not complete and the caller needs to make additional S3 calls to get additional version summaries.