Package com.oracle.bmc.waf.model

Class ProtectionCapabilitySummary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210930")
public final class ProtectionCapabilitySummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A summary of available OCI-managed protection capabilities in WebAppFirewallPolicy.

    Protection capabilies checks HTTP requests/responses if they are malicious.
    Note: Objects should always be created or deserialized using the ProtectionCapabilitySummary.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 ProtectionCapabilitySummary.Builder, which maintain a set of all explicitly set fields called ProtectionCapabilitySummary.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

      • getKey

        public String getKey()
        Unique key of protection capability.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The display name of protection capability.
        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of protection capability.
        Returns:
        the value

      • getVersion

        public Integer getVersion()
        The version of protection capability.
        Returns:
        the value

      • getIsLatestVersion

        public Boolean getIsLatestVersion()
        The field that shows if this is the latest version of protection capability.
        Returns:
        the value

      • getGroupTags

        public List<String> getGroupTags()
        The list of unique names protection capability group tags that are associated with this capability.

        Example: [“PCI”, “Recommended”]

        Returns:
        the value

      • getType

        public ProtectionCapabilitySummary.Type getType()
        The type of protection capability.

        **REQUEST_PROTECTION_CAPABILITY** can only be used in requestProtection module of WebAppFirewallPolicy.

        **RESPONSE_PROTECTION_CAPABILITY** can only be used in responseProtection module of WebAppFirewallPolicy.

        Returns:
        the value

      • getCollaborativeActionThreshold

        public Integer getCollaborativeActionThreshold()
        The default collaborative action threshold for OCI-managed collaborative protection capability.

        Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as contributing capabilities later on) which have weights assigned to them. These weights can be found in the collaborativeWeights array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to collaborativeActionThreshold is the incoming/outgoing HTTP message marked as malicious.

        This field is ignored for non-collaborative capabilities.

        Returns:
        the value

      • getCollaborativeWeights

        public List<CollaborativeCapabilityWeight> getCollaborativeWeights()
        The weights of contributing capabilities.

        Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability.

        This field is ignored for non-collaborative capabilities.

        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