Class WebKeySettings (3.4.0)
Version 3.4.0keyboard_arrow_down
public final class WebKeySettings extends GeneratedMessageV3 implements WebKeySettingsOrBuilder
Settings specific to keys that can be used by websites.
Protobuf type google.cloud.recaptchaenterprise.v1.WebKeySettings
Static Fields
ALLOWED_DOMAINS_FIELD_NUMBER
public static final int ALLOWED_DOMAINS_FIELD_NUMBER
Field Value
ALLOW_ALL_DOMAINS_FIELD_NUMBER
public static final int ALLOW_ALL_DOMAINS_FIELD_NUMBER
Field Value
ALLOW_AMP_TRAFFIC_FIELD_NUMBER
public static final int ALLOW_AMP_TRAFFIC_FIELD_NUMBER
Field Value
CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER
public static final int CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER
Field Value
INTEGRATION_TYPE_FIELD_NUMBER
public static final int INTEGRATION_TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static WebKeySettings getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static WebKeySettings . Builder newBuilder ()
Returns
newBuilder(WebKeySettings prototype)
public static WebKeySettings . Builder newBuilder ( WebKeySettings prototype )
Parameter
Returns
public static WebKeySettings parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static WebKeySettings parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static WebKeySettings parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WebKeySettings parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static WebKeySettings parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WebKeySettings parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static WebKeySettings parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static WebKeySettings parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static WebKeySettings parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static WebKeySettings parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static WebKeySettings parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WebKeySettings parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<WebKeySettings> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getAllowAllDomains()
public boolean getAllowAllDomains ()
If set to true, it means allowed_domains will not be enforced.
bool allow_all_domains = 3;
Returns
Type Description
boolean The allowAllDomains.
getAllowAmpTraffic()
public boolean getAllowAmpTraffic ()
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;
Returns
Type Description
boolean The allowAmpTraffic.
getAllowedDomains(int index)
public String getAllowedDomains ( int index )
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;
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 ByteString getAllowedDomainsBytes ( int index )
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;
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 int getAllowedDomainsCount ()
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;
Returns
Type Description
int The count of allowedDomains.
getAllowedDomainsList()
public ProtocolStringList getAllowedDomainsList ()
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;
Returns
getChallengeSecurityPreference()
public WebKeySettings . ChallengeSecurityPreference getChallengeSecurityPreference ()
Settings for the frequency and difficulty at which this key triggers
captcha challenges. This should only be specified for IntegrationTypes
CHECKBOX and INVISIBLE.
.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5;
Returns
getChallengeSecurityPreferenceValue()
public int getChallengeSecurityPreferenceValue ()
Settings for the frequency and difficulty at which this key triggers
captcha challenges. This should only be specified for IntegrationTypes
CHECKBOX and INVISIBLE.
.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5;
Returns
Type Description
int The enum numeric value on the wire for challengeSecurityPreference.
getDefaultInstanceForType()
public WebKeySettings getDefaultInstanceForType ()
Returns
getIntegrationType()
public 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
getIntegrationTypeValue()
public 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.
getParserForType()
public Parser<WebKeySettings> getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public WebKeySettings . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WebKeySettings . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public WebKeySettings . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
