Class WebKeySettings (3.79.0) 

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

Inheritance

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

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

CHALLENGE_SETTINGS_FIELD_NUMBER

public static final int CHALLENGE_SETTINGS_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()
Returns
Type Description
WebKeySettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static WebKeySettings.Builder newBuilder()
Returns
Type Description
WebKeySettings.Builder

newBuilder(WebKeySettings prototype)

public static WebKeySettings.Builder newBuilder(WebKeySettings prototype)
Parameter
Name Description
prototype WebKeySettings
Returns
Type Description
WebKeySettings.Builder

parseDelimitedFrom(InputStream input)

public static WebKeySettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WebKeySettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WebKeySettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WebKeySettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WebKeySettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WebKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WebKeySettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WebKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WebKeySettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WebKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WebKeySettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WebKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WebKeySettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WebKeySettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WebKeySettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WebKeySettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WebKeySettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WebKeySettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WebKeySettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WebKeySettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WebKeySettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WebKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WebKeySettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WebKeySettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WebKeySettings> parser()
Returns
Type Description
Parser<WebKeySettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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' Each key supports a maximum of 250 domains. To use a key on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.

repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];

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)

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' Each key supports a maximum of 250 domains. To use a key on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.

repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];

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()

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' Each key supports a maximum of 250 domains. To use a key on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.

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' Each key supports a maximum of 250 domains. To use a key on more domains, set allow_all_domains to true. When this is set, you are responsible for validating the hostname by checking the token_properties.hostname field in each assessment response against your list of allowed domains.

repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the allowedDomains.

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 IntegrationType CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.

.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WebKeySettings.ChallengeSecurityPreference

The challengeSecurityPreference.

getChallengeSecurityPreferenceValue()

public int getChallengeSecurityPreferenceValue()

Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationType CHECKBOX, INVISIBLE or POLICY_BASED_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.

getChallengeSettings()

public WebKeySettings.ChallengeSettings getChallengeSettings()

Optional. Challenge settings.

.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WebKeySettings.ChallengeSettings

The challengeSettings.

getChallengeSettingsOrBuilder()

public WebKeySettings.ChallengeSettingsOrBuilder getChallengeSettingsOrBuilder()

Optional. Challenge settings.

.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WebKeySettings.ChallengeSettingsOrBuilder

getDefaultInstanceForType()

public WebKeySettings getDefaultInstanceForType()
Returns
Type Description
WebKeySettings

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.

getParserForType()

public Parser<WebKeySettings> getParserForType()
Returns
Type Description
Parser<WebKeySettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasChallengeSettings()

public boolean hasChallengeSettings()

Optional. Challenge settings.

.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the challengeSettings field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WebKeySettings.Builder newBuilderForType()
Returns
Type Description
WebKeySettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WebKeySettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WebKeySettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public WebKeySettings.Builder toBuilder()
Returns
Type Description
WebKeySettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException