com.google.recaptchaenterprise.v1

Class WebKeySettings

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.recaptchaenterprise.v1.WebKeySettings

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WebKeySettingsOrBuilder, Serializable

public final class WebKeySettings
extends com.google.protobuf.GeneratedMessageV3
implements WebKeySettingsOrBuilder

 Settings specific to keys that can be used by websites.
 

Protobuf type google.cloud.recaptchaenterprise.v1.WebKeySettings

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebKeySettings.Builder Settings specific to keys that can be used by websites.
static class	WebKeySettings.ChallengeSecurityPreference Enum that represents the possible challenge frequency and difficulty configurations for a web key.
static class	WebKeySettings.IntegrationType Enum that represents the integration types for web keys.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_ALL_DOMAINS_FIELD_NUMBER
static int	ALLOW_AMP_TRAFFIC_FIELD_NUMBER
static int	ALLOWED_DOMAINS_FIELD_NUMBER
static int	CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER
static int	INTEGRATION_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getAllowAllDomains() If set to true, it means allowed_domains will not be enforced.
boolean	getAllowAmpTraffic() If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites.
String	getAllowedDomains(int index) Domains or subdomains of websites allowed to use the key.
com.google.protobuf.ByteString	getAllowedDomainsBytes(int index) Domains or subdomains of websites allowed to use the key.
int	getAllowedDomainsCount() Domains or subdomains of websites allowed to use the key.
com.google.protobuf.ProtocolStringList	getAllowedDomainsList() Domains or subdomains of websites allowed to use the key.
WebKeySettings.ChallengeSecurityPreference	getChallengeSecurityPreference() Settings for the frequency and difficulty at which this key triggers captcha challenges.
int	getChallengeSecurityPreferenceValue() Settings for the frequency and difficulty at which this key triggers captcha challenges.
static WebKeySettings	getDefaultInstance()
WebKeySettings	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
WebKeySettings.IntegrationType	getIntegrationType() Required.
int	getIntegrationTypeValue() Required.
com.google.protobuf.Parser<WebKeySettings>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static WebKeySettings.Builder	newBuilder()
static WebKeySettings.Builder	newBuilder(WebKeySettings prototype)
WebKeySettings.Builder	newBuilderForType()
protected WebKeySettings.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static WebKeySettings	parseDelimitedFrom(InputStream input)
static WebKeySettings	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WebKeySettings	parseFrom(byte[] data)
static WebKeySettings	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WebKeySettings	parseFrom(ByteBuffer data)
static WebKeySettings	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WebKeySettings	parseFrom(com.google.protobuf.ByteString data)
static WebKeySettings	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WebKeySettings	parseFrom(com.google.protobuf.CodedInputStream input)
static WebKeySettings	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WebKeySettings	parseFrom(InputStream input)
static WebKeySettings	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<WebKeySettings>	parser()
WebKeySettings.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ALLOW_ALL_DOMAINS_FIELD_NUMBER

public static final int ALLOW_ALL_DOMAINS_FIELD_NUMBER

See Also:

Constant Field Values

ALLOWED_DOMAINS_FIELD_NUMBER

public static final int ALLOWED_DOMAINS_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_AMP_TRAFFIC_FIELD_NUMBER

public static final int ALLOW_AMP_TRAFFIC_FIELD_NUMBER

See Also:

Constant Field Values

INTEGRATION_TYPE_FIELD_NUMBER

public static final int INTEGRATION_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER

public static final int CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getAllowAllDomains

public boolean getAllowAllDomains()

 If set to true, it means allowed_domains will not be enforced.
 

bool allow_all_domains = 3;

Specified by:

getAllowAllDomains in interface WebKeySettingsOrBuilder

Returns:

The allowAllDomains.

getAllowedDomainsList

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

Specified by:

getAllowedDomainsList in interface WebKeySettingsOrBuilder

Returns:

A list containing the allowedDomains.

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;

Specified by:

getAllowedDomainsCount in interface WebKeySettingsOrBuilder

Returns:

The count of allowedDomains.

getAllowedDomains

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;

Specified by:

getAllowedDomains in interface WebKeySettingsOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The allowedDomains at the given index.

getAllowedDomainsBytes

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

Specified by:

getAllowedDomainsBytes in interface WebKeySettingsOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the allowedDomains at the given index.

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;

Specified by:

getAllowAmpTraffic in interface WebKeySettingsOrBuilder

Returns:

The allowAmpTraffic.

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

Specified by:

getIntegrationTypeValue in interface WebKeySettingsOrBuilder

Returns:

The enum numeric value on the wire for integrationType.

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

Specified by:

getIntegrationType in interface WebKeySettingsOrBuilder

Returns:

The integrationType.

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;

Specified by:

getChallengeSecurityPreferenceValue in interface WebKeySettingsOrBuilder

Returns:

The enum numeric value on the wire for challengeSecurityPreference.

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;

Specified by:

getChallengeSecurityPreference in interface WebKeySettingsOrBuilder

Returns:

The challengeSecurityPreference.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static WebKeySettings parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebKeySettings parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebKeySettings parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebKeySettings parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebKeySettings parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebKeySettings parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebKeySettings parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static WebKeySettings parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static WebKeySettings parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static WebKeySettings parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static WebKeySettings parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static WebKeySettings parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public WebKeySettings.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static WebKeySettings.Builder newBuilder()

newBuilder

public static WebKeySettings.Builder newBuilder(WebKeySettings prototype)

toBuilder

public WebKeySettings.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected WebKeySettings.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static WebKeySettings getDefaultInstance()

parser

public static com.google.protobuf.Parser<WebKeySettings> parser()

getParserForType

public com.google.protobuf.Parser<WebKeySettings> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public WebKeySettings getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder