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

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

A complete configuration set containing multiple grouped rules defining the behavior of reCAPTCHA for fraud detection and prevention.

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

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. Resource name for this policy. Format: "projects/{project}/keys/{key}/policy" for a policy under a key.
`↳ client_settings`	`ClientSettings` Required. Configuration for clients protected by this policy.
`↳ challenge_rule_groups`	`array<ChallengeRuleGroup>` Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

getName

Identifier. Resource name for this policy.

Format: "projects/{project}/keys/{key}/policy" for a policy under a key.

Returns
Type	Description
`string`

setName

Identifier. Resource name for this policy.

Format: "projects/{project}/keys/{key}/policy" for a policy under a key.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getClientSettings

Required. Configuration for clients protected by this policy.

Returns
Type	Description
`ClientSettings\|null`

hasClientSettings

clearClientSettings

setClientSettings