Class ChallengeRule.Builder (3.96.0)

3.96.0 (latest) 3.92.0 3.91.0 3.90.0 3.88.0 3.85.0 3.84.0 3.82.0 3.80.0 3.79.0 3.77.0 3.75.0 3.73.0 3.72.0 3.71.0 3.70.0 3.69.0 3.67.0 3.65.0 3.64.0 3.61.0 3.60.0 3.59.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.51.0 3.50.0 3.49.0 3.48.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.39.0 3.38.0 3.37.0 3.36.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.27.0 3.26.0 3.25.0 3.24.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.12 2.6.1 2.5.0 2.4.10 2.3.1

public static final class ChallengeRule.Builder extends GeneratedMessage.Builder<ChallengeRule.Builder> implements ChallengeRuleOrBuilder

A rule to configure the behavior of reCAPTCHA for conditionally presenting a challenge.

Protobuf type google.cloud.recaptchaenterprise.v1.ChallengeRule

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ChallengeRule.Builder

Implements

ChallengeRuleOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public ChallengeRule build()

Returns
Type	Description
ChallengeRule

buildPartial()

public ChallengeRule buildPartial()

Returns
Type	Description
ChallengeRule

clear()

public ChallengeRule.Builder clear()

Returns
Type	Description
ChallengeRule.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearChallenge()

public ChallengeRule.Builder clearChallenge()

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Returns
Type	Description
ChallengeRule.Builder

clearCondition()

public ChallengeRule.Builder clearCondition()

Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition:

• score
• user_ip_address
• user_asn
• user_agent
• verified_bots.name

• verified_bots.bot_type

  Examples:

• score < 0.5
• user_ip_address == "123.45.67.89"
• user_agent.contains("Chrome")
• score < 0.5 && user_ip_address == "123.45.67.89"

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ChallengeRule.Builder	This builder for chaining.

clearNoChallenge()

public ChallengeRule.Builder clearNoChallenge()

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Returns
Type	Description
ChallengeRule.Builder

clearOutcome()

public ChallengeRule.Builder clearOutcome()

Returns
Type	Description
ChallengeRule.Builder

getChallenge()

public ChallengeRule.ChallengeOutcome getChallenge()

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Returns
Type	Description
ChallengeRule.ChallengeOutcome	The challenge.

getChallengeBuilder()

public ChallengeRule.ChallengeOutcome.Builder getChallengeBuilder()

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Returns
Type	Description
ChallengeRule.ChallengeOutcome.Builder

getChallengeOrBuilder()

public ChallengeRule.ChallengeOutcomeOrBuilder getChallengeOrBuilder()

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Returns
Type	Description
ChallengeRule.ChallengeOutcomeOrBuilder

getCondition()

public String getCondition()

Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition:

• score
• user_ip_address
• user_asn
• user_agent
• verified_bots.name

• verified_bots.bot_type

  Examples:

• score < 0.5
• user_ip_address == "123.45.67.89"
• user_agent.contains("Chrome")
• score < 0.5 && user_ip_address == "123.45.67.89"

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The condition.

getConditionBytes()

public ByteString getConditionBytes()

Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition:

• score
• user_ip_address
• user_asn
• user_agent
• verified_bots.name

• verified_bots.bot_type

  Examples:

• score < 0.5
• user_ip_address == "123.45.67.89"
• user_agent.contains("Chrome")
• score < 0.5 && user_ip_address == "123.45.67.89"

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for condition.

getDefaultInstanceForType()

public ChallengeRule getDefaultInstanceForType()

Returns
Type	Description
ChallengeRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getNoChallenge()

public ChallengeRule.NoChallengeOutcome getNoChallenge()

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Returns
Type	Description
ChallengeRule.NoChallengeOutcome	The noChallenge.

getNoChallengeBuilder()

public ChallengeRule.NoChallengeOutcome.Builder getNoChallengeBuilder()

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Returns
Type	Description
ChallengeRule.NoChallengeOutcome.Builder

getNoChallengeOrBuilder()

public ChallengeRule.NoChallengeOutcomeOrBuilder getNoChallengeOrBuilder()

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Returns
Type	Description
ChallengeRule.NoChallengeOutcomeOrBuilder

getOutcomeCase()

public ChallengeRule.OutcomeCase getOutcomeCase()

Returns
Type	Description
ChallengeRule.OutcomeCase

hasChallenge()

public boolean hasChallenge()

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Returns
Type	Description
boolean	Whether the challenge field is set.

hasNoChallenge()

public boolean hasNoChallenge()

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Returns
Type	Description
boolean	Whether the noChallenge field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeChallenge(ChallengeRule.ChallengeOutcome value)

public ChallengeRule.Builder mergeChallenge(ChallengeRule.ChallengeOutcome value)

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Parameter
Name	Description
value	ChallengeRule.ChallengeOutcome

Returns
Type	Description
ChallengeRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ChallengeRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ChallengeRule.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ChallengeRule.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ChallengeRule.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(ChallengeRule other)

public ChallengeRule.Builder mergeFrom(ChallengeRule other)

Parameter
Name	Description
other	ChallengeRule

Returns
Type	Description
ChallengeRule.Builder

mergeNoChallenge(ChallengeRule.NoChallengeOutcome value)

public ChallengeRule.Builder mergeNoChallenge(ChallengeRule.NoChallengeOutcome value)

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Parameter
Name	Description
value	ChallengeRule.NoChallengeOutcome

Returns
Type	Description
ChallengeRule.Builder

setChallenge(ChallengeRule.ChallengeOutcome value)

public ChallengeRule.Builder setChallenge(ChallengeRule.ChallengeOutcome value)

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Parameter
Name	Description
value	ChallengeRule.ChallengeOutcome

Returns
Type	Description
ChallengeRule.Builder

setChallenge(ChallengeRule.ChallengeOutcome.Builder builderForValue)

public ChallengeRule.Builder setChallenge(ChallengeRule.ChallengeOutcome.Builder builderForValue)

Present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.ChallengeOutcome challenge = 3;

Parameter
Name	Description
builderForValue	ChallengeRule.ChallengeOutcome.Builder

Returns
Type	Description
ChallengeRule.Builder

setCondition(String value)

public ChallengeRule.Builder setCondition(String value)

Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition:

• score
• user_ip_address
• user_asn
• user_agent
• verified_bots.name

• verified_bots.bot_type

  Examples:

• score < 0.5
• user_ip_address == "123.45.67.89"
• user_agent.contains("Chrome")
• score < 0.5 && user_ip_address == "123.45.67.89"

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The condition to set.

Returns
Type	Description
ChallengeRule.Builder	This builder for chaining.

setConditionBytes(ByteString value)

public ChallengeRule.Builder setConditionBytes(ByteString value)

Optional. A CEL condition that must be met for this rule to apply. If unspecified, the rule applies unconditionally. The following fields can be referenced in the condition:

• score
• user_ip_address
• user_asn
• user_agent
• verified_bots.name

• verified_bots.bot_type

  Examples:

• score < 0.5
• user_ip_address == "123.45.67.89"
• user_agent.contains("Chrome")
• score < 0.5 && user_ip_address == "123.45.67.89"

string condition = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for condition to set.

Returns
Type	Description
ChallengeRule.Builder	This builder for chaining.

setNoChallenge(ChallengeRule.NoChallengeOutcome value)

public ChallengeRule.Builder setNoChallenge(ChallengeRule.NoChallengeOutcome value)

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Parameter
Name	Description
value	ChallengeRule.NoChallengeOutcome

Returns
Type	Description
ChallengeRule.Builder

setNoChallenge(ChallengeRule.NoChallengeOutcome.Builder builderForValue)

public ChallengeRule.Builder setNoChallenge(ChallengeRule.NoChallengeOutcome.Builder builderForValue)

Do not present a challenge to the user.

.google.cloud.recaptchaenterprise.v1.ChallengeRule.NoChallengeOutcome no_challenge = 2;

Parameter
Name	Description
builderForValue	ChallengeRule.NoChallengeOutcome.Builder

Returns
Type	Description
ChallengeRule.Builder