@Generated(value="OracleSDKGenerator", comments="API Version: 20181116") public final class ProtectionRuleExclusion extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Allows specified types of requests to bypass the protection rule. If a request matches any of the
criteria in the exclusions
field, the protection rule will not be executed. Rules can
have more than one exclusion and exclusions are applied to requests disjunctively, meaning the
specified exclusion strings are independently matched against the specified targets of a request.
The first target to match a specified string will trigger an exclusion. Example: If the
following exclusions are defined for a protection rule:
"action": "BLOCK", "exclusions": [ { "target":"REQUEST_COOKIES", "exclusions":["example.com", "12345", "219ffwef9w0f"] }, { "target":"REQUEST_COOKIE_NAMES", "exclusions":["OAMAuthnCookie", "JSESSIONID", "HCM-PSJSESSIONID"] } ], "key": "1000000",
A request with the cookie name sessionid
would trigger an exclusion. A request with
the cookie name yourcompany.com
would *not* trigger and exclusion.
Note: Objects should always be created or deserialized using the ProtectionRuleExclusion.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 ProtectionRuleExclusion.Builder
, which maintain a
set of all explicitly set fields called ProtectionRuleExclusion.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
).
Modifier and Type | Class and Description |
---|---|
static class |
ProtectionRuleExclusion.Builder |
static class |
ProtectionRuleExclusion.Target
The target of the exclusion.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
ProtectionRuleExclusion(ProtectionRuleExclusion.Target target,
List<String> exclusions)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static ProtectionRuleExclusion.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
List<String> |
getExclusions() |
ProtectionRuleExclusion.Target |
getTarget()
The target of the exclusion.
|
int |
hashCode() |
ProtectionRuleExclusion.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"target","exclusions"}) public ProtectionRuleExclusion(ProtectionRuleExclusion.Target target, List<String> exclusions)
public static ProtectionRuleExclusion.Builder builder()
Create a new builder.
public ProtectionRuleExclusion.Builder toBuilder()
public ProtectionRuleExclusion.Target getTarget()
The target of the exclusion.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.