Interface ChallengeRuleOrBuilder (3.96.0) 

public interface ChallengeRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChallenge()

public abstract ChallengeRule.ChallengeOutcome getChallenge()

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Returns
Type Description
ChallengeRule.ChallengeOutcome

The challenge.

getChallengeOrBuilder()

public abstract ChallengeRule.ChallengeOutcomeOrBuilder getChallengeOrBuilder()

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Returns
Type Description
ChallengeRule.ChallengeOutcomeOrBuilder

getCondition()

public abstract String getCondition()

Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition:

  • score
  • user_ip_address
  • user_asn
  • user_agent
  • verified_bots.name

  • verified_bots.bot_type

    Examples:

  • score < 0.5
  • user_ip_address == "123.45.67.89"
  • user_agent.contains("Chrome")
  • score < 0.5 && user_ip_address == "123.45.67.89"

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The condition.

getConditionBytes()

public abstract ByteString getConditionBytes()

Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition:

  • score
  • user_ip_address
  • user_asn
  • user_agent
  • verified_bots.name

  • verified_bots.bot_type

    Examples:

  • score < 0.5
  • user_ip_address == "123.45.67.89"
  • user_agent.contains("Chrome")
  • score < 0.5 && user_ip_address == "123.45.67.89"

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for condition.

getNoChallenge()

public abstract ChallengeRule.NoChallengeOutcome getNoChallenge()

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Returns
Type Description
ChallengeRule.NoChallengeOutcome

The noChallenge.

getNoChallengeOrBuilder()

public abstract ChallengeRule.NoChallengeOutcomeOrBuilder getNoChallengeOrBuilder()

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Returns
Type Description
ChallengeRule.NoChallengeOutcomeOrBuilder

getOutcomeCase()

public abstract ChallengeRule.OutcomeCase getOutcomeCase()
Returns
Type Description
ChallengeRule.OutcomeCase

hasChallenge()

public abstract boolean hasChallenge()

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Returns
Type Description
boolean

Whether the challenge field is set.

hasNoChallenge()

public abstract boolean hasNoChallenge()

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Returns
Type Description
boolean

Whether the noChallenge field is set.