Package com.oracle.bmc.tenantmanagercontrolplane

Class SubscriptionPaginators

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

      • SubscriptionPaginators

        public SubscriptionPaginators​(Subscription client)

    • Method Detail

      • listAssignedSubscriptionLineItemsResponseIterator

        public Iterable<ListAssignedSubscriptionLineItemsResponse> listAssignedSubscriptionLineItemsResponseIterator​(ListAssignedSubscriptionLineItemsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAssignedSubscriptionLineItems 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.

      • listAssignedSubscriptionsResponseIterator

        public Iterable<ListAssignedSubscriptionsResponse> listAssignedSubscriptionsResponseIterator​(ListAssignedSubscriptionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAssignedSubscriptions 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.

      • listAvailableRegionsResponseIterator

        public Iterable<ListAvailableRegionsResponse> listAvailableRegionsResponseIterator​(ListAvailableRegionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAvailableRegions 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.

      • listAvailableRegionsRecordIterator

        public Iterable<AvailableRegionSummary> listAvailableRegionsRecordIterator​(ListAvailableRegionsRequest request)
        Creates a new iterable which will iterate over the AvailableRegionSummary objects contained in responses from the listAvailableRegions 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 AvailableRegionSummary objects contained in responses received from the service.

      • listSubscriptionLineItemsResponseIterator

        public Iterable<ListSubscriptionLineItemsResponse> listSubscriptionLineItemsResponseIterator​(ListSubscriptionLineItemsRequest request)
        Creates a new iterable which will iterate over the responses received from the listSubscriptionLineItems 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.

      • listSubscriptionMappingsResponseIterator

        public Iterable<ListSubscriptionMappingsResponse> listSubscriptionMappingsResponseIterator​(ListSubscriptionMappingsRequest request)
        Creates a new iterable which will iterate over the responses received from the listSubscriptionMappings 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.

      • listSubscriptionsResponseIterator

        public Iterable<ListSubscriptionsResponse> listSubscriptionsResponseIterator​(ListSubscriptionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listSubscriptions 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.

      • listSubscriptionsRecordIterator

        public Iterable<SubscriptionSummary> listSubscriptionsRecordIterator​(ListSubscriptionsRequest request)
        Creates a new iterable which will iterate over the SubscriptionSummary objects contained in responses from the listSubscriptions 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 SubscriptionSummary objects contained in responses received from the service.