Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class ChallengeRule (3.96.0)

public final class ChallengeRule extends GeneratedMessage implements ChallengeRuleOrBuilder

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

Protobuf type google.cloud.recaptchaenterprise.v1.ChallengeRule

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ChallengeRule

Implements

ChallengeRuleOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CHALLENGE_FIELD_NUMBER

public static final int CHALLENGE_FIELD_NUMBER

Field Value
Type	Description
`int`

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER

Field Value
Type	Description
`int`

NO_CHALLENGE_FIELD_NUMBER

public static final int NO_CHALLENGE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static ChallengeRule getDefaultInstance()

Returns
Type	Description
`ChallengeRule`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static ChallengeRule.Builder newBuilder()

Returns
Type	Description
`ChallengeRule.Builder`

newBuilder(ChallengeRule prototype)

public static ChallengeRule.Builder newBuilder(ChallengeRule prototype)

Parameter
Name	Description
`prototype`	`ChallengeRule`

Returns
Type	Description
`ChallengeRule.Builder`

parseDelimitedFrom(InputStream input)

public static ChallengeRule parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ChallengeRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static ChallengeRule parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ChallengeRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static ChallengeRule parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ChallengeRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static ChallengeRule parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ChallengeRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static ChallengeRule parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ChallengeRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static ChallengeRule parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ChallengeRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ChallengeRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<ChallengeRule> parser()

Returns
Type	Description
`Parser<ChallengeRule>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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.

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`

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.

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`

getParserForType()

public Parser<ChallengeRule> getParserForType()

Returns
Type	Description
`Parser<ChallengeRule>`

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public ChallengeRule.Builder newBuilderForType()

Returns
Type	Description
`ChallengeRule.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ChallengeRule.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`ChallengeRule.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public ChallengeRule.Builder toBuilder()

Returns
Type	Description
`ChallengeRule.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`