Class ChallengeRuleGroup (3.96.0)

public final class ChallengeRuleGroup extends GeneratedMessage implements ChallengeRuleGroupOrBuilder

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

Protobuf type google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup

Static Fields

ACTIONS_FIELD_NUMBER

public static final int ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

CHALLENGE_RULES_FIELD_NUMBER

public static final int CHALLENGE_RULES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ChallengeRuleGroup getDefaultInstance()
Returns
Type Description
ChallengeRuleGroup

getDescriptor()

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

newBuilder()

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

newBuilder(ChallengeRuleGroup prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

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

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ChallengeRuleGroup.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ChallengeRuleGroup.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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