Package com.oracle.bmc.waf.model

Class ProtectionRule

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.waf.model.WebAppFirewallPolicyRule

com.oracle.bmc.waf.model.ProtectionRule

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210930")
public final class ProtectionRule
extends WebAppFirewallPolicyRule

Rule that represents Request/Response Protection.

Only actions of the following types are allowed to be referenced in this rule: * CHECK * RETURN_HTTP_RESPONSE
Note: Objects should always be created or deserialized using the ProtectionRule.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 ProtectionRule.Builder, which maintain a set of all explicitly set fields called ProtectionRule.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProtectionRule.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.waf.model.WebAppFirewallPolicyRule

WebAppFirewallPolicyRule.ConditionLanguage, WebAppFirewallPolicyRule.Type

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
ProtectionRule(String name, WebAppFirewallPolicyRule.ConditionLanguage conditionLanguage, String condition, String actionName, List<ProtectionCapability> protectionCapabilities, ProtectionCapabilitySettings protectionCapabilitySettings, Boolean isBodyInspectionEnabled)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ProtectionRule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getIsBodyInspectionEnabled()	Enables/disables body inspection for this protection rule.
List<ProtectionCapability>	getProtectionCapabilities()	An ordered list that references OCI-managed protection capabilities.
ProtectionCapabilitySettings	getProtectionCapabilitySettings()
int	hashCode()
ProtectionRule.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.waf.model.WebAppFirewallPolicyRule

getActionName, getCondition, getConditionLanguage, getName

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProtectionRule

@Deprecated
public ProtectionRule(String name,
                      WebAppFirewallPolicyRule.ConditionLanguage conditionLanguage,
                      String condition,
                      String actionName,
                      List<ProtectionCapability> protectionCapabilities,
                      ProtectionCapabilitySettings protectionCapabilitySettings,
                      Boolean isBodyInspectionEnabled)

Deprecated.

Method Detail

builder

public static ProtectionRule.Builder builder()

Create a new builder.

toBuilder

public ProtectionRule.Builder toBuilder()

getProtectionCapabilities

public List<ProtectionCapability> getProtectionCapabilities()

An ordered list that references OCI-managed protection capabilities.

Referenced protection capabilities are not necessarily executed in order of appearance. Their execution order is decided at runtime for improved performance. The array cannot contain entries with the same pair of capability key and version more than once.

Returns:

the value

getProtectionCapabilitySettings

public ProtectionCapabilitySettings getProtectionCapabilitySettings()

getIsBodyInspectionEnabled

public Boolean getIsBodyInspectionEnabled()

Enables/disables body inspection for this protection rule.

Only Protection Rules in RequestProtection can have this option enabled. Response body inspection will be available at a later date.

Returns:

the value

toString

public String toString()

Overrides:

toString in class WebAppFirewallPolicyRule

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class WebAppFirewallPolicyRule

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class WebAppFirewallPolicyRule

hashCode

public int hashCode()

Overrides:

hashCode in class WebAppFirewallPolicyRule