Class WebKeySettings
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated
public final class WebKeySettings
extends com.google.protobuf.GeneratedMessage
implements WebKeySettingsOrBuilder
Settings specific to keys that can be used by websites.Protobuf type
google.cloud.recaptchaenterprise.v1.WebKeySettings- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classPer-action challenge settings.static interfacestatic final classSettings specific to keys that can be used by websites.static enumEnum that represents the possible challenge frequency and difficulty configurations for a web key.static final classSettings for POLICY_BASED_CHALLENGE keys to control when a challenge is triggered.static interfacestatic enumEnum that represents the integration types for web keys.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanOptional.booleanOptional.getAllowedDomains(int index) Optional.com.google.protobuf.ByteStringgetAllowedDomainsBytes(int index) Optional.intOptional.com.google.protobuf.ProtocolStringListOptional.Optional.intOptional.Optional.Optional.static WebKeySettingsstatic final com.google.protobuf.Descriptors.DescriptorRequired.intRequired.com.google.protobuf.Parser<WebKeySettings>intbooleanOptional.inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic WebKeySettings.Builderstatic WebKeySettings.BuildernewBuilder(WebKeySettings prototype) protected WebKeySettings.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static WebKeySettingsparseDelimitedFrom(InputStream input) static WebKeySettingsparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WebKeySettingsparseFrom(byte[] data) static WebKeySettingsparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WebKeySettingsparseFrom(com.google.protobuf.ByteString data) static WebKeySettingsparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WebKeySettingsparseFrom(com.google.protobuf.CodedInputStream input) static WebKeySettingsparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WebKeySettingsparseFrom(InputStream input) static WebKeySettingsparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WebKeySettingsparseFrom(ByteBuffer data) static WebKeySettingsparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<WebKeySettings>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
ALLOW_ALL_DOMAINS_FIELD_NUMBER
public static final int ALLOW_ALL_DOMAINS_FIELD_NUMBER- See Also:
-
ALLOWED_DOMAINS_FIELD_NUMBER
public static final int ALLOWED_DOMAINS_FIELD_NUMBER- See Also:
-
ALLOW_AMP_TRAFFIC_FIELD_NUMBER
public static final int ALLOW_AMP_TRAFFIC_FIELD_NUMBER- See Also:
-
INTEGRATION_TYPE_FIELD_NUMBER
public static final int INTEGRATION_TYPE_FIELD_NUMBER- See Also:
-
CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER
public static final int CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER- See Also:
-
CHALLENGE_SETTINGS_FIELD_NUMBER
public static final int CHALLENGE_SETTINGS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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];- Specified by:
getAllowAllDomainsin interfaceWebKeySettingsOrBuilder- Returns:
- The allowAllDomains.
-
getAllowedDomainsList
public com.google.protobuf.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];- Specified by:
getAllowedDomainsListin interfaceWebKeySettingsOrBuilder- Returns:
- A list containing the allowedDomains.
-
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];- Specified by:
getAllowedDomainsCountin interfaceWebKeySettingsOrBuilder- Returns:
- The count of allowedDomains.
-
getAllowedDomains
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];- Specified by:
getAllowedDomainsin interfaceWebKeySettingsOrBuilder- 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) 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];- Specified by:
getAllowedDomainsBytesin interfaceWebKeySettingsOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the allowedDomains at the given index.
-
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];- Specified by:
getAllowAmpTrafficin interfaceWebKeySettingsOrBuilder- 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:
getIntegrationTypeValuein interfaceWebKeySettingsOrBuilder- Returns:
- The enum numeric value on the wire for 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:
getIntegrationTypein interfaceWebKeySettingsOrBuilder- Returns:
- The integrationType.
-
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];- Specified by:
getChallengeSecurityPreferenceValuein interfaceWebKeySettingsOrBuilder- Returns:
- The enum numeric value on the wire for 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];- Specified by:
getChallengeSecurityPreferencein interfaceWebKeySettingsOrBuilder- Returns:
- The challengeSecurityPreference.
-
hasChallengeSettings
public boolean hasChallengeSettings()Optional. Challenge settings.
.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasChallengeSettingsin interfaceWebKeySettingsOrBuilder- Returns:
- Whether the challengeSettings field is set.
-
getChallengeSettings
Optional. Challenge settings.
.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getChallengeSettingsin interfaceWebKeySettingsOrBuilder- Returns:
- The challengeSettings.
-
getChallengeSettingsOrBuilder
Optional. Challenge settings.
.google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getChallengeSettingsOrBuilderin interfaceWebKeySettingsOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static WebKeySettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected WebKeySettings.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-