Package com.oracle.bmc.usage

Class RewardsPaginators

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public class RewardsPaginators
extends Object
    Collection of helper methods that can be used to provide an Iterable interface to any list operations of Rewards 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 Detail

      • RewardsPaginators

        public RewardsPaginators​(Rewards client)

    • Method Detail

      • listProductsResponseIterator

        public Iterable<ListProductsResponse> listProductsResponseIterator​(ListProductsRequest request)
        Creates a new iterable which will iterate over the responses received from the listProducts 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.

      • listProductsRecordIterator

        public Iterable<ProductSummary> listProductsRecordIterator​(ListProductsRequest request)
        Creates a new iterable which will iterate over the ProductSummary objects contained in responses from the listProducts 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 ProductSummary objects contained in responses received from the service.

      • listRedeemableUsersResponseIterator

        public Iterable<ListRedeemableUsersResponse> listRedeemableUsersResponseIterator​(ListRedeemableUsersRequest request)
        Creates a new iterable which will iterate over the responses received from the listRedeemableUsers 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.

      • listRedeemableUsersRecordIterator

        public Iterable<RedeemableUserSummary> listRedeemableUsersRecordIterator​(ListRedeemableUsersRequest request)
        Creates a new iterable which will iterate over the RedeemableUserSummary objects contained in responses from the listRedeemableUsers 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 RedeemableUserSummary objects contained in responses received from the service.

      • listRedemptionsResponseIterator

        public Iterable<ListRedemptionsResponse> listRedemptionsResponseIterator​(ListRedemptionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listRedemptions 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.

      • listRedemptionsRecordIterator

        public Iterable<RedemptionSummary> listRedemptionsRecordIterator​(ListRedemptionsRequest request)
        Creates a new iterable which will iterate over the RedemptionSummary objects contained in responses from the listRedemptions 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 RedemptionSummary objects contained in responses received from the service.