Class WebKeySettings.ChallengeSettings.Builder (3.79.0)

public static final class WebKeySettings.ChallengeSettings.Builder extends GeneratedMessageV3.Builder<WebKeySettings.ChallengeSettings.Builder> implements WebKeySettings.ChallengeSettingsOrBuilder

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

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WebKeySettings.ChallengeSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides

build()

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

buildPartial()

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

clear()

public WebKeySettings.ChallengeSettings.Builder clear()
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides

clearActionSettings()

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

clearDefaultSettings()

public WebKeySettings.ChallengeSettings.Builder clearDefaultSettings()

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.ChallengeSettings.Builder

clearField(Descriptors.FieldDescriptor field)

public WebKeySettings.ChallengeSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public WebKeySettings.ChallengeSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides

clone()

public WebKeySettings.ChallengeSettings.Builder clone()
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides

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

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.

getDefaultSettingsBuilder()

public WebKeySettings.ActionSettings.Builder getDefaultSettingsBuilder()

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.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableActionSettings() (deprecated)

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

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,ActionSettings>

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDefaultSettings(WebKeySettings.ActionSettings value)

public WebKeySettings.ChallengeSettings.Builder mergeDefaultSettings(WebKeySettings.ActionSettings value)

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];

Parameter
Name Description
value WebKeySettings.ActionSettings
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WebKeySettings.ChallengeSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public WebKeySettings.ChallengeSettings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides

mergeFrom(WebKeySettings.ChallengeSettings other)

public WebKeySettings.ChallengeSettings.Builder mergeFrom(WebKeySettings.ChallengeSettings other)
Parameter
Name Description
other WebKeySettings.ChallengeSettings
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WebKeySettings.ChallengeSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides

putActionSettings(String key, WebKeySettings.ActionSettings value)

public WebKeySettings.ChallengeSettings.Builder putActionSettings(String key, WebKeySettings.ActionSettings value)

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
value WebKeySettings.ActionSettings
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder

putActionSettingsBuilderIfAbsent(String key)

public WebKeySettings.ActionSettings.Builder putActionSettingsBuilderIfAbsent(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.Builder

putAllActionSettings(Map<String,WebKeySettings.ActionSettings> values)

public WebKeySettings.ChallengeSettings.Builder putAllActionSettings(Map<String,WebKeySettings.ActionSettings> values)

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
values Map<String,ActionSettings>
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder

removeActionSettings(String key)

public WebKeySettings.ChallengeSettings.Builder removeActionSettings(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.ChallengeSettings.Builder

setDefaultSettings(WebKeySettings.ActionSettings value)

public WebKeySettings.ChallengeSettings.Builder setDefaultSettings(WebKeySettings.ActionSettings value)

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];

Parameter
Name Description
value WebKeySettings.ActionSettings
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder

setDefaultSettings(WebKeySettings.ActionSettings.Builder builderForValue)

public WebKeySettings.ChallengeSettings.Builder setDefaultSettings(WebKeySettings.ActionSettings.Builder builderForValue)

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];

Parameter
Name Description
builderForValue WebKeySettings.ActionSettings.Builder
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WebKeySettings.ChallengeSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides

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

public WebKeySettings.ChallengeSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final WebKeySettings.ChallengeSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WebKeySettings.ChallengeSettings.Builder
Overrides