Class WebKeySettings.ChallengeSettings (3.79.0)

public static final class WebKeySettings.ChallengeSettings extends GeneratedMessageV3 implements WebKeySettings.ChallengeSettingsOrBuilder

Settings for POLICY_BASED_CHALLENGE keys to control when a challenge is triggered.

Protobuf type google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings

Inheritance

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

Static Fields

ACTION_SETTINGS_FIELD_NUMBER

public static final int ACTION_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_SETTINGS_FIELD_NUMBER

public static final int DEFAULT_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WebKeySettings.ChallengeSettings getDefaultInstance()
Returns
Type Description
WebKeySettings.ChallengeSettings

getDescriptor()

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

newBuilder()

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

newBuilder(WebKeySettings.ChallengeSettings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsActionSettings(String key)

public boolean containsActionSettings(String key)

Optional. The action to score threshold map. The action name should be the same as the action name passed in the data-action attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.

map<string, .google.cloud.recaptchaenterprise.v1.WebKeySettings.ActionSettings> action_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActionSettings() (deprecated)

public Map<String,WebKeySettings.ActionSettings> getActionSettings()
Returns
Type Description
Map<String,ActionSettings>

getActionSettingsCount()

public int getActionSettingsCount()

Optional. The action to score threshold map. The action name should be the same as the action name passed in the data-action attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.

map<string, .google.cloud.recaptchaenterprise.v1.WebKeySettings.ActionSettings> action_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getActionSettingsMap()

public Map<String,WebKeySettings.ActionSettings> getActionSettingsMap()

Optional. The action to score threshold map. The action name should be the same as the action name passed in the data-action attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.

map<string, .google.cloud.recaptchaenterprise.v1.WebKeySettings.ActionSettings> action_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,ActionSettings>

getActionSettingsOrDefault(String key, WebKeySettings.ActionSettings defaultValue)

public WebKeySettings.ActionSettings getActionSettingsOrDefault(String key, WebKeySettings.ActionSettings defaultValue)

Optional. The action to score threshold map. The action name should be the same as the action name passed in the data-action attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.

map<string, .google.cloud.recaptchaenterprise.v1.WebKeySettings.ActionSettings> action_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue WebKeySettings.ActionSettings
Returns
Type Description
WebKeySettings.ActionSettings

getActionSettingsOrThrow(String key)

public WebKeySettings.ActionSettings getActionSettingsOrThrow(String key)

Optional. The action to score threshold map. The action name should be the same as the action name passed in the data-action attribute (see https://cloud.google.com/recaptcha/docs/actions-website). Action names are case-insensitive. There is a maximum of 100 action settings. An action name has a maximum length of 100.

map<string, .google.cloud.recaptchaenterprise.v1.WebKeySettings.ActionSettings> action_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
WebKeySettings.ActionSettings

getDefaultInstanceForType()

public WebKeySettings.ChallengeSettings getDefaultInstanceForType()
Returns
Type Description
WebKeySettings.ChallengeSettings

getDefaultSettings()

public WebKeySettings.ActionSettings getDefaultSettings()

Required. Defines when a challenge is triggered (unless the default threshold is overridden for the given action, see action_settings).

.google.cloud.recaptchaenterprise.v1.WebKeySettings.ActionSettings default_settings = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
WebKeySettings.ActionSettings

The defaultSettings.

getDefaultSettingsOrBuilder()

public WebKeySettings.ActionSettingsOrBuilder getDefaultSettingsOrBuilder()

Required. Defines when a challenge is triggered (unless the default threshold is overridden for the given action, see action_settings).

.google.cloud.recaptchaenterprise.v1.WebKeySettings.ActionSettings default_settings = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
WebKeySettings.ActionSettingsOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDefaultSettings()

public boolean hasDefaultSettings()

Required. Defines when a challenge is triggered (unless the default threshold is overridden for the given action, see action_settings).

.google.cloud.recaptchaenterprise.v1.WebKeySettings.ActionSettings default_settings = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the defaultSettings field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WebKeySettings.ChallengeSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WebKeySettings.ChallengeSettings.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.ChallengeSettings.Builder toBuilder()
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder

writeTo(CodedOutputStream output)

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