Package com.oracle.bmc.waas

Class WaasPaginators

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

      • WaasPaginators

        public WaasPaginators​(Waas client)

    • Method Detail

      • listAccessRulesResponseIterator

        public Iterable<ListAccessRulesResponse> listAccessRulesResponseIterator​(ListAccessRulesRequest request)
        Creates a new iterable which will iterate over the responses received from the listAccessRules 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.

      • listAccessRulesRecordIterator

        public Iterable<AccessRule> listAccessRulesRecordIterator​(ListAccessRulesRequest request)
        Creates a new iterable which will iterate over the AccessRule objects contained in responses from the listAccessRules 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 AccessRule objects contained in responses received from the service.

      • listAddressListsResponseIterator

        public Iterable<ListAddressListsResponse> listAddressListsResponseIterator​(ListAddressListsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAddressLists 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.

      • listAddressListsRecordIterator

        public Iterable<AddressListSummary> listAddressListsRecordIterator​(ListAddressListsRequest request)
        Creates a new iterable which will iterate over the AddressListSummary objects contained in responses from the listAddressLists 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 AddressListSummary objects contained in responses received from the service.

      • listCachingRulesResponseIterator

        public Iterable<ListCachingRulesResponse> listCachingRulesResponseIterator​(ListCachingRulesRequest request)
        Creates a new iterable which will iterate over the responses received from the listCachingRules 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.

      • listCachingRulesRecordIterator

        public Iterable<CachingRuleSummary> listCachingRulesRecordIterator​(ListCachingRulesRequest request)
        Creates a new iterable which will iterate over the CachingRuleSummary objects contained in responses from the listCachingRules 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 CachingRuleSummary objects contained in responses received from the service.

      • listCaptchasResponseIterator

        public Iterable<ListCaptchasResponse> listCaptchasResponseIterator​(ListCaptchasRequest request)
        Creates a new iterable which will iterate over the responses received from the listCaptchas 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.

      • listCaptchasRecordIterator

        public Iterable<Captcha> listCaptchasRecordIterator​(ListCaptchasRequest request)
        Creates a new iterable which will iterate over the Captcha objects contained in responses from the listCaptchas 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 Captcha objects contained in responses received from the service.

      • listCertificatesResponseIterator

        public Iterable<ListCertificatesResponse> listCertificatesResponseIterator​(ListCertificatesRequest request)
        Creates a new iterable which will iterate over the responses received from the listCertificates 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.

      • listCertificatesRecordIterator

        public Iterable<CertificateSummary> listCertificatesRecordIterator​(ListCertificatesRequest request)
        Creates a new iterable which will iterate over the CertificateSummary objects contained in responses from the listCertificates 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 CertificateSummary objects contained in responses received from the service.

      • listCustomProtectionRulesResponseIterator

        public Iterable<ListCustomProtectionRulesResponse> listCustomProtectionRulesResponseIterator​(ListCustomProtectionRulesRequest request)
        Creates a new iterable which will iterate over the responses received from the listCustomProtectionRules 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.

      • listEdgeSubnetsResponseIterator

        public Iterable<ListEdgeSubnetsResponse> listEdgeSubnetsResponseIterator​(ListEdgeSubnetsRequest request)
        Creates a new iterable which will iterate over the responses received from the listEdgeSubnets 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.

      • listEdgeSubnetsRecordIterator

        public Iterable<EdgeSubnet> listEdgeSubnetsRecordIterator​(ListEdgeSubnetsRequest request)
        Creates a new iterable which will iterate over the EdgeSubnet objects contained in responses from the listEdgeSubnets 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 EdgeSubnet objects contained in responses received from the service.

      • listGoodBotsResponseIterator

        public Iterable<ListGoodBotsResponse> listGoodBotsResponseIterator​(ListGoodBotsRequest request)
        Creates a new iterable which will iterate over the responses received from the listGoodBots 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.

      • listGoodBotsRecordIterator

        public Iterable<GoodBot> listGoodBotsRecordIterator​(ListGoodBotsRequest request)
        Creates a new iterable which will iterate over the GoodBot objects contained in responses from the listGoodBots 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 GoodBot objects contained in responses received from the service.

      • listProtectionRulesResponseIterator

        public Iterable<ListProtectionRulesResponse> listProtectionRulesResponseIterator​(ListProtectionRulesRequest request)
        Creates a new iterable which will iterate over the responses received from the listProtectionRules 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.

      • listProtectionRulesRecordIterator

        public Iterable<ProtectionRule> listProtectionRulesRecordIterator​(ListProtectionRulesRequest request)
        Creates a new iterable which will iterate over the ProtectionRule objects contained in responses from the listProtectionRules 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 ProtectionRule objects contained in responses received from the service.

      • listRecommendationsResponseIterator

        public Iterable<ListRecommendationsResponse> listRecommendationsResponseIterator​(ListRecommendationsRequest request)
        Creates a new iterable which will iterate over the responses received from the listRecommendations 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.

      • listRecommendationsRecordIterator

        public Iterable<Recommendation> listRecommendationsRecordIterator​(ListRecommendationsRequest request)
        Creates a new iterable which will iterate over the Recommendation objects contained in responses from the listRecommendations 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 Recommendation objects contained in responses received from the service.

      • listThreatFeedsResponseIterator

        public Iterable<ListThreatFeedsResponse> listThreatFeedsResponseIterator​(ListThreatFeedsRequest request)
        Creates a new iterable which will iterate over the responses received from the listThreatFeeds 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.

      • listThreatFeedsRecordIterator

        public Iterable<ThreatFeed> listThreatFeedsRecordIterator​(ListThreatFeedsRequest request)
        Creates a new iterable which will iterate over the ThreatFeed objects contained in responses from the listThreatFeeds 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 ThreatFeed objects contained in responses received from the service.

      • listWaasPoliciesResponseIterator

        public Iterable<ListWaasPoliciesResponse> listWaasPoliciesResponseIterator​(ListWaasPoliciesRequest request)
        Creates a new iterable which will iterate over the responses received from the listWaasPolicies 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.

      • listWaasPoliciesRecordIterator

        public Iterable<WaasPolicySummary> listWaasPoliciesRecordIterator​(ListWaasPoliciesRequest request)
        Creates a new iterable which will iterate over the WaasPolicySummary objects contained in responses from the listWaasPolicies 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 WaasPolicySummary objects contained in responses received from the service.

      • listWaasPolicyCustomProtectionRulesResponseIterator

        public Iterable<ListWaasPolicyCustomProtectionRulesResponse> listWaasPolicyCustomProtectionRulesResponseIterator​(ListWaasPolicyCustomProtectionRulesRequest request)
        Creates a new iterable which will iterate over the responses received from the listWaasPolicyCustomProtectionRules 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.

      • listWafBlockedRequestsResponseIterator

        public Iterable<ListWafBlockedRequestsResponse> listWafBlockedRequestsResponseIterator​(ListWafBlockedRequestsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWafBlockedRequests 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.

      • listWafBlockedRequestsRecordIterator

        public Iterable<WafBlockedRequest> listWafBlockedRequestsRecordIterator​(ListWafBlockedRequestsRequest request)
        Creates a new iterable which will iterate over the WafBlockedRequest objects contained in responses from the listWafBlockedRequests 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 WafBlockedRequest objects contained in responses received from the service.

      • listWafLogsResponseIterator

        public Iterable<ListWafLogsResponse> listWafLogsResponseIterator​(ListWafLogsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWafLogs 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.

      • listWafLogsRecordIterator

        public Iterable<WafLog> listWafLogsRecordIterator​(ListWafLogsRequest request)
        Creates a new iterable which will iterate over the WafLog objects contained in responses from the listWafLogs 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 WafLog objects contained in responses received from the service.

      • listWafRequestsResponseIterator

        public Iterable<ListWafRequestsResponse> listWafRequestsResponseIterator​(ListWafRequestsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWafRequests 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.

      • listWafRequestsRecordIterator

        public Iterable<WafRequest> listWafRequestsRecordIterator​(ListWafRequestsRequest request)
        Creates a new iterable which will iterate over the WafRequest objects contained in responses from the listWafRequests 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 WafRequest objects contained in responses received from the service.

      • listWafTrafficResponseIterator

        public Iterable<ListWafTrafficResponse> listWafTrafficResponseIterator​(ListWafTrafficRequest request)
        Creates a new iterable which will iterate over the responses received from the listWafTraffic 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.

      • listWafTrafficRecordIterator

        public Iterable<WafTrafficDatum> listWafTrafficRecordIterator​(ListWafTrafficRequest request)
        Creates a new iterable which will iterate over the WafTrafficDatum objects contained in responses from the listWafTraffic 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 WafTrafficDatum objects contained in responses received from the service.

      • listWhitelistsResponseIterator

        public Iterable<ListWhitelistsResponse> listWhitelistsResponseIterator​(ListWhitelistsRequest request)
        Creates a new iterable which will iterate over the responses received from the listWhitelists 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.

      • listWhitelistsRecordIterator

        public Iterable<Whitelist> listWhitelistsRecordIterator​(ListWhitelistsRequest request)
        Creates a new iterable which will iterate over the Whitelist objects contained in responses from the listWhitelists 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 Whitelist 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.