Package com.oracle.bmc.cloudbridge

Class InventoryPaginators

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

      • InventoryPaginators

        public InventoryPaginators​(Inventory client)

    • Method Detail

      • listAssetsResponseIterator

        public Iterable<ListAssetsResponse> listAssetsResponseIterator​(ListAssetsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAssets 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.

      • listAssetsRecordIterator

        public Iterable<AssetSummary> listAssetsRecordIterator​(ListAssetsRequest request)
        Creates a new iterable which will iterate over the AssetSummary objects contained in responses from the listAssets 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 AssetSummary objects contained in responses received from the service.

      • listHistoricalMetricsResponseIterator

        public Iterable<ListHistoricalMetricsResponse> listHistoricalMetricsResponseIterator​(ListHistoricalMetricsRequest request)
        Creates a new iterable which will iterate over the responses received from the listHistoricalMetrics 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.

      • listHistoricalMetricsRecordIterator

        public Iterable<HistoricalMetricSummary> listHistoricalMetricsRecordIterator​(ListHistoricalMetricsRequest request)
        Creates a new iterable which will iterate over the HistoricalMetricSummary objects contained in responses from the listHistoricalMetrics 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 HistoricalMetricSummary objects contained in responses received from the service.

      • listInventoriesResponseIterator

        public Iterable<ListInventoriesResponse> listInventoriesResponseIterator​(ListInventoriesRequest request)
        Creates a new iterable which will iterate over the responses received from the listInventories 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.

      • listInventoriesRecordIterator

        public Iterable<InventorySummary> listInventoriesRecordIterator​(ListInventoriesRequest request)
        Creates a new iterable which will iterate over the InventorySummary objects contained in responses from the listInventories 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 InventorySummary objects contained in responses received from the service.