software.amazon.awssdk.services.fsx.paginators.DescribeFileCachesIterable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fsx Show documentation
The AWS Java SDK for FSx module holds the client classes that are used for communicating with FSx.
There is a newer version: 2.28.4
/*
 * Copyright 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 software.amazon.awssdk.services.fsx.paginators;

import java.util.Iterator;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.pagination.sync.PaginatedResponsesIterator;
import software.amazon.awssdk.core.pagination.sync.SdkIterable;
import software.amazon.awssdk.core.pagination.sync.SyncPageFetcher;
import software.amazon.awssdk.core.util.PaginatorUtils;
import software.amazon.awssdk.services.fsx.FSxClient;
import software.amazon.awssdk.services.fsx.internal.UserAgentUtils;
import software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest;
import software.amazon.awssdk.services.fsx.model.DescribeFileCachesResponse;

/**
 * 
 * Represents the output for the
 * {@link software.amazon.awssdk.services.fsx.FSxClient#describeFileCachesPaginator(software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest)}
 * operation which is a paginated operation. This class is an iterable of
 * {@link software.amazon.awssdk.services.fsx.model.DescribeFileCachesResponse} 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
 * 
 *  * {@code
 * software.amazon.awssdk.services.fsx.paginators.DescribeFileCachesIterable responses = client.describeFileCachesPaginator(request);
 * responses.stream().forEach(....);
 * }
 * 
 *
 * 2) Using For loop
 * 
 *  * {
 *     @code
 *     software.amazon.awssdk.services.fsx.paginators.DescribeFileCachesIterable responses = client
 *             .describeFileCachesPaginator(request);
 *     for (software.amazon.awssdk.services.fsx.model.DescribeFileCachesResponse response : responses) {
 *         // do something;
 *     }
 * }
 * 
 *
 * 3) Use iterator directly
 * 
 *  * {@code
 * software.amazon.awssdk.services.fsx.paginators.DescribeFileCachesIterable responses = client.describeFileCachesPaginator(request);
 * responses.iterator().forEachRemaining(....);
 * }
 * 
 * 
 * Please notice that the configuration of MaxResults 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
 * {@link #describeFileCaches(software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest)} operation.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public class DescribeFileCachesIterable implements SdkIterable {
    private final FSxClient client;

    private final DescribeFileCachesRequest firstRequest;

    private final SyncPageFetcher nextPageFetcher;

    public DescribeFileCachesIterable(FSxClient client, DescribeFileCachesRequest firstRequest) {
        this.client = client;
        this.firstRequest = UserAgentUtils.applyPaginatorUserAgent(firstRequest);
        this.nextPageFetcher = new DescribeFileCachesResponseFetcher();
    }

    @Override
    public Iterator iterator() {
        return PaginatedResponsesIterator.builder().nextPageFetcher(nextPageFetcher).build();
    }

    private class DescribeFileCachesResponseFetcher implements SyncPageFetcher {
        @Override
        public boolean hasNextPage(DescribeFileCachesResponse previousPage) {
            return PaginatorUtils.isOutputTokenAvailable(previousPage.nextToken());
        }

        @Override
        public DescribeFileCachesResponse nextPage(DescribeFileCachesResponse previousPage) {
            if (previousPage == null) {
                return client.describeFileCaches(firstRequest);
            }
            return client.describeFileCaches(firstRequest.toBuilder().nextToken(previousPage.nextToken()).build());
        }
    }
}