Package com.oracle.bmc.core

Class ComputeManagementPaginators

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

      • ComputeManagementPaginators

        public ComputeManagementPaginators​(ComputeManagement client)

    • Method Detail

      • listClusterNetworkInstancesResponseIterator

        public Iterable<ListClusterNetworkInstancesResponse> listClusterNetworkInstancesResponseIterator​(ListClusterNetworkInstancesRequest request)
        Creates a new iterable which will iterate over the responses received from the listClusterNetworkInstances 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.

      • listClusterNetworkInstancesRecordIterator

        public Iterable<InstanceSummary> listClusterNetworkInstancesRecordIterator​(ListClusterNetworkInstancesRequest request)
        Creates a new iterable which will iterate over the InstanceSummary objects contained in responses from the listClusterNetworkInstances 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 InstanceSummary objects contained in responses received from the service.

      • listClusterNetworksResponseIterator

        public Iterable<ListClusterNetworksResponse> listClusterNetworksResponseIterator​(ListClusterNetworksRequest request)
        Creates a new iterable which will iterate over the responses received from the listClusterNetworks 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.

      • listClusterNetworksRecordIterator

        public Iterable<ClusterNetworkSummary> listClusterNetworksRecordIterator​(ListClusterNetworksRequest request)
        Creates a new iterable which will iterate over the ClusterNetworkSummary objects contained in responses from the listClusterNetworks 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 ClusterNetworkSummary objects contained in responses received from the service.

      • listInstanceConfigurationsResponseIterator

        public Iterable<ListInstanceConfigurationsResponse> listInstanceConfigurationsResponseIterator​(ListInstanceConfigurationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listInstanceConfigurations 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.

      • listInstancePoolInstancesResponseIterator

        public Iterable<ListInstancePoolInstancesResponse> listInstancePoolInstancesResponseIterator​(ListInstancePoolInstancesRequest request)
        Creates a new iterable which will iterate over the responses received from the listInstancePoolInstances 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.

      • listInstancePoolInstancesRecordIterator

        public Iterable<InstanceSummary> listInstancePoolInstancesRecordIterator​(ListInstancePoolInstancesRequest request)
        Creates a new iterable which will iterate over the InstanceSummary objects contained in responses from the listInstancePoolInstances 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 InstanceSummary objects contained in responses received from the service.

      • listInstancePoolsResponseIterator

        public Iterable<ListInstancePoolsResponse> listInstancePoolsResponseIterator​(ListInstancePoolsRequest request)
        Creates a new iterable which will iterate over the responses received from the listInstancePools 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.

      • listInstancePoolsRecordIterator

        public Iterable<InstancePoolSummary> listInstancePoolsRecordIterator​(ListInstancePoolsRequest request)
        Creates a new iterable which will iterate over the InstancePoolSummary objects contained in responses from the listInstancePools 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 InstancePoolSummary objects contained in responses received from the service.