software.amazon.awssdk.services.rds.paginators

Class DescribeDBInstancesIterable

java.lang.Object

software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable

All Implemented Interfaces:

Iterable<DescribeDbInstancesResponse>, SdkIterable<DescribeDbInstancesResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeDBInstancesIterable
extends Object
implements SdkIterable<DescribeDbInstancesResponse>

Represents the output for the RdsClient.describeDBInstancesPaginator(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest) operation which is a paginated operation. This class is an iterable of DescribeDbInstancesResponse 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.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client
             .describeDBInstancesPaginator(request);
     for (software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rds.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxRecords 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 #describeDBInstances(software.amazon.awssdk.services.rds.model.DescribeDbInstancesRequest) operation.

Constructor Summary

Constructors

Constructor and Description
DescribeDBInstancesIterable(RdsClient client, DescribeDbInstancesRequest firstRequest)

Method Summary

Modifier and Type	Method and Description
SdkIterable<DBInstance>	dbInstances() Returns an iterable to iterate through the paginated DescribeDbInstancesResponse.dbInstances() member.
Iterator<DescribeDbInstancesResponse>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.core.pagination.sync.SdkIterable

stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DescribeDBInstancesIterable

public DescribeDBInstancesIterable(RdsClient client,
                                   DescribeDbInstancesRequest firstRequest)

Method Detail

iterator

public Iterator<DescribeDbInstancesResponse> iterator()

Specified by:

iterator in interface Iterable<DescribeDbInstancesResponse>

dbInstances

public final SdkIterable<DBInstance> dbInstances()

Returns an iterable to iterate through the paginated DescribeDbInstancesResponse.dbInstances() 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.