Package com.oracle.bmc.waf

Interface Waf

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    WafClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210930")
public interface Waf
extends AutoCloseable
    API for the Web Application Firewall service.

    Use this API to manage regional Web App Firewalls and corresponding policies for protecting HTTP services.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • changeNetworkAddressListCompartment

        ChangeNetworkAddressListCompartmentResponse changeNetworkAddressListCompartment​(ChangeNetworkAddressListCompartmentRequest request)
        Moves a NetworkAddressList resource from one compartment to another.

        When provided, If-Match is checked against ETag values of the resource.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ChangeNetworkAddressListCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeNetworkAddressListCompartment API.

      • changeWebAppFirewallCompartment

        ChangeWebAppFirewallCompartmentResponse changeWebAppFirewallCompartment​(ChangeWebAppFirewallCompartmentRequest request)
        Moves a Web App Firewall resource from one compartment to another.

        When provided, If-Match is checked against ETag values of the resource.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ChangeWebAppFirewallCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeWebAppFirewallCompartment API.

      • changeWebAppFirewallPolicyCompartment

        ChangeWebAppFirewallPolicyCompartmentResponse changeWebAppFirewallPolicyCompartment​(ChangeWebAppFirewallPolicyCompartmentRequest request)
        Moves a WebAppFirewallfPolicy resource from one compartment to another.

        When provided, If-Match is checked against ETag values of the resource.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ChangeWebAppFirewallPolicyCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeWebAppFirewallPolicyCompartment API.

      • createNetworkAddressList

        CreateNetworkAddressListResponse createNetworkAddressList​(CreateNetworkAddressListRequest request)
        Creates a new NetworkAddressList.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/CreateNetworkAddressListExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateNetworkAddressList API.

      • createWebAppFirewall

        CreateWebAppFirewallResponse createWebAppFirewall​(CreateWebAppFirewallRequest request)
        Creates a new WebAppFirewall.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/CreateWebAppFirewallExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateWebAppFirewall API.

      • createWebAppFirewallPolicy

        CreateWebAppFirewallPolicyResponse createWebAppFirewallPolicy​(CreateWebAppFirewallPolicyRequest request)
        Creates a new WebAppFirewallPolicy.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/CreateWebAppFirewallPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateWebAppFirewallPolicy API.

      • deleteNetworkAddressList

        DeleteNetworkAddressListResponse deleteNetworkAddressList​(DeleteNetworkAddressListRequest request)
        Deletes a NetworkAddressList resource identified by the OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/DeleteNetworkAddressListExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteNetworkAddressList API.

      • deleteWebAppFirewall

        DeleteWebAppFirewallResponse deleteWebAppFirewall​(DeleteWebAppFirewallRequest request)
        Deletes a WebAppFirewall resource identified by the OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/DeleteWebAppFirewallExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteWebAppFirewall API.

      • deleteWebAppFirewallPolicy

        DeleteWebAppFirewallPolicyResponse deleteWebAppFirewallPolicy​(DeleteWebAppFirewallPolicyRequest request)
        Deletes a WebAppFirewallPolicy resource identified by the OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/DeleteWebAppFirewallPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteWebAppFirewallPolicy API.

      • getNetworkAddressList

        GetNetworkAddressListResponse getNetworkAddressList​(GetNetworkAddressListRequest request)
        Gets a NetworkAddressList by OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/GetNetworkAddressListExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetNetworkAddressList API.

      • getWebAppFirewall

        GetWebAppFirewallResponse getWebAppFirewall​(GetWebAppFirewallRequest request)
        Gets a WebAppFirewall by OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/GetWebAppFirewallExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWebAppFirewall API.

      • getWebAppFirewallPolicy

        GetWebAppFirewallPolicyResponse getWebAppFirewallPolicy​(GetWebAppFirewallPolicyRequest request)
        Gets a WebAppFirewallPolicy with the given OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/GetWebAppFirewallPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWebAppFirewallPolicy API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Gets the status of the WorkRequest with the given OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • listNetworkAddressLists

        ListNetworkAddressListsResponse listNetworkAddressLists​(ListNetworkAddressListsRequest request)
        Gets a list of all NetworkAddressLists in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ListNetworkAddressListsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListNetworkAddressLists API.

      • listProtectionCapabilities

        ListProtectionCapabilitiesResponse listProtectionCapabilities​(ListProtectionCapabilitiesRequest request)
        Lists of protection capabilities filtered by query parameters.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ListProtectionCapabilitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListProtectionCapabilities API.

      • listProtectionCapabilityGroupTags

        ListProtectionCapabilityGroupTagsResponse listProtectionCapabilityGroupTags​(ListProtectionCapabilityGroupTagsRequest request)
        Lists of available group tags filtered by query parameters.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ListProtectionCapabilityGroupTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListProtectionCapabilityGroupTags API.

      • listWebAppFirewallPolicies

        ListWebAppFirewallPoliciesResponse listWebAppFirewallPolicies​(ListWebAppFirewallPoliciesRequest request)
        Gets a list of all WebAppFirewallPolicies in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ListWebAppFirewallPoliciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWebAppFirewallPolicies API.

      • listWebAppFirewalls

        ListWebAppFirewallsResponse listWebAppFirewalls​(ListWebAppFirewallsRequest request)
        Gets a list of all WebAppFirewalls in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ListWebAppFirewallsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWebAppFirewalls API.

      • listWorkRequestErrors

        ListWorkRequestErrorsResponse listWorkRequestErrors​(ListWorkRequestErrorsRequest request)
        Return a (paginated) list of errors for a given WorkRequest.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.

      • listWorkRequestLogs

        ListWorkRequestLogsResponse listWorkRequestLogs​(ListWorkRequestLogsRequest request)
        Return a (paginated) list of logs for a given WorkRequest.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.

      • listWorkRequests

        ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Lists the WorkRequests in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • updateNetworkAddressList

        UpdateNetworkAddressListResponse updateNetworkAddressList​(UpdateNetworkAddressListRequest request)
        Update the NetworkAddressList identified by the OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/UpdateNetworkAddressListExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateNetworkAddressList API.

      • updateWebAppFirewall

        UpdateWebAppFirewallResponse updateWebAppFirewall​(UpdateWebAppFirewallRequest request)
        Updates the WebAppFirewall identified by the OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/UpdateWebAppFirewallExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateWebAppFirewall API.

      • updateWebAppFirewallPolicy

        UpdateWebAppFirewallPolicyResponse updateWebAppFirewallPolicy​(UpdateWebAppFirewallPolicyRequest request)
        Update the WebAppFirewallPolicy identified by the OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/waf/UpdateWebAppFirewallPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateWebAppFirewallPolicy API.

      • getWaiters

        WafWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        WafPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.