Package com.oracle.bmc.networkloadbalancer

Class NetworkLoadBalancerPaginators

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

      • NetworkLoadBalancerPaginators

        public NetworkLoadBalancerPaginators​(NetworkLoadBalancer client)

    • Method Detail

      • listBackendSetsResponseIterator

        public Iterable<ListBackendSetsResponse> listBackendSetsResponseIterator​(ListBackendSetsRequest request)
        Creates a new iterable which will iterate over the responses received from the listBackendSets 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.

      • listBackendSetsRecordIterator

        public Iterable<BackendSetSummary> listBackendSetsRecordIterator​(ListBackendSetsRequest request)
        Creates a new iterable which will iterate over the BackendSetSummary objects contained in responses from the listBackendSets 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 BackendSetSummary objects contained in responses received from the service.

      • listBackendsResponseIterator

        public Iterable<ListBackendsResponse> listBackendsResponseIterator​(ListBackendsRequest request)
        Creates a new iterable which will iterate over the responses received from the listBackends 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.

      • listBackendsRecordIterator

        public Iterable<BackendSummary> listBackendsRecordIterator​(ListBackendsRequest request)
        Creates a new iterable which will iterate over the BackendSummary objects contained in responses from the listBackends 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 BackendSummary objects contained in responses received from the service.

      • listListenersResponseIterator

        public Iterable<ListListenersResponse> listListenersResponseIterator​(ListListenersRequest request)
        Creates a new iterable which will iterate over the responses received from the listListeners 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.

      • listListenersRecordIterator

        public Iterable<ListenerSummary> listListenersRecordIterator​(ListListenersRequest request)
        Creates a new iterable which will iterate over the ListenerSummary objects contained in responses from the listListeners 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 ListenerSummary objects contained in responses received from the service.

      • listNetworkLoadBalancerHealthsResponseIterator

        public Iterable<ListNetworkLoadBalancerHealthsResponse> listNetworkLoadBalancerHealthsResponseIterator​(ListNetworkLoadBalancerHealthsRequest request)
        Creates a new iterable which will iterate over the responses received from the listNetworkLoadBalancerHealths 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.

      • listNetworkLoadBalancersResponseIterator

        public Iterable<ListNetworkLoadBalancersResponse> listNetworkLoadBalancersResponseIterator​(ListNetworkLoadBalancersRequest request)
        Creates a new iterable which will iterate over the responses received from the listNetworkLoadBalancers 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.

      • listNetworkLoadBalancersPoliciesResponseIterator

        public Iterable<ListNetworkLoadBalancersPoliciesResponse> listNetworkLoadBalancersPoliciesResponseIterator​(ListNetworkLoadBalancersPoliciesRequest request)
        Creates a new iterable which will iterate over the responses received from the listNetworkLoadBalancersPolicies 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.

      • listNetworkLoadBalancersProtocolsResponseIterator

        public Iterable<ListNetworkLoadBalancersProtocolsResponse> listNetworkLoadBalancersProtocolsResponseIterator​(ListNetworkLoadBalancersProtocolsRequest request)
        Creates a new iterable which will iterate over the responses received from the listNetworkLoadBalancersProtocols 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.

      • listWorkRequestErrorsResponseIterator

        public Iterable<ListWorkRequestErrorsResponse> listWorkRequestErrorsResponseIterator​(ListWorkRequestErrorsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWorkRequestErrors 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.

      • listWorkRequestErrorsRecordIterator

        public Iterable<WorkRequestError> listWorkRequestErrorsRecordIterator​(ListWorkRequestErrorsRequest request)
        Creates a new iterable which will iterate over the WorkRequestError objects contained in responses from the listWorkRequestErrors 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 WorkRequestError objects contained in responses received from the service.

      • listWorkRequestLogsResponseIterator

        public Iterable<ListWorkRequestLogsResponse> listWorkRequestLogsResponseIterator​(ListWorkRequestLogsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWorkRequestLogs 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.

      • listWorkRequestLogsRecordIterator

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