Package software.amazon.awssdk.services.s3.paginators

Class ListObjectsV2Iterable

  • All Implemented Interfaces:
    Iterable<ListObjectsV2Response>, SdkIterable<ListObjectsV2Response>
    @Generated("software.amazon.awssdk:codegen")
public class ListObjectsV2Iterable
extends Object
implements SdkIterable<ListObjectsV2Response>

    Represents the output for the S3Client.listObjectsV2Paginator(software.amazon.awssdk.services.s3.model.ListObjectsV2Request) operation which is a paginated operation. This class is an iterable of ListObjectsV2Response that can be used to iterate through all the response pages of the operation.

    When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

    The following are few ways to iterate through the response pages:

    1) Using a Stream 
     
 software.amazon.awssdk.services.s3.paginators.ListObjectsV2Iterable responses = client.listObjectsV2Paginator(request);
 responses.stream().forEach(....);
    2) Using For loop 
     {
     @code
     software.amazon.awssdk.services.s3.paginators.ListObjectsV2Iterable responses = client.listObjectsV2Paginator(request);
     for (software.amazon.awssdk.services.s3.model.ListObjectsV2Response response : responses) {
         // do something;
     }
 }
    3) Use iterator directly 
     
 software.amazon.awssdk.services.s3.paginators.ListObjectsV2Iterable responses = client.listObjectsV2Paginator(request);
 responses.iterator().forEachRemaining(....);

    Please notice that the configuration of MaxKeys won't limit the number of results you get with the paginator. It only limits the number of results in each page.

    Note: If you prefer to have control on service calls, use the #listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request) operation.

    • Method Detail

      • contents

        public final SdkIterable<S3Object> contents()
        Returns an iterable to iterate through the paginated ListObjectsV2Response.contents() member. The returned iterable is used to iterate through the results across all response pages and not a single page. This method is useful if you are interested in iterating over the paginated member in the response pages instead of the top level pages. Similar to iteration over pages, this method internally makes service calls to get the next list of results until the iteration stops or there are no more results.

      • commonPrefixes

        public final SdkIterable<CommonPrefix> commonPrefixes()
        Returns an iterable to iterate through the paginated ListObjectsV2Response.commonPrefixes() member. The returned iterable is used to iterate through the results across all response pages and not a single page. This method is useful if you are interested in iterating over the paginated member in the response pages instead of the top level pages. Similar to iteration over pages, this method internally makes service calls to get the next list of results until the iteration stops or there are no more results.