com.oracle.bmc.rover

Class ShapePaginators

java.lang.Object

com.oracle.bmc.rover.ShapePaginators

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201210")
public class ShapePaginators
extends Object

Collection of helper methods that can be used to provide an Iterable interface to any list operations of Shape where multiple pages of data may be fetched. Two styles of iteration are supported:

• Iterating over the Response objects returned by the list operation. These are referred to as ResponseIterators, and the methods are suffixed with ResponseIterator. For example: listUsersResponseIterator
• Iterating over the resources/records being listed. These are referred to as RecordIterators, and the methods are suffixed with RecordIterator. For example: listUsersRecordIterator

These iterables abstract away the need to write code to manually handle pagination via looping and using the page tokens. They will automatically fetch more data from the service when required.

As an example, if we were using the ListUsers operation in IdentityService, then the Iterable returned by calling a ResponseIterator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the Iterable returned by calling a RecordIterator method would iterate over the User records and we don't have to deal with ListUsersResponse objects at all. In either case, pagination will be automatically handled so we can iterate until there are no more responses or no more resources/records available.

Constructor Summary

Constructors

Constructor and Description
ShapePaginators(Shape client)

Method Summary

Modifier and Type	Method and Description
Iterable<ShapeSummary>	listShapesRecordIterator(ListShapesRequest request) Creates a new iterable which will iterate over the ShapeSummary objects contained in responses from the listShapes operation.
Iterable<ListShapesResponse>	listShapesResponseIterator(ListShapesRequest request) Creates a new iterable which will iterate over the responses received from the listShapes operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShapePaginators

public ShapePaginators(Shape client)

Method Detail

listShapesResponseIterator

public Iterable<ListShapesResponse> listShapesResponseIterator(ListShapesRequest request)

Creates a new iterable which will iterate over the responses received from the listShapes operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listShapesRecordIterator

public Iterable<ShapeSummary> listShapesRecordIterator(ListShapesRequest request)

Creates a new iterable which will iterate over the ShapeSummary objects contained in responses from the listShapes operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the ShapeSummary objects contained in responses received from the service.