Interface WebKeySettingsOrBuilder (3.51.0)

Version 3.51.0

• 3.52.0 (latest)
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.12
• 2.6.1
• 2.5.0
• 2.4.10
• 2.3.1

public interface WebKeySettingsOrBuilder 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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The allowAllDomains.

getAllowAmpTraffic()

public abstract boolean getAllowAmpTraffic()

Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.

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

Returns
Type	Description
boolean	The allowAmpTraffic.

getAllowedDomains(int index)

public abstract String getAllowedDomains(int index)

Optional. Domains or subdomains of websites allowed to use the key. 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'

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 key. 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'

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 key. 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'

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 key. 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'

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

Returns
Type	Description
List<String>	A list containing the allowedDomains.

getChallengeSecurityPreference()

public abstract WebKeySettings.ChallengeSecurityPreference getChallengeSecurityPreference()

Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE.

.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
WebKeySettings.ChallengeSecurityPreference	The challengeSecurityPreference.

getChallengeSecurityPreferenceValue()

public abstract int getChallengeSecurityPreferenceValue()

Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE.

.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for challengeSecurityPreference.

getIntegrationType()

public abstract WebKeySettings.IntegrationType getIntegrationType()

Required. Describes how this key is integrated with the website.

.google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType integration_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
WebKeySettings.IntegrationType	The integrationType.

getIntegrationTypeValue()

public abstract int getIntegrationTypeValue()

Required. Describes how this key is integrated with the website.

.google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType integration_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for integrationType.