com.amazonaws.services.s3.model

## クラス ObjectListing

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

-     public class ObjectListing
      extends java.lang.Object

  Contains the results of listing the objects in an Amazon S3 bucket. This includes a list of `S3ObjectSummary` objects describing the objects stored in the bucket, a list of common prefixes if a delimiter was specified in the request, information describing if this is a complete or partial listing, and the original request parameters.
  関連項目:
    `AmazonS3.listObjects(String, String)`, `AmazonS3.listObjects(ListObjectsRequest)`, `AmazonS3.listNextBatchOfObjects(ObjectListing)`

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `java.lang.String` | `getBucketName()` Gets the name of the Amazon S3 bucket containing the objects listed in this `ObjectListing`.
    `java.util.List<java.lang.String>` | `getCommonPrefixes()` Gets the common prefixes included in this object listing.
    `java.lang.String` | `getDelimiter()` Gets the delimiter parameter originally used to request this object listing, or `null` if no delimiter specified.
    `java.lang.String` | `getMarker()` Gets the marker parameter originally used to request this object listing, or `null` if no marker was specified.
    `int` | `getMaxKeys()` Gets the `maxKeys` parameter originally used to request this object listing, or the default `maxKeys` value provided by Amazon S3 if the requester didn't specify a value.
    `java.lang.String` | `getNextMarker()` Gets the marker to use in the next `listObjects` request in order to see the next page of results.
    `java.util.List<S3ObjectSummary>` | `getObjectSummaries()` Gets the list of object summaries describing the objects stored in the S3 bucket.
    `java.lang.String` | `getPrefix()` Gets the prefix parameter originally used to request this object listing, or `null` if no prefix was specified.
    `boolean` | `isTruncated()` Gets whether or not this object listing is complete.
    `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` | `setMarker(java.lang.String marker)` For internal use only.
    `void` | `setMaxKeys(int maxKeys)` For internal use only.
    `void` | `setNextMarker(java.lang.String nextMarker)` For internal use only.
    `void` | `setPrefix(java.lang.String prefix)` For internal use only.
    `void` | `setTruncated(boolean isTruncated)` For internal use only.

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

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

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

    - #### ObjectListing

          public ObjectListing()

  - ### メソッドの詳細

    - #### getObjectSummaries

          public java.util.List<S3ObjectSummary> getObjectSummaries()

      Gets the list of object summaries describing the objects stored in the S3 bucket. Listings for large buckets can be truncated for performance reasons. Always check the `isTruncated()` method to see if the returned listing is complete or if additional calls are needed to get more results. Callers might need to make additional calls to `AmazonS3.listNextBatchOfObjects(ObjectListing)` to get additional results.
      戻り値:
        A list of the object summaries describing the objects stored in the S3 bucket.

    - #### getCommonPrefixes

          public java.util.List<java.lang.String> getCommonPrefixes()

      Gets the common prefixes included in this object 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 object 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 following keys:

      - "foo/bar/baz"
      - "foo/bar/bash"
      - "foo/bar/bang"
      - "foo/boo"
      If calling `listObjects` with the prefix="foo/" and the delimiter="/" on this bucket, the returned `S3ObjectListing` 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 object summaries list.
      戻り値:
        The list of common prefixes included in this object listing, which might be an empty list if no common prefixes were found.

    - #### setCommonPrefixes

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

      For internal use only. Sets the common prefixes for this object listing, representing the key prefixes that were rolled up because of the request's delimiter parameter.
      パラメータ:
        `commonPrefixes` - The common prefixes for this object listing.

    - #### getNextMarker

          public java.lang.String getNextMarker()

      Gets the marker to use in the next `listObjects` request in order to see the next page of results. If an object listing is not truncated, this method will return `null`. For truncated requests, this value is equal to the greatest lexicographical value of the object keys and common prefixes included in this listing.
      戻り値:
        The marker to use in the next `listObjects` request in order to see the next page of results if this object listing is truncated. Returns `null` if this object listing isn't truncated.

    - #### setNextMarker

          public void setNextMarker(java.lang.String nextMarker)

      For internal use only. Sets the marker to use in the next list objects request in order to see the next page of results for a truncated object listing.
      パラメータ:
        `nextMarker` - The marker to use in the next listObjects request in order to see the next page of results for a truncated object listing.

    - #### getBucketName

          public java.lang.String getBucketName()

      Gets the name of the Amazon S3 bucket containing the objects listed in this `ObjectListing`.
      戻り値:
        The name of the Amazon S3 bucket containing the objects listed in this `ObjectListing`.

    - #### setBucketName

          public void setBucketName(java.lang.String bucketName)

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

    - #### getPrefix

          public java.lang.String getPrefix()

      Gets the prefix parameter originally used to request this object listing, or `null` if no prefix was specified. All objects and common prefixes included in this object listing start with the specified prefix.
      戻り値:
        The prefix parameter originally used to request this object listing. Returns `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 object listing.
      パラメータ:
        `prefix` - The prefix parameter originally used to request this object listing.

    - #### getMarker

          public java.lang.String getMarker()

      Gets the marker parameter originally used to request this object listing, or `null` if no marker was specified. If specified, all objects and common prefixes included in this object listing will occur alphabetically after the specified marker.
      戻り値:
        The marker parameter originally used to request this object listing. Returns `null` if no marker was specified.

    - #### setMarker

          public void setMarker(java.lang.String marker)

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

    - #### getMaxKeys

          public int getMaxKeys()

      Gets the `maxKeys` parameter originally used to request this object listing, or the default `maxKeys` value provided by Amazon S3 if the requester didn't specify a value. The `maxKeys` parameter limits the combined number of objects and common prefixes included in this object listing. An object listing will never contain more objects plus common prefixes than indicated by the `maxKeys`, but can of course contain less.
      戻り値:
        The `maxKeys`maxKeys value applied by Amazon S3 if no value was 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 object 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 delimiter parameter originally used to request this object listing, or `null` if no delimiter 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), 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 object listing. Returns `null` if no delimiter was specified.

    - #### setDelimiter

          public void setDelimiter(java.lang.String delimiter)

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

    - #### isTruncated

          public boolean isTruncated()

      Gets whether or not this object listing is complete.
      戻り値:
        The value `true` if the object listing is not complete. Returns the value `false` if otherwise. When returning `true`, additional calls to Amazon S3 may be needed in order to obtain more results.

    - #### setTruncated

          public void setTruncated(boolean isTruncated)

      For internal use only. Sets the truncated property for this object listing, indicating if this is a complete listing or not and whether the caller needs to make additional calls to S3 to get more object summaries.
      パラメータ:
        `isTruncated` - The value `true` if the object listing is not complete. The value `false` if otherwise.