reCAPTCHA Enterprise V1 API - Class Google::Cloud::RecaptchaEnterprise::V1::ChallengeRule (v1.12.2)

Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::ChallengeRule.

A rule to configure the behavior of reCAPTCHA for conditionally presenting a challenge.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#challenge

def challenge() -> ::Google::Cloud::RecaptchaEnterprise::V1::ChallengeRule::ChallengeOutcome
Returns

#challenge=

def challenge=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::ChallengeRule::ChallengeOutcome
Parameter
Returns

#condition

def condition() -> ::String
Returns
  • (::String) —

    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"

#condition=

def condition=(value) -> ::String
Parameter
  • value (::String) —

    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"
Returns
  • (::String) —

    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"

#no_challenge

def no_challenge() -> ::Google::Cloud::RecaptchaEnterprise::V1::ChallengeRule::NoChallengeOutcome
Returns

#no_challenge=

def no_challenge=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::ChallengeRule::NoChallengeOutcome
Parameter
Returns