Package com.oracle.bmc.waf.model

Class WebAppFirewallPolicy

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210930")
public final class WebAppFirewallPolicy
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The details of WebAppFirewallPolicy.

    A policy is comprised of rules, which allows executing inspections of incoming/outgoing HTTP message parameters and execution of actions, based on results of rules execution.

    In policy, rules are grouped into modules by their functionality. Modules can be further divided by the type of HTTP messages they handle: Modules that inspect incoming HTTP request. These modules are executed in the order they are enumerated here: * requestAccessControl * requestRateLimiting * requestProtection

    Modules that inspect outgoing HTTP responses. These modules are executed in the order they are enumerated here: * responseAccessControl * responseProtection
    Note: Objects should always be created or deserialized using the WebAppFirewallPolicy.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the WebAppFirewallPolicy.Builder, which maintain a set of all explicitly set fields called WebAppFirewallPolicy.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the WebAppFirewallPolicy.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        WebAppFirewallPolicy display name, can be renamed.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the WebAppFirewallPolicy was created.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the WebAppFirewallPolicy was updated.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message describing the current state in more detail.

        For example, can be used to provide actionable information for a resource in FAILED state.

        Returns:
        the value

      • getActions

        public List<Action> getActions()
        Predefined actions for use in multiple different rules.

        Not all actions are supported in every module. Some actions terminate further execution of modules and rules in a module and some do not. Actions names must be unique within this array.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel