Google Cloud Recaptcha Enterprise V1 Client - Class ChallengeRuleGroup (2.5.3)

Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class ChallengeRuleGroup.

A collection of challenge rules that applies to one or more actions.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ actions string[]

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

↳ challenge_rules array<ChallengeRule>

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

getActions

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setActions

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getChallengeRules

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

Returns
Type Description
Google\Protobuf\RepeatedField<ChallengeRule>

setChallengeRules

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

Parameter
Name Description
var array<ChallengeRule>
Returns
Type Description
$this