Package com.oracle.bmc.usageapi

Class UsageapiPaginators

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

      • UsageapiPaginators

        public UsageapiPaginators​(Usageapi client)

    • Method Detail

      • listCustomTablesResponseIterator

        public Iterable<ListCustomTablesResponse> listCustomTablesResponseIterator​(ListCustomTablesRequest request)
        Creates a new iterable which will iterate over the responses received from the listCustomTables 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.

      • listCustomTablesRecordIterator

        public Iterable<CustomTableSummary> listCustomTablesRecordIterator​(ListCustomTablesRequest request)
        Creates a new iterable which will iterate over the CustomTableSummary objects contained in responses from the listCustomTables 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 CustomTableSummary objects contained in responses received from the service.

      • listEmailRecipientsGroupsResponseIterator

        public Iterable<ListEmailRecipientsGroupsResponse> listEmailRecipientsGroupsResponseIterator​(ListEmailRecipientsGroupsRequest request)
        Creates a new iterable which will iterate over the responses received from the listEmailRecipientsGroups 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.

      • listQueriesResponseIterator

        public Iterable<ListQueriesResponse> listQueriesResponseIterator​(ListQueriesRequest request)
        Creates a new iterable which will iterate over the responses received from the listQueries 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.

      • listQueriesRecordIterator

        public Iterable<QuerySummary> listQueriesRecordIterator​(ListQueriesRequest request)
        Creates a new iterable which will iterate over the QuerySummary objects contained in responses from the listQueries 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 QuerySummary objects contained in responses received from the service.

      • listScheduledRunsResponseIterator

        public Iterable<ListScheduledRunsResponse> listScheduledRunsResponseIterator​(ListScheduledRunsRequest request)
        Creates a new iterable which will iterate over the responses received from the listScheduledRuns 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.

      • listScheduledRunsRecordIterator

        public Iterable<ScheduledRunSummary> listScheduledRunsRecordIterator​(ListScheduledRunsRequest request)
        Creates a new iterable which will iterate over the ScheduledRunSummary objects contained in responses from the listScheduledRuns 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 ScheduledRunSummary objects contained in responses received from the service.

      • listSchedulesResponseIterator

        public Iterable<ListSchedulesResponse> listSchedulesResponseIterator​(ListSchedulesRequest request)
        Creates a new iterable which will iterate over the responses received from the listSchedules 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.

      • listSchedulesRecordIterator

        public Iterable<ScheduleSummary> listSchedulesRecordIterator​(ListSchedulesRequest request)
        Creates a new iterable which will iterate over the ScheduleSummary objects contained in responses from the listSchedules 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 ScheduleSummary objects contained in responses received from the service.

      • listUsageCarbonEmissionsQueriesResponseIterator

        public Iterable<ListUsageCarbonEmissionsQueriesResponse> listUsageCarbonEmissionsQueriesResponseIterator​(ListUsageCarbonEmissionsQueriesRequest request)
        Creates a new iterable which will iterate over the responses received from the listUsageCarbonEmissionsQueries 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.