Package com.oracle.bmc.waas

Interface Waas

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    WaasClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181116")
public interface Waas
extends AutoCloseable
    OCI Web Application Acceleration and Security 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

      • acceptRecommendations

        AcceptRecommendationsResponse acceptRecommendations​(AcceptRecommendationsRequest request)
        Accepts a list of recommended Web Application Firewall protection rules.

        Web Application Firewall protection rule recommendations are sets of rules generated by observed traffic patterns through the Web Application Firewall and are meant to optimize the Web Application Firewall’s security profile. Only the rules specified in the request body will be updated; all other rules will remain unchanged.

        Use the `GET /waasPolicies/{waasPolicyId}/wafConfig/recommendations` method to view a list of recommended Web Application Firewall protection rules. For more information, see [WAF Protection Rules](https://docs.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm).

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/AcceptRecommendationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AcceptRecommendations API.

      • cancelWorkRequest

        CancelWorkRequestResponse cancelWorkRequest​(CancelWorkRequestRequest request)
        Cancels a specified work request.
        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/CancelWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelWorkRequest API.

      • changeAddressListCompartment

        ChangeAddressListCompartmentResponse changeAddressListCompartment​(ChangeAddressListCompartmentRequest request)
        Moves address list into a different compartment.

        When provided, If-Match is checked against ETag values of the address list. For information about moving resources between compartments, see Moving Resources to a Different 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/ChangeAddressListCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeAddressListCompartment API.

      • changeCertificateCompartment

        ChangeCertificateCompartmentResponse changeCertificateCompartment​(ChangeCertificateCompartmentRequest request)
        Moves certificate into a different compartment.

        When provided, If-Match is checked against ETag values of the certificate. For information about moving resources between compartments, see Moving Resources to a Different 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/ChangeCertificateCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeCertificateCompartment API.

      • changeCustomProtectionRuleCompartment

        ChangeCustomProtectionRuleCompartmentResponse changeCustomProtectionRuleCompartment​(ChangeCustomProtectionRuleCompartmentRequest request)
        Moves a custom protection rule into a different compartment within the same tenancy.

        When provided, If-Match is checked against ETag values of the custom protection rule. For information about moving resources between compartments, see Moving Resources to a Different 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/ChangeCustomProtectionRuleCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeCustomProtectionRuleCompartment API.

      • changeWaasPolicyCompartment

        ChangeWaasPolicyCompartmentResponse changeWaasPolicyCompartment​(ChangeWaasPolicyCompartmentRequest request)
        Moves WAAS policy into a different compartment.

        When provided, If-Match is checked against ETag values of the WAAS policy. For information about moving resources between compartments, see Moving Resources to a Different 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/ChangeWaasPolicyCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeWaasPolicyCompartment API.

      • createAddressList

        CreateAddressListResponse createAddressList​(CreateAddressListRequest request)
        Creates an address list in a set compartment and allows it to be used in a WAAS policy and referenced by access rules.

        Addresses can be IP addresses and CIDR notations.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/CreateAddressListExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateAddressList API.

      • createCertificate

        CreateCertificateResponse createCertificate​(CreateCertificateRequest request)
        Allows an SSL certificate to be added to a WAAS policy.

        The Web Application Firewall terminates SSL connections to inspect requests in runtime, and then re-encrypts requests before sending them to the origin for fulfillment.

        For more information, see [WAF Settings](https://docs.oracle.com/iaas/Content/WAF/Tasks/wafsettings.htm).

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/CreateCertificateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCertificate API.

      • createCustomProtectionRule

        CreateCustomProtectionRuleResponse createCustomProtectionRule​(CreateCustomProtectionRuleRequest request)
        Creates a new custom protection rule in the specified compartment.

        Custom protection rules allow you to create rules in addition to the rulesets provided by the Web Application Firewall service, including rules from [ModSecurity](https://modsecurity.org/). The syntax for custom rules is based on the ModSecurity syntax. For more information about custom protection rules, see [Custom Protection Rules](https://docs.oracle.com/iaas/Content/WAF/Tasks/customprotectionrules.htm).

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/CreateCustomProtectionRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCustomProtectionRule API.

      • createWaasPolicy

        CreateWaasPolicyResponse createWaasPolicy​(CreateWaasPolicyRequest request)
        Creates a new Web Application Acceleration and Security (WAAS) policy in the specified compartment.

        A WAAS policy must be established before creating Web Application Firewall (WAF) rules. To use WAF rules, your web application’s origin servers must defined in the WaasPolicy schema.

        A domain name must be specified when creating a WAAS policy. The domain name should be different from the origins specified in your `WaasPolicy`. Once domain name is entered and stored, it is unchangeable.

        Use the record data returned in the `cname` field of the `WaasPolicy` object to create a CNAME record in your DNS configuration that will direct your domain's traffic through the WAF.

        For the purposes of access control, you must provide the OCID of the compartment where you want the service to reside. For information about access control and compartments, see [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

        You must specify a display name and domain for the WAAS policy. The display name does not have to be unique and can be changed. The domain name should be different from every origin specified in `WaasPolicy`.

        All Oracle Cloud Infrastructure resources, including WAAS policies, receive a unique, Oracle-assigned ID called an Oracle Cloud Identifier (OCID). When a resource is created, you can find its OCID in the response. You can also retrieve a resource's OCID by using a list API operation for that resource type, or by viewing the resource in the Console. Fore more information, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

        *Note:** After sending the POST request, the new object's state will temporarily be `CREATING`. Ensure that the resource's state has changed to `ACTIVE` before use.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/CreateWaasPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateWaasPolicy API.

      • deleteAddressList

        DeleteAddressListResponse deleteAddressList​(DeleteAddressListRequest request)
        Deletes the address list from the compartment if it is not used.
        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/DeleteAddressListExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteAddressList API.

      • deleteCertificate

        DeleteCertificateResponse deleteCertificate​(DeleteCertificateRequest request)
        Deletes an SSL certificate from the WAAS service.
        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/DeleteCertificateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCertificate API.

      • deleteCustomProtectionRule

        DeleteCustomProtectionRuleResponse deleteCustomProtectionRule​(DeleteCustomProtectionRuleRequest request)
        Deletes a Custom Protection rule.
        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/DeleteCustomProtectionRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCustomProtectionRule API.

      • deleteWaasPolicy

        DeleteWaasPolicyResponse deleteWaasPolicy​(DeleteWaasPolicyRequest request)
        Deletes a policy.
        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/DeleteWaasPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteWaasPolicy API.

      • getAddressList

        GetAddressListResponse getAddressList​(GetAddressListRequest request)
        Gets the details of an address list.
        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/waas/GetAddressListExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAddressList API.

      • getCertificate

        GetCertificateResponse getCertificate​(GetCertificateRequest request)
        Gets the details of an SSL certificate.
        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/waas/GetCertificateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCertificate API.

      • getCustomProtectionRule

        GetCustomProtectionRuleResponse getCustomProtectionRule​(GetCustomProtectionRuleRequest request)
        Gets the details of a custom protection rule.
        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/waas/GetCustomProtectionRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCustomProtectionRule API.

      • getDeviceFingerprintChallenge

        GetDeviceFingerprintChallengeResponse getDeviceFingerprintChallenge​(GetDeviceFingerprintChallengeRequest request)
        Gets the device fingerprint challenge settings in the Web Application Firewall configuration for a WAAS policy.
        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/waas/GetDeviceFingerprintChallengeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDeviceFingerprintChallenge API.

      • getHumanInteractionChallenge

        GetHumanInteractionChallengeResponse getHumanInteractionChallenge​(GetHumanInteractionChallengeRequest request)
        Gets the human interaction challenge settings in the Web Application Firewall configuration for a WAAS policy.
        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/waas/GetHumanInteractionChallengeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetHumanInteractionChallenge API.

      • getJsChallenge

        GetJsChallengeResponse getJsChallenge​(GetJsChallengeRequest request)
        Gets the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy.
        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/waas/GetJsChallengeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetJsChallenge API.

      • getPolicyConfig

        GetPolicyConfigResponse getPolicyConfig​(GetPolicyConfigRequest request)
        Gets the configuration of a WAAS policy.
        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/waas/GetPolicyConfigExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPolicyConfig API.

      • getProtectionRule

        GetProtectionRuleResponse getProtectionRule​(GetProtectionRuleRequest request)
        Gets the details of a protection rule in the Web Application Firewall configuration for a WAAS policy.
        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/waas/GetProtectionRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetProtectionRule API.

      • getProtectionSettings

        GetProtectionSettingsResponse getProtectionSettings​(GetProtectionSettingsRequest request)
        Gets the protection settings in the Web Application Firewall configuration for a WAAS policy.
        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/waas/GetProtectionSettingsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetProtectionSettings API.

      • getWaasPolicy

        GetWaasPolicyResponse getWaasPolicy​(GetWaasPolicyRequest request)
        Gets the details of a WAAS policy.
        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/waas/GetWaasPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWaasPolicy API.

      • getWafAddressRateLimiting

        GetWafAddressRateLimitingResponse getWafAddressRateLimiting​(GetWafAddressRateLimitingRequest request)
        Gets the address rate limiting settings of the Web Application Firewall configuration for a WAAS policy.
        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/waas/GetWafAddressRateLimitingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWafAddressRateLimiting API.

      • getWafConfig

        GetWafConfigResponse getWafConfig​(GetWafConfigRequest request)
        Gets the Web Application Firewall configuration details for a WAAS policy.
        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/waas/GetWafConfigExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWafConfig API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Gets the details of a specified work request.
        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/waas/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • listAccessRules

        ListAccessRulesResponse listAccessRules​(ListAccessRulesRequest request)
        Gets the currently configured access rules for the Web Application Firewall configuration of a specified WAAS policy.

        The order of the access rules is important. The rules will be checked in the order they are specified and the first matching rule will be used.

        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/waas/ListAccessRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAccessRules API.

      • listAddressLists

        ListAddressListsResponse listAddressLists​(ListAddressListsRequest request)
        Gets a list of address lists that can be used in a WAAS policy.
        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/waas/ListAddressListsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAddressLists API.

      • listCachingRules

        ListCachingRulesResponse listCachingRules​(ListCachingRulesRequest request)
        Gets the currently configured caching rules for the Web Application Firewall configuration of a specified WAAS policy.

        The rules are processed in the order they are specified in and the first matching rule will be used when processing a request.

        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/waas/ListCachingRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCachingRules API.

      • listCaptchas

        ListCaptchasResponse listCaptchas​(ListCaptchasRequest request)
        Gets the list of currently configured CAPTCHA challenges in the Web Application Firewall configuration of a WAAS policy.

        The order of the CAPTCHA challenges is important. The URL for each CAPTCHA will be checked in the order they are created.

        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/waas/ListCaptchasExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCaptchas API.

      • listCertificates

        ListCertificatesResponse listCertificates​(ListCertificatesRequest request)
        Gets a list of SSL certificates that can be used in a WAAS policy.
        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/waas/ListCertificatesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCertificates API.

      • listCustomProtectionRules

        ListCustomProtectionRulesResponse listCustomProtectionRules​(ListCustomProtectionRulesRequest request)
        Gets a list of custom protection rules for the specified Web Application Firewall.
        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/waas/ListCustomProtectionRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCustomProtectionRules API.

      • listEdgeSubnets

        ListEdgeSubnetsResponse listEdgeSubnets​(ListEdgeSubnetsRequest request)
        Return the list of the tenant’s edge node subnets.

        Use these CIDR blocks to restrict incoming traffic to your origin. These subnets are owned by OCI and forward traffic to customer origins. They are not associated with specific regions or compartments.

        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/waas/ListEdgeSubnetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEdgeSubnets API.

      • listGoodBots

        ListGoodBotsResponse listGoodBots​(ListGoodBotsRequest request)
        Gets the list of good bots defined in the Web Application Firewall configuration for a WAAS policy.

        The list is sorted by `key`, in ascending order.

        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/waas/ListGoodBotsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListGoodBots API.

      • listProtectionRules

        ListProtectionRulesResponse listProtectionRules​(ListProtectionRulesRequest request)
        Gets the list of available protection rules for a WAAS policy.

        Use the GetWafConfig operation to view a list of currently configured protection rules for the Web Application Firewall, or use the ListRecommendations operation to get a list of recommended protection rules for the Web Application Firewall. The list is sorted by key, in ascending order.

        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/waas/ListProtectionRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListProtectionRules API.

      • listRecommendations

        ListRecommendationsResponse listRecommendations​(ListRecommendationsRequest request)
        Gets the list of recommended Web Application Firewall protection rules.

        Use the `POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations` method to accept recommended Web Application Firewall protection rules. For more information, see [WAF Protection Rules](https://docs.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm). The list is sorted by `key`, in ascending order.

        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/waas/ListRecommendationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRecommendations API.

      • listThreatFeeds

        ListThreatFeedsResponse listThreatFeeds​(ListThreatFeedsRequest request)
        Gets the list of available web application threat intelligence feeds and the actions set for each feed.

        The list is sorted by key, in ascending order.

        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/waas/ListThreatFeedsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListThreatFeeds API.

      • listWaasPolicies

        ListWaasPoliciesResponse listWaasPolicies​(ListWaasPoliciesRequest request)
        Gets a list of WAAS policies.
        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/waas/ListWaasPoliciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWaasPolicies API.

      • listWaasPolicyCustomProtectionRules

        ListWaasPolicyCustomProtectionRulesResponse listWaasPolicyCustomProtectionRules​(ListWaasPolicyCustomProtectionRulesRequest request)
        Gets the list of currently configured custom protection rules for a WAAS policy.
        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/waas/ListWaasPolicyCustomProtectionRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWaasPolicyCustomProtectionRules API.

      • listWafBlockedRequests

        ListWafBlockedRequestsResponse listWafBlockedRequests​(ListWafBlockedRequestsRequest request)
        Gets the number of blocked requests by a Web Application Firewall feature in five minute blocks, sorted by timeObserved in ascending order (starting from oldest data).
        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/waas/ListWafBlockedRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWafBlockedRequests API.

      • listWafLogs

        ListWafLogsResponse listWafLogs​(ListWafLogsRequest request)
        Gets structured Web Application Firewall event logs for a WAAS policy.

        Sorted by the timeObserved in ascending order (starting from the oldest recorded event).

        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/waas/ListWafLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWafLogs API.

      • listWafRequests

        ListWafRequestsResponse listWafRequests​(ListWafRequestsRequest request)
        Gets the number of requests managed by a Web Application Firewall over a specified period of time, including blocked requests.

        Sorted by timeObserved in ascending order (starting from oldest requests).

        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/waas/ListWafRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWafRequests API.

      • listWafTraffic

        ListWafTrafficResponse listWafTraffic​(ListWafTrafficRequest request)
        Gets the Web Application Firewall traffic data for a WAAS policy.

        Sorted by timeObserved in ascending order (starting from oldest data).

        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/waas/ListWafTrafficExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWafTraffic API.

      • listWhitelists

        ListWhitelistsResponse listWhitelists​(ListWhitelistsRequest request)
        Gets the list of whitelists defined in the Web Application Firewall configuration for a WAAS policy.
        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/waas/ListWhitelistsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWhitelists API.

      • listWorkRequests

        ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Gets a list of subnets (CIDR notation) from which the WAAS EDGE may make requests.

        The subnets are owned by OCI and forward traffic to your origins. Allow traffic from these subnets to your origins. They are not associated with specific regions or compartments.

        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/waas/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • purgeCache

        PurgeCacheResponse purgeCache​(PurgeCacheRequest request)
        Performs a purge of the cache for each specified resource.

        If no resources are passed, the cache for the entire Web Application Firewall will be purged. For more information, see Caching Rules.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/PurgeCacheExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PurgeCache API.

      • updateAccessRules

        UpdateAccessRulesResponse updateAccessRules​(UpdateAccessRulesRequest request)
        Updates the list of access rules in the Web Application Firewall configuration for a specified WAAS policy.

        Access rules allow explicit actions to be defined and executed for requests that meet various conditions. A rule action can be set to allow, detect, or block requests. The detect setting allows the request to pass through the Web Application Firewall and is tagged with a DETECT flag in the Web Application Firewall’s log.

        This operation can create, delete, update, and/or reorder access rules depending on the structure of the request body.

        Access rules can be updated by changing the properties of the access rule object with the rule's key specified in the key field. Access rules can be reordered by changing the order of the access rules in the list when updating.

        Access rules can be created by adding a new access rule object to the list without a `key` property specified. A `key` will be generated for the new access rule upon update.

        Any existing access rules that are not specified with a `key` in the list of access rules will be deleted upon update.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateAccessRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAccessRules API.

      • updateAddressList

        UpdateAddressListResponse updateAddressList​(UpdateAddressListRequest request)
        Updates the details of an address list.

        Only the fields specified in the request body will be updated; all other properties will remain unchanged.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateAddressListExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAddressList API.

      • updateCachingRules

        UpdateCachingRulesResponse updateCachingRules​(UpdateCachingRulesRequest request)
        Updates the configuration for each specified caching rule.

        Caching rules WAF policies allow you to selectively cache content on Oracle Cloud Infrastructure's edge servers, such as webpages or certain file types. For more information about caching rules, see [Caching Rules](https://docs.oracle.com/iaas/Content/WAF/Tasks/cachingrules.htm).

        This operation can create, delete, update, and/or reorder caching rules depending on the structure of the request body. Caching rules can be updated by changing the properties of the caching rule object with the rule's key specified in the key field. Any existing caching rules that are not specified with a key in the list of access rules will be deleted upon update.

        The order the caching rules are specified in is important. The rules are processed in the order they are specified and the first matching rule will be used when processing a request. Use `ListCachingRules` to view a list of all available caching rules 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateCachingRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCachingRules API.

      • updateCaptchas

        UpdateCaptchasResponse updateCaptchas​(UpdateCaptchasRequest request)
        Updates the list of CAPTCHA challenges in the Web Application Firewall configuration for a WAAS policy.

        This operation can create, update, or delete CAPTCHAs depending on the structure of the request body. CAPTCHA challenges can be updated by changing the properties of the CAPTCHA object with the rule’s key specified in the key field. CAPTCHA challenges can be reordered by changing the order of the CAPTCHA challenges in the list when updating.

        CAPTCHA challenges can be created by adding a new access rule object to the list without a `key` property specified. A `key` will be generated for the new CAPTCHA challenges upon update.

        Any existing CAPTCHA challenges that are not specified with a `key` in the list of CAPTCHA challenges will be deleted upon update.

        Query parameters are allowed in CAPTCHA URL.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateCaptchasExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCaptchas API.

      • updateCertificate

        UpdateCertificateResponse updateCertificate​(UpdateCertificateRequest request)
        It is not possible to update a certificate, only create and delete.

        Therefore, this operation can only update the display name, freeform tags, and defined tags of a certificate.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateCertificateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCertificate API.

      • updateCustomProtectionRule

        UpdateCustomProtectionRuleResponse updateCustomProtectionRule​(UpdateCustomProtectionRuleRequest request)
        Updates the configuration of a custom protection rule.

        Only the fields specified in the request body will be updated; all other properties will remain unchanged.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateCustomProtectionRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCustomProtectionRule API.

      • updateDeviceFingerprintChallenge

        UpdateDeviceFingerprintChallengeResponse updateDeviceFingerprintChallenge​(UpdateDeviceFingerprintChallengeRequest request)
        Updates the Device Fingerprint Challenge (DFC) settings in the Web Application Firewall configuration for a policy.

        The DFC generates a hashed signature of both virtual and real browsers based on 50+ attributes. These proprietary signatures are then leveraged for real-time correlation to identify and block malicious bots.

        The signature is based on a library of attributes detected via JavaScript listeners; the attributes include OS, screen resolution, fonts, UserAgent, IP address, etc. We are constantly making improvements and considering new libraries to include in our DFC build. We can also exclude attributes from the signature as needed.

        DFC collects attributes to generate a hashed signature about a client - if a fingerprint is not possible, then it will result in a block or alert action. Actions can be enforced across multiple devices if they share they have the same fingerprint.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateDeviceFingerprintChallengeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDeviceFingerprintChallenge API.

      • updateGoodBots

        UpdateGoodBotsResponse updateGoodBots​(UpdateGoodBotsRequest request)
        Updates the list of good bots in the Web Application Firewall configuration for a policy.

        Only the fields specified in the request body will be updated, all other configuration properties will remain unchanged.

        Good bots allows you to manage access for bots from known providers, such as Google or Baidu. For more information about good bots, see [Bot Management](https://docs.oracle.com/iaas/Content/WAF/Tasks/botmanagement.htm).

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateGoodBotsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateGoodBots API.

      • updateHumanInteractionChallenge

        UpdateHumanInteractionChallengeResponse updateHumanInteractionChallenge​(UpdateHumanInteractionChallengeRequest request)
        Updates the Human Interaction Challenge (HIC) settings in the Web Application Firewall configuration for a WAAS policy.

        HIC is a countermeasure that allows the proxy to check the user’s browser for various behaviors that distinguish a human presence from a bot.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateHumanInteractionChallengeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateHumanInteractionChallenge API.

      • updateJsChallenge

        UpdateJsChallengeResponse updateJsChallenge​(UpdateJsChallengeRequest request)
        Updates the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy.

        JavaScript Challenge validates that the client can accept JavaScript with a binary decision. For more information, see Bot Management.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateJsChallengeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateJsChallenge API.

      • updatePolicyConfig

        UpdatePolicyConfigResponse updatePolicyConfig​(UpdatePolicyConfigRequest request)
        Updates the configuration for a WAAS policy.

        Only the fields specified in the request body will be updated; all other properties will remain unchanged.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdatePolicyConfigExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePolicyConfig API.

      • updateProtectionRules

        UpdateProtectionRulesResponse updateProtectionRules​(UpdateProtectionRulesRequest request)
        Updates the action for each specified protection rule.

        Requests can either be allowed, blocked, or trigger an alert if they meet the parameters of an applied rule. For more information on protection rules, see WAF Protection Rules. This operation can update or disable protection rules depending on the structure of the request body. Protection rules can be updated by changing the properties of the protection rule object with the rule’s key specified in the key field.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateProtectionRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateProtectionRules API.

      • updateProtectionSettings

        UpdateProtectionSettingsResponse updateProtectionSettings​(UpdateProtectionSettingsRequest request)
        Updates the protection settings in the Web Application Firewall configuration for a WAAS policy.

        Protection settings allow you define what action is taken when a request is blocked by the Web Application Firewall, such as returning a response code or block page. Only the fields specified in the request body will be updated; all other fields will remain unchanged.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateProtectionSettingsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateProtectionSettings API.

      • updateThreatFeeds

        UpdateThreatFeedsResponse updateThreatFeeds​(UpdateThreatFeedsRequest request)
        Updates the action to take when a request’s IP address matches an address in the specified threat intelligence feed.

        Threat intelligence feeds are compiled lists of IP addresses with malicious reputations based on internet intelligence. Only the threat feeds specified in the request body will be updated; all other threat feeds will remain unchanged.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateThreatFeedsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateThreatFeeds API.

      • updateWaasPolicy

        UpdateWaasPolicyResponse updateWaasPolicy​(UpdateWaasPolicyRequest request)
        Updates the details of a WAAS policy, including origins and tags.

        Only the fields specified in the request body will be updated; all other properties will remain unchanged. To update platform provided resources such as GoodBots, ProtectionRules, and ThreatFeeds, first retrieve the list of available resources with the related list operation such as GetThreatFeeds or GetProtectionRules. The returned list will contain objects with key properties that can be used to update the resource during the UpdateWaasPolicy request.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateWaasPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateWaasPolicy API.

      • updateWaasPolicyCustomProtectionRules

        UpdateWaasPolicyCustomProtectionRulesResponse updateWaasPolicyCustomProtectionRules​(UpdateWaasPolicyCustomProtectionRulesRequest request)
        Updates the action for each specified custom protection rule.

        Only the DETECT and BLOCK actions can be set. Disabled rules should not be included in the list. For more information on protection rules, see WAF Protection Rules.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateWaasPolicyCustomProtectionRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateWaasPolicyCustomProtectionRules API.

      • updateWafAddressRateLimiting

        UpdateWafAddressRateLimitingResponse updateWafAddressRateLimiting​(UpdateWafAddressRateLimitingRequest request)
        Updates the address rate limiting settings in the Web Application Firewall configuration for a policy.

        Rate limiting allows you to configure a threshold for the number of requests from a unique IP address for the given period. You can also define the response code for the requests from the same address that exceed the threshold.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateWafAddressRateLimitingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateWafAddressRateLimiting API.

      • updateWafConfig

        UpdateWafConfigResponse updateWafConfig​(UpdateWafConfigRequest request)
        Updates the Web Application Firewall configuration for a specified WAAS policy.

        To update platform provided resources such as `GoodBots`, `ProtectionRules`, and `ThreatFeeds`, first retrieve the list of available resources with the related list operation, such as `GetThreatFeeds` or `GetProtectionRules`.

        The returned list will contain objects with `key` properties that can be used to update the resource during the `UpdateWafConfig` request.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateWafConfigExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateWafConfig API.

      • updateWhitelists

        UpdateWhitelistsResponse updateWhitelists​(UpdateWhitelistsRequest request)
        Updates the list of IP addresses that bypass the Web Application Firewall for a WAAS policy.

        Supports single IP addresses, subnet masks (CIDR notation) and Address Lists.

        This operation can create, delete, update, and/or reorder whitelists depending on the structure of the request body.

        Whitelists can be updated by changing the properties of the whitelist object with the rule's key specified in the `key` field. Whitelists can be reordered by changing the order of the whitelists in the list of objects when updating.

        Whitelists can be created by adding a new whitelist object to the list without a `key` property specified. A `key` will be generated for the new whitelist upon update.

        Whitelists can be deleted by removing the existing whitelist object from the list. Any existing whitelists that are not specified with a `key` in the list of access rules will be deleted upon update.

        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/waas/UpdateWhitelistsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateWhitelists API.

      • getWaiters

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

      • getPaginators

        WaasPaginators 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.