Class WebKeySettings.Builder

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.v1beta1.WebKeySettings

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
NameDescription
valuesIterable<String>

The allowedDomains to add.

Returns
TypeDescription
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
NameDescription
valueString

The allowedDomains to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the allowedDomains to add.

Returns
TypeDescription
WebKeySettings.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WebKeySettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WebKeySettings.Builder
Overrides

build()

public WebKeySettings build()
Returns
TypeDescription
WebKeySettings

buildPartial()

public WebKeySettings buildPartial()
Returns
TypeDescription
WebKeySettings

clear()

public WebKeySettings.Builder clear()
Returns
TypeDescription
WebKeySettings.Builder
Overrides

clearAllowAmpTraffic()

public WebKeySettings.Builder clearAllowAmpTraffic()

Whether this key can be used on AMP (Accelerated Mobile Pages) websites.

bool allow_amp_traffic = 2;

Returns
TypeDescription
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
TypeDescription
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_CHALLENGE and INVISIBLE_CHALLENGE.

.google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5;

Returns
TypeDescription
WebKeySettings.Builder

This builder for chaining.

clearEnforceAllowedDomains()

public WebKeySettings.Builder clearEnforceAllowedDomains()

Whether allowed_domains is enforced or not.

bool enforce_allowed_domains = 3;

Returns
TypeDescription
WebKeySettings.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public WebKeySettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
WebKeySettings.Builder
Overrides

clearIntegrationType()

public WebKeySettings.Builder clearIntegrationType()

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

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

Returns
TypeDescription
WebKeySettings.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public WebKeySettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
WebKeySettings.Builder
Overrides

clone()

public WebKeySettings.Builder clone()
Returns
TypeDescription
WebKeySettings.Builder
Overrides

getAllowAmpTraffic()

public boolean getAllowAmpTraffic()

Whether this key can be used on AMP (Accelerated Mobile Pages) websites.

bool allow_amp_traffic = 2;

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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_CHALLENGE and INVISIBLE_CHALLENGE.

.google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5;

Returns
TypeDescription
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_CHALLENGE and INVISIBLE_CHALLENGE.

.google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for challengeSecurityPreference.

getDefaultInstanceForType()

public WebKeySettings getDefaultInstanceForType()
Returns
TypeDescription
WebKeySettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnforceAllowedDomains()

public boolean getEnforceAllowedDomains()

Whether allowed_domains is enforced or not.

bool enforce_allowed_domains = 3;

Returns
TypeDescription
boolean

The enforceAllowedDomains.

getIntegrationType()

public WebKeySettings.IntegrationType getIntegrationType()

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

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

Returns
TypeDescription
WebKeySettings.IntegrationType

The integrationType.

getIntegrationTypeValue()

public int getIntegrationTypeValue()

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

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

Returns
TypeDescription
int

The enum numeric value on the wire for integrationType.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WebKeySettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WebKeySettings.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public WebKeySettings.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
WebKeySettings.Builder
Overrides

mergeFrom(WebKeySettings other)

public WebKeySettings.Builder mergeFrom(WebKeySettings other)
Parameter
NameDescription
otherWebKeySettings
Returns
TypeDescription
WebKeySettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WebKeySettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WebKeySettings.Builder
Overrides

setAllowAmpTraffic(boolean value)

public WebKeySettings.Builder setAllowAmpTraffic(boolean value)

Whether this key can be used on AMP (Accelerated Mobile Pages) websites.

bool allow_amp_traffic = 2;

Parameter
NameDescription
valueboolean

The allowAmpTraffic to set.

Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The allowedDomains to set.

Returns
TypeDescription
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_CHALLENGE and INVISIBLE_CHALLENGE.

.google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5;

Parameter
NameDescription
valueWebKeySettings.ChallengeSecurityPreference

The challengeSecurityPreference to set.

Returns
TypeDescription
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_CHALLENGE and INVISIBLE_CHALLENGE.

.google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5;

Parameter
NameDescription
valueint

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

Returns
TypeDescription
WebKeySettings.Builder

This builder for chaining.

setEnforceAllowedDomains(boolean value)

public WebKeySettings.Builder setEnforceAllowedDomains(boolean value)

Whether allowed_domains is enforced or not.

bool enforce_allowed_domains = 3;

Parameter
NameDescription
valueboolean

The enforceAllowedDomains to set.

Returns
TypeDescription
WebKeySettings.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public WebKeySettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WebKeySettings.Builder
Overrides

setIntegrationType(WebKeySettings.IntegrationType value)

public WebKeySettings.Builder setIntegrationType(WebKeySettings.IntegrationType value)

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

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

Parameter
NameDescription
valueWebKeySettings.IntegrationType

The integrationType to set.

Returns
TypeDescription
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.v1beta1.WebKeySettings.IntegrationType integration_type = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueint

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

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
WebKeySettings.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final WebKeySettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WebKeySettings.Builder
Overrides