Package com.oracle.bmc.loadbalancer

Class LoadBalancerPaginators

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

      • LoadBalancerPaginators

        public LoadBalancerPaginators​(LoadBalancer client)

    • Method Detail

      • listLoadBalancerHealthsResponseIterator

        public Iterable<ListLoadBalancerHealthsResponse> listLoadBalancerHealthsResponseIterator​(ListLoadBalancerHealthsRequest request)
        Creates a new iterable which will iterate over the responses received from the listLoadBalancerHealths 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.

      • listLoadBalancersResponseIterator

        public Iterable<ListLoadBalancersResponse> listLoadBalancersResponseIterator​(ListLoadBalancersRequest request)
        Creates a new iterable which will iterate over the responses received from the listLoadBalancers 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.

      • listLoadBalancersRecordIterator

        public Iterable<LoadBalancer> listLoadBalancersRecordIterator​(ListLoadBalancersRequest request)
        Creates a new iterable which will iterate over the LoadBalancer objects contained in responses from the listLoadBalancers 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 LoadBalancer objects contained in responses received from the service.

      • listPoliciesResponseIterator

        public Iterable<ListPoliciesResponse> listPoliciesResponseIterator​(ListPoliciesRequest request)
        Creates a new iterable which will iterate over the responses received from the listPolicies 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.

      • listPoliciesRecordIterator

        public Iterable<LoadBalancerPolicy> listPoliciesRecordIterator​(ListPoliciesRequest request)
        Creates a new iterable which will iterate over the LoadBalancerPolicy objects contained in responses from the listPolicies 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 LoadBalancerPolicy objects contained in responses received from the service.

      • listProtocolsResponseIterator

        public Iterable<ListProtocolsResponse> listProtocolsResponseIterator​(ListProtocolsRequest request)
        Creates a new iterable which will iterate over the responses received from the listProtocols 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.

      • listProtocolsRecordIterator

        public Iterable<LoadBalancerProtocol> listProtocolsRecordIterator​(ListProtocolsRequest request)
        Creates a new iterable which will iterate over the LoadBalancerProtocol objects contained in responses from the listProtocols 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 LoadBalancerProtocol objects contained in responses received from the service.

      • listRoutingPoliciesResponseIterator

        public Iterable<ListRoutingPoliciesResponse> listRoutingPoliciesResponseIterator​(ListRoutingPoliciesRequest request)
        Creates a new iterable which will iterate over the responses received from the listRoutingPolicies 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.

      • listRoutingPoliciesRecordIterator

        public Iterable<RoutingPolicy> listRoutingPoliciesRecordIterator​(ListRoutingPoliciesRequest request)
        Creates a new iterable which will iterate over the RoutingPolicy objects contained in responses from the listRoutingPolicies 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 RoutingPolicy objects contained in responses received from the service.

      • listShapesResponseIterator

        public Iterable<ListShapesResponse> listShapesResponseIterator​(ListShapesRequest request)
        Creates a new iterable which will iterate over the responses received from the listShapes 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.

      • listShapesRecordIterator

        public Iterable<LoadBalancerShape> listShapesRecordIterator​(ListShapesRequest request)
        Creates a new iterable which will iterate over the LoadBalancerShape objects contained in responses from the listShapes 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 LoadBalancerShape objects contained in responses received from the service.

      • listWorkRequestsResponseIterator

        public Iterable<ListWorkRequestsResponse> listWorkRequestsResponseIterator​(ListWorkRequestsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWorkRequests 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.

      • listWorkRequestsRecordIterator

        public Iterable<WorkRequest> listWorkRequestsRecordIterator​(ListWorkRequestsRequest request)
        Creates a new iterable which will iterate over the WorkRequest objects contained in responses from the listWorkRequests 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 WorkRequest objects contained in responses received from the service.