Package com.oracle.bmc.waas.model

Class ProtectionRule

java.lang.Object

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

com.oracle.bmc.waas.model.ProtectionRule

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181116")
public final class ProtectionRule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The protection rule settings.

Protection rules can allow, block, or trigger an alert if a request meets the parameters of an applied rule.
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.Action	The action to take when the traffic is detected as malicious.
static class	ProtectionRule.Builder

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 key, List<String> modSecurityRuleIds, String name, String description, ProtectionRule.Action action, List<String> labels, List<ProtectionRuleExclusion> exclusions)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ProtectionRule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
ProtectionRule.Action	getAction()	The action to take when the traffic is detected as malicious.
String	getDescription()	The description of the protection rule.
List<ProtectionRuleExclusion>	getExclusions()
String	getKey()	The unique key of the protection rule.
List<String>	getLabels()	The list of labels for the protection rule.
List<String>	getModSecurityRuleIds()	The list of the ModSecurity rule IDs that apply to this protection rule.
String	getName()	The name of the protection rule.
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.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
@ConstructorProperties({"key","modSecurityRuleIds","name","description","action","labels","exclusions"})
public ProtectionRule(String key,
                      List<String> modSecurityRuleIds,
                      String name,
                      String description,
                      ProtectionRule.Action action,
                      List<String> labels,
                      List<ProtectionRuleExclusion> exclusions)

Deprecated.

Method Detail

builder

public static ProtectionRule.Builder builder()

Create a new builder.

toBuilder

public ProtectionRule.Builder toBuilder()

getKey

public String getKey()

The unique key of the protection rule.

Returns:

the value

getModSecurityRuleIds

public List<String> getModSecurityRuleIds()

The list of the ModSecurity rule IDs that apply to this protection rule.

For more information about ModSecurity’s open source WAF rules, see Mod Security’s documentation.

Returns:

the value

getName

public String getName()

The name of the protection rule.

Returns:

the value

getDescription

public String getDescription()

The description of the protection rule.

Returns:

the value

getAction

public ProtectionRule.Action getAction()

The action to take when the traffic is detected as malicious.

If unspecified, defaults to OFF.

Returns:

the value

getLabels

public List<String> getLabels()

The list of labels for the protection rule.

*Note:** Protection rules with a ResponseBody label will have no effect unless isResponseInspected is true.

Returns:

the value

getExclusions

public List<ProtectionRuleExclusion> getExclusions()

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