Interface ClientSettingsOrBuilder (3.96.0) 

public interface ClientSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowAllDomains()

public abstract boolean getAllowAllDomains()

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

bool allow_all_domains = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The allowAllDomains.

getAllowedDomains(int index)

public abstract String getAllowedDomains(int index)

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.

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

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The allowedDomains at the given index.

getAllowedDomainsBytes(int index)

public abstract ByteString getAllowedDomainsBytes(int index)

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.

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

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the allowedDomains at the given index.

getAllowedDomainsCount()

public abstract int getAllowedDomainsCount()

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.

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

Returns
Type Description
int

The count of allowedDomains.

getAllowedDomainsList()

public abstract List<String> getAllowedDomainsList()

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.

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

Returns
Type Description
List<String>

A list containing the allowedDomains.

getProtectedEndpointGroup()

public abstract ProtectedEndpointGroup 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.

.google.cloud.recaptchaenterprise.v1.ProtectedEndpointGroup protected_endpoint_group = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtectedEndpointGroup

The protectedEndpointGroup.

getProtectedEndpointGroupOrBuilder()

public abstract ProtectedEndpointGroupOrBuilder getProtectedEndpointGroupOrBuilder()

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.

.google.cloud.recaptchaenterprise.v1.ProtectedEndpointGroup protected_endpoint_group = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtectedEndpointGroupOrBuilder

hasProtectedEndpointGroup()

public abstract boolean hasProtectedEndpointGroup()

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.

.google.cloud.recaptchaenterprise.v1.ProtectedEndpointGroup protected_endpoint_group = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the protectedEndpointGroup field is set.