Send feedback
Class WebKeySettings (3.51.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.51.0 keyboard_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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALLOWED_DOMAINS_FIELD_NUMBER
public static final int ALLOWED_DOMAINS_FIELD_NUMBER
Field Value
Type Description
int
ALLOW_ALL_DOMAINS_FIELD_NUMBER
public static final int ALLOW_ALL_DOMAINS_FIELD_NUMBER
Field Value
Type Description
int
ALLOW_AMP_TRAFFIC_FIELD_NUMBER
public static final int ALLOW_AMP_TRAFFIC_FIELD_NUMBER
Field Value
Type Description
int
CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER
public static final int CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER
Field Value
Type Description
int
INTEGRATION_TYPE_FIELD_NUMBER
public static final int INTEGRATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static WebKeySettings getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static WebKeySettings . Builder newBuilder ()
newBuilder(WebKeySettings prototype)
public static WebKeySettings . Builder newBuilder ( WebKeySettings prototype )
public static WebKeySettings parseDelimitedFrom ( InputStream input )
public static WebKeySettings parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static WebKeySettings parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WebKeySettings parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static WebKeySettings parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WebKeySettings parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static WebKeySettings parseFrom ( CodedInputStream input )
public static WebKeySettings parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static WebKeySettings parseFrom ( InputStream input )
public static WebKeySettings parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static WebKeySettings parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WebKeySettings parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<WebKeySettings> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getAllowAllDomains()
public 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 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 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
indexint 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 )
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
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the allowedDomains at the given index.
getAllowedDomainsCount()
public 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 ProtocolStringList 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];
getChallengeSecurityPreference()
public 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];
getChallengeSecurityPreferenceValue()
public 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.
getDefaultInstanceForType()
public WebKeySettings getDefaultInstanceForType ()
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];
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 ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public WebKeySettings . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WebKeySettings . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public WebKeySettings . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
