Class WebKeySettings.Builder (2.5.0)

Version 2.5.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 static final class WebKeySettings.Builder extends GeneratedMessageV3.Builder<WebKeySettings.Builder> implements WebKeySettingsOrBuilder

Settings specific to keys that can be used by websites.

Protobuf type google.cloud.recaptchaenterprise.v1.WebKeySettings

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WebKeySettings.Builder

Implements

WebKeySettingsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllAllowedDomains(Iterable<String> values)

public WebKeySettings.Builder addAllAllowedDomains(Iterable<String> values)

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
values	Iterable<String> The allowedDomains to add.

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

addAllowedDomains(String value)

public WebKeySettings.Builder addAllowedDomains(String value)

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
value	String The allowedDomains to add.

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

addAllowedDomainsBytes(ByteString value)

public WebKeySettings.Builder addAllowedDomainsBytes(ByteString value)

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
value	ByteString The bytes of the allowedDomains to add.

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WebKeySettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
WebKeySettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public WebKeySettings build()

Returns

Type	Description
WebKeySettings

buildPartial()

public WebKeySettings buildPartial()

Returns

Type	Description
WebKeySettings

clear()

public WebKeySettings.Builder clear()

Returns

Type	Description
WebKeySettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAllowAllDomains()

public WebKeySettings.Builder clearAllowAllDomains()

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

bool allow_all_domains = 3;

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

clearAllowAmpTraffic()

public WebKeySettings.Builder clearAllowAmpTraffic()

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
WebKeySettings.Builder	This builder for chaining.

clearAllowedDomains()

public WebKeySettings.Builder clearAllowedDomains()

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
WebKeySettings.Builder	This builder for chaining.

clearChallengeSecurityPreference()

public WebKeySettings.Builder clearChallengeSecurityPreference()

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
WebKeySettings.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public WebKeySettings.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
WebKeySettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIntegrationType()

public WebKeySettings.Builder clearIntegrationType()

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.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public WebKeySettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
WebKeySettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public WebKeySettings.Builder clone()

Returns

Type	Description
WebKeySettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Type	Description
ProtocolStringList	A list containing the allowedDomains.

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

Type	Description
WebKeySettings.ChallengeSecurityPreference	The challengeSecurityPreference.

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

Type	Description
WebKeySettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Type	Description
WebKeySettings.IntegrationType	The integrationType.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WebKeySettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
WebKeySettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public WebKeySettings.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
WebKeySettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(WebKeySettings other)

public WebKeySettings.Builder mergeFrom(WebKeySettings other)

Parameter

Name	Description
other	WebKeySettings

Returns

Type	Description
WebKeySettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WebKeySettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
WebKeySettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAllowAllDomains(boolean value)

public WebKeySettings.Builder setAllowAllDomains(boolean value)

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

bool allow_all_domains = 3;

Parameter

Name	Description
value	boolean The allowAllDomains to set.

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

setAllowAmpTraffic(boolean value)

public WebKeySettings.Builder setAllowAmpTraffic(boolean value)

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;

Parameter

Name	Description
value	boolean The allowAmpTraffic to set.

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

setAllowedDomains(int index, String value)

public WebKeySettings.Builder setAllowedDomains(int index, String value)

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;

Parameters

Name	Description
index	int The index to set the value at.
value	String The allowedDomains to set.

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

setChallengeSecurityPreference(WebKeySettings.ChallengeSecurityPreference value)

public WebKeySettings.Builder setChallengeSecurityPreference(WebKeySettings.ChallengeSecurityPreference value)

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;

Parameter

Name	Description
value	WebKeySettings.ChallengeSecurityPreference The challengeSecurityPreference to set.

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

setChallengeSecurityPreferenceValue(int value)

public WebKeySettings.Builder setChallengeSecurityPreferenceValue(int value)

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;

Parameter

Name	Description
value	int The enum numeric value on the wire for challengeSecurityPreference to set.

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public WebKeySettings.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
WebKeySettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIntegrationType(WebKeySettings.IntegrationType value)

public WebKeySettings.Builder setIntegrationType(WebKeySettings.IntegrationType value)

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

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

Parameter

Name	Description
value	WebKeySettings.IntegrationType The integrationType to set.

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

setIntegrationTypeValue(int value)

public WebKeySettings.Builder setIntegrationTypeValue(int value)

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

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

Parameter

Name	Description
value	int The enum numeric value on the wire for integrationType to set.

Returns

Type	Description
WebKeySettings.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public WebKeySettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
WebKeySettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final WebKeySettings.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
WebKeySettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)