Class ChallengeRuleGroup.Builder (3.96.0)

public static final class ChallengeRuleGroup.Builder extends GeneratedMessage.Builder<ChallengeRuleGroup.Builder> implements ChallengeRuleGroupOrBuilder

A collection of challenge rules that applies to one or more actions.

Protobuf type google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup

Static Methods

getDescriptor()

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

Methods

addActions(String value)

public ChallengeRuleGroup.Builder addActions(String value)

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

repeated string actions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The actions to add.

Returns
Type Description
ChallengeRuleGroup.Builder

This builder for chaining.

addActionsBytes(ByteString value)

public ChallengeRuleGroup.Builder addActionsBytes(ByteString value)

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

repeated string actions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes of the actions to add.

Returns
Type Description
ChallengeRuleGroup.Builder

This builder for chaining.

addAllActions(Iterable<String> values)

public ChallengeRuleGroup.Builder addAllActions(Iterable<String> values)

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

repeated string actions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<String>

The actions to add.

Returns
Type Description
ChallengeRuleGroup.Builder

This builder for chaining.

addAllChallengeRules(Iterable<? extends ChallengeRule> values)

public ChallengeRuleGroup.Builder addAllChallengeRules(Iterable<? extends ChallengeRule> values)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.recaptchaenterprise.v1.ChallengeRule>
Returns
Type Description
ChallengeRuleGroup.Builder

addChallengeRules(ChallengeRule value)

public ChallengeRuleGroup.Builder addChallengeRules(ChallengeRule value)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ChallengeRule
Returns
Type Description
ChallengeRuleGroup.Builder

addChallengeRules(ChallengeRule.Builder builderForValue)

public ChallengeRuleGroup.Builder addChallengeRules(ChallengeRule.Builder builderForValue)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue ChallengeRule.Builder
Returns
Type Description
ChallengeRuleGroup.Builder

addChallengeRules(int index, ChallengeRule value)

public ChallengeRuleGroup.Builder addChallengeRules(int index, ChallengeRule value)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value ChallengeRule
Returns
Type Description
ChallengeRuleGroup.Builder

addChallengeRules(int index, ChallengeRule.Builder builderForValue)

public ChallengeRuleGroup.Builder addChallengeRules(int index, ChallengeRule.Builder builderForValue)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue ChallengeRule.Builder
Returns
Type Description
ChallengeRuleGroup.Builder

addChallengeRulesBuilder()

public ChallengeRule.Builder addChallengeRulesBuilder()

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ChallengeRule.Builder

addChallengeRulesBuilder(int index)

public ChallengeRule.Builder addChallengeRulesBuilder(int index)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ChallengeRule.Builder

build()

public ChallengeRuleGroup build()
Returns
Type Description
ChallengeRuleGroup

buildPartial()

public ChallengeRuleGroup buildPartial()
Returns
Type Description
ChallengeRuleGroup

clear()

public ChallengeRuleGroup.Builder clear()
Returns
Type Description
ChallengeRuleGroup.Builder
Overrides

clearActions()

public ChallengeRuleGroup.Builder clearActions()

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

repeated string actions = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ChallengeRuleGroup.Builder

This builder for chaining.

clearChallengeRules()

public ChallengeRuleGroup.Builder clearChallengeRules()

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ChallengeRuleGroup.Builder

getActions(int index)

public String getActions(int index)

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

repeated string actions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The actions at the given index.

getActionsBytes(int index)

public ByteString getActionsBytes(int index)

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

repeated string actions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the actions at the given index.

getActionsCount()

public int getActionsCount()

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

repeated string actions = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of actions.

getActionsList()

public ProtocolStringList getActionsList()

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

repeated string actions = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the actions.

getChallengeRules(int index)

public ChallengeRule getChallengeRules(int index)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ChallengeRule

getChallengeRulesBuilder(int index)

public ChallengeRule.Builder getChallengeRulesBuilder(int index)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ChallengeRule.Builder

getChallengeRulesBuilderList()

public List<ChallengeRule.Builder> getChallengeRulesBuilderList()

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getChallengeRulesCount()

public int getChallengeRulesCount()

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getChallengeRulesList()

public List<ChallengeRule> getChallengeRulesList()

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<ChallengeRule>

getChallengeRulesOrBuilder(int index)

public ChallengeRuleOrBuilder getChallengeRulesOrBuilder(int index)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ChallengeRuleOrBuilder

getChallengeRulesOrBuilderList()

public List<? extends ChallengeRuleOrBuilder> getChallengeRulesOrBuilderList()

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.recaptchaenterprise.v1.ChallengeRuleOrBuilder>

getDefaultInstanceForType()

public ChallengeRuleGroup getDefaultInstanceForType()
Returns
Type Description
ChallengeRuleGroup

getDescriptorForType()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(ChallengeRuleGroup other)

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

removeChallengeRules(int index)

public ChallengeRuleGroup.Builder removeChallengeRules(int index)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ChallengeRuleGroup.Builder

setActions(int index, String value)

public ChallengeRuleGroup.Builder setActions(int index, String value)

Required. Action name provided at token generation. The action name is not case-sensitive and can only contain alphanumeric characters, slashes, and underscores. If "*" is provided, the rule group applies to all actions. If multiple actions are provided, the rule group is applied to all of them. This field is required.

repeated string actions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int

The index to set the value at.

value String

The actions to set.

Returns
Type Description
ChallengeRuleGroup.Builder

This builder for chaining.

setChallengeRules(int index, ChallengeRule value)

public ChallengeRuleGroup.Builder setChallengeRules(int index, ChallengeRule value)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value ChallengeRule
Returns
Type Description
ChallengeRuleGroup.Builder

setChallengeRules(int index, ChallengeRule.Builder builderForValue)

public ChallengeRuleGroup.Builder setChallengeRules(int index, ChallengeRule.Builder builderForValue)

Required. A list of rules that configure when and how reCAPTCHA presents a challenge. reCAPTCHA evaluates these rules in order and applies the first one that matches.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRule challenge_rules = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue ChallengeRule.Builder
Returns
Type Description
ChallengeRuleGroup.Builder