com.google.recaptchaenterprise.v1

Interface WebKeySettingsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

WebKeySettings, WebKeySettings.Builder

public interface WebKeySettingsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAllowAllDomains() Optional.
boolean	getAllowAmpTraffic() Optional.
String	getAllowedDomains(int index) Optional.
com.google.protobuf.ByteString	getAllowedDomainsBytes(int index) Optional.
int	getAllowedDomainsCount() Optional.
List<String>	getAllowedDomainsList() Optional.
WebKeySettings.ChallengeSecurityPreference	getChallengeSecurityPreference() Optional.
int	getChallengeSecurityPreferenceValue() Optional.
WebKeySettings.IntegrationType	getIntegrationType() Required.
int	getIntegrationTypeValue() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getAllowAllDomains

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:

The allowAllDomains.

getAllowedDomainsList

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:

A list containing the allowedDomains.

getAllowedDomainsCount

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:

The count of allowedDomains.

getAllowedDomains

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];

Parameters:

index - The index of the element to return.

Returns:

The allowedDomains at the given index.

getAllowedDomainsBytes

com.google.protobuf.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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the allowedDomains at the given index.

getAllowAmpTraffic

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:

The allowAmpTraffic.

getIntegrationTypeValue

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:

The enum numeric value on the wire for integrationType.

getIntegrationType

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:

The integrationType.

getChallengeSecurityPreferenceValue

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:

The enum numeric value on the wire for challengeSecurityPreference.

getChallengeSecurityPreference

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:

The challengeSecurityPreference.