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

2.5.3 (latest) 2.3.1 2.2.1 2.1.3 2.0.1 1.17.2 1.16.1 1.15.0 1.14.0 1.13.0 1.12.2 1.8.0 1.7.0 1.6.0 1.5.2 1.4.2 1.3.2 1.2.6

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

Configuration for clients to protect with reCAPTCHA.

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

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ allowed_domains	string[] Optional. Domains or subdomains of websites allowed to use the policy. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com' Each policy supports a maximum of 250 domains. To use a policy on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.
↳ allow_all_domains	bool Optional. If set to true, it means allowed_domains are not enforced.
↳ protected_endpoint_group	ProtectedEndpointGroup Optional. Configuration for all API endpoints to protect with reCAPTCHA. If this field is not set, reCAPTCHA will not automatically request tokens on any API endpoints.

getAllowedDomains

Optional. Domains or subdomains of websites allowed to use the policy. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment.

Examples: 'example.com' or 'subdomain.example.com' Each policy supports a maximum of 250 domains. To use a policy on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.

Returns
Type	Description
Google\Protobuf\RepeatedField<string>

setAllowedDomains

Optional. Domains or subdomains of websites allowed to use the policy. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment.

Examples: 'example.com' or 'subdomain.example.com' Each policy supports a maximum of 250 domains. To use a policy on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getAllowAllDomains

Optional. If set to true, it means allowed_domains are not enforced.

Returns
Type	Description
bool

setAllowAllDomains

Optional. If set to true, it means allowed_domains are not enforced.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getProtectedEndpointGroup

Optional. Configuration for all API endpoints to protect with reCAPTCHA. If this field is not set, reCAPTCHA will not automatically request tokens on any API endpoints.

Returns
Type	Description
ProtectedEndpointGroup|null

hasProtectedEndpointGroup

clearProtectedEndpointGroup

setProtectedEndpointGroup

Optional. Configuration for all API endpoints to protect with reCAPTCHA. If this field is not set, reCAPTCHA will not automatically request tokens on any API endpoints.

Parameter
Name	Description
var	ProtectedEndpointGroup

Returns
Type	Description
$this