@Generated(value="OracleSDKGenerator", comments="API Version: 20181116") public final class HumanInteractionChallenge extends Object
The human interaction challenge settings. The human interaction challenge checks various event listeners in the user’s browser to determine if there is a human user making a request.
Note: Objects should always be created or deserialized using the HumanInteractionChallenge.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 HumanInteractionChallenge.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
HumanInteractionChallenge.Action
The action to take against requests from detected bots.
|
static class |
HumanInteractionChallenge.Builder |
| Constructor and Description |
|---|
HumanInteractionChallenge(Boolean isEnabled,
HumanInteractionChallenge.Action action,
Integer failureThreshold,
Integer actionExpirationInSeconds,
Integer failureThresholdExpirationInSeconds,
Integer interactionThreshold,
Integer recordingPeriodInSeconds,
Header setHttpHeader,
BlockChallengeSettings challengeSettings,
Boolean isNatEnabled)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static HumanInteractionChallenge.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
HumanInteractionChallenge.Action |
getAction()
The action to take against requests from detected bots.
|
Integer |
getActionExpirationInSeconds()
The number of seconds between challenges for the same IP address.
|
BlockChallengeSettings |
getChallengeSettings() |
Integer |
getFailureThreshold()
The number of failed requests before taking action.
|
Integer |
getFailureThresholdExpirationInSeconds()
The number of seconds before the failure threshold resets.
|
Integer |
getInteractionThreshold()
The number of interactions required to pass the challenge.
|
Boolean |
getIsEnabled()
Enables or disables the human interaction challenge Web Application Firewall feature.
|
Boolean |
getIsNatEnabled()
When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.
|
Integer |
getRecordingPeriodInSeconds()
The number of seconds to record the interactions from the user.
|
Header |
getSetHttpHeader()
Adds an additional HTTP header to requests that fail the challenge before being passed to the origin.
|
int |
hashCode() |
HumanInteractionChallenge.Builder |
toBuilder() |
String |
toString() |
@Deprecated @ConstructorProperties(value={"isEnabled","action","failureThreshold","actionExpirationInSeconds","failureThresholdExpirationInSeconds","interactionThreshold","recordingPeriodInSeconds","setHttpHeader","challengeSettings","isNatEnabled"}) public HumanInteractionChallenge(Boolean isEnabled, HumanInteractionChallenge.Action action, Integer failureThreshold, Integer actionExpirationInSeconds, Integer failureThresholdExpirationInSeconds, Integer interactionThreshold, Integer recordingPeriodInSeconds, Header setHttpHeader, BlockChallengeSettings challengeSettings, Boolean isNatEnabled)
public static HumanInteractionChallenge.Builder builder()
Create a new builder.
public HumanInteractionChallenge.Builder toBuilder()
public Boolean getIsEnabled()
Enables or disables the human interaction challenge Web Application Firewall feature.
public HumanInteractionChallenge.Action getAction()
The action to take against requests from detected bots. If unspecified, defaults to DETECT.
public Integer getFailureThreshold()
The number of failed requests before taking action. If unspecified, defaults to 10.
public Integer getActionExpirationInSeconds()
The number of seconds between challenges for the same IP address. If unspecified, defaults to 60.
public Integer getFailureThresholdExpirationInSeconds()
The number of seconds before the failure threshold resets. If unspecified, defaults to 60.
public Integer getInteractionThreshold()
The number of interactions required to pass the challenge. If unspecified, defaults to 3.
public Integer getRecordingPeriodInSeconds()
The number of seconds to record the interactions from the user. If unspecified, defaults to 15.
public Header getSetHttpHeader()
Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the action is set to DETECT.
public BlockChallengeSettings getChallengeSettings()
public Boolean getIsNatEnabled()
When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.
Copyright © 2016–2022. All rights reserved.