Class Policy.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 Policy.Builder extends GeneratedMessage.Builder<Policy.Builder> implements PolicyOrBuilder

A complete configuration set containing multiple grouped rules defining the behavior of reCAPTCHA for fraud detection and prevention.

Protobuf type google.cloud.recaptchaenterprise.v1.Policy

Inheritance

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

Implements

PolicyOrBuilder

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

addAllChallengeRuleGroups(Iterable<? extends ChallengeRuleGroup> values)

public Policy.Builder addAllChallengeRuleGroups(Iterable<? extends ChallengeRuleGroup> values)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.recaptchaenterprise.v1.ChallengeRuleGroup>

Returns
Type	Description
Policy.Builder

addChallengeRuleGroups(ChallengeRuleGroup value)

public Policy.Builder addChallengeRuleGroups(ChallengeRuleGroup value)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ChallengeRuleGroup

Returns
Type	Description
Policy.Builder

addChallengeRuleGroups(ChallengeRuleGroup.Builder builderForValue)

public Policy.Builder addChallengeRuleGroups(ChallengeRuleGroup.Builder builderForValue)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	ChallengeRuleGroup.Builder

Returns
Type	Description
Policy.Builder

addChallengeRuleGroups(int index, ChallengeRuleGroup value)

public Policy.Builder addChallengeRuleGroups(int index, ChallengeRuleGroup value)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	ChallengeRuleGroup

Returns
Type	Description
Policy.Builder

addChallengeRuleGroups(int index, ChallengeRuleGroup.Builder builderForValue)

public Policy.Builder addChallengeRuleGroups(int index, ChallengeRuleGroup.Builder builderForValue)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	ChallengeRuleGroup.Builder

Returns
Type	Description
Policy.Builder

addChallengeRuleGroupsBuilder()

public ChallengeRuleGroup.Builder addChallengeRuleGroupsBuilder()

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ChallengeRuleGroup.Builder

addChallengeRuleGroupsBuilder(int index)

public ChallengeRuleGroup.Builder addChallengeRuleGroupsBuilder(int index)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ChallengeRuleGroup.Builder

build()

public Policy build()

Returns
Type	Description
Policy

buildPartial()

public Policy buildPartial()

Returns
Type	Description
Policy

clear()

public Policy.Builder clear()

Returns
Type	Description
Policy.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearChallengeRuleGroups()

public Policy.Builder clearChallengeRuleGroups()

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Policy.Builder

clearClientSettings()

public Policy.Builder clearClientSettings()

Required. Configuration for clients protected by this policy.

.google.cloud.recaptchaenterprise.v1.ClientSettings client_settings = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Policy.Builder

clearName()

public Policy.Builder clearName()

Identifier. Resource name for this policy. Format: "projects/{project}/keys/{key}/policy" for a policy under a key.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
Policy.Builder	This builder for chaining.

getChallengeRuleGroups(int index)

public ChallengeRuleGroup getChallengeRuleGroups(int index)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ChallengeRuleGroup

getChallengeRuleGroupsBuilder(int index)

public ChallengeRuleGroup.Builder getChallengeRuleGroupsBuilder(int index)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ChallengeRuleGroup.Builder

getChallengeRuleGroupsBuilderList()

public List<ChallengeRuleGroup.Builder> getChallengeRuleGroupsBuilderList()

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getChallengeRuleGroupsCount()

public int getChallengeRuleGroupsCount()

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getChallengeRuleGroupsList()

public List<ChallengeRuleGroup> getChallengeRuleGroupsList()

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<ChallengeRuleGroup>

getChallengeRuleGroupsOrBuilder(int index)

public ChallengeRuleGroupOrBuilder getChallengeRuleGroupsOrBuilder(int index)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ChallengeRuleGroupOrBuilder

getChallengeRuleGroupsOrBuilderList()

public List<? extends ChallengeRuleGroupOrBuilder> getChallengeRuleGroupsOrBuilderList()

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

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

getClientSettings()

public ClientSettings getClientSettings()

Required. Configuration for clients protected by this policy.

.google.cloud.recaptchaenterprise.v1.ClientSettings client_settings = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ClientSettings	The clientSettings.

getClientSettingsBuilder()

public ClientSettings.Builder getClientSettingsBuilder()

Required. Configuration for clients protected by this policy.

.google.cloud.recaptchaenterprise.v1.ClientSettings client_settings = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ClientSettings.Builder

getClientSettingsOrBuilder()

public ClientSettingsOrBuilder getClientSettingsOrBuilder()

Required. Configuration for clients protected by this policy.

.google.cloud.recaptchaenterprise.v1.ClientSettings client_settings = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ClientSettingsOrBuilder

getDefaultInstanceForType()

public Policy getDefaultInstanceForType()

Returns
Type	Description
Policy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getName()

public String getName()

Identifier. Resource name for this policy. Format: "projects/{project}/keys/{key}/policy" for a policy under a key.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Resource name for this policy. Format: "projects/{project}/keys/{key}/policy" for a policy under a key.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

hasClientSettings()

public boolean hasClientSettings()

Required. Configuration for clients protected by this policy.

.google.cloud.recaptchaenterprise.v1.ClientSettings client_settings = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the clientSettings 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()

mergeClientSettings(ClientSettings value)

public Policy.Builder mergeClientSettings(ClientSettings value)

Required. Configuration for clients protected by this policy.

.google.cloud.recaptchaenterprise.v1.ClientSettings client_settings = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ClientSettings

Returns
Type	Description
Policy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Policy.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Policy.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Policy.Builder

Overrides

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

mergeFrom(Policy other)

public Policy.Builder mergeFrom(Policy other)

Parameter
Name	Description
other	Policy

Returns
Type	Description
Policy.Builder

removeChallengeRuleGroups(int index)

public Policy.Builder removeChallengeRuleGroups(int index)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
Policy.Builder

setChallengeRuleGroups(int index, ChallengeRuleGroup value)

public Policy.Builder setChallengeRuleGroups(int index, ChallengeRuleGroup value)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	ChallengeRuleGroup

Returns
Type	Description
Policy.Builder

setChallengeRuleGroups(int index, ChallengeRuleGroup.Builder builderForValue)

public Policy.Builder setChallengeRuleGroups(int index, ChallengeRuleGroup.Builder builderForValue)

Optional. Rules to configure the behavior of reCAPTCHA for showing a challenge. Rule groups are evaluated in order. Evaluation stops when the first matching rule group is found.

repeated .google.cloud.recaptchaenterprise.v1.ChallengeRuleGroup challenge_rule_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	ChallengeRuleGroup.Builder

Returns
Type	Description
Policy.Builder

setClientSettings(ClientSettings value)

public Policy.Builder setClientSettings(ClientSettings value)

Required. Configuration for clients protected by this policy.

.google.cloud.recaptchaenterprise.v1.ClientSettings client_settings = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ClientSettings

Returns
Type	Description
Policy.Builder

setClientSettings(ClientSettings.Builder builderForValue)

public Policy.Builder setClientSettings(ClientSettings.Builder builderForValue)

Required. Configuration for clients protected by this policy.

.google.cloud.recaptchaenterprise.v1.ClientSettings client_settings = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	ClientSettings.Builder

Returns
Type	Description
Policy.Builder

setName(String value)

public Policy.Builder setName(String value)

Identifier. Resource name for this policy. Format: "projects/{project}/keys/{key}/policy" for a policy under a key.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Policy.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Policy.Builder setNameBytes(ByteString value)

Identifier. Resource name for this policy. Format: "projects/{project}/keys/{key}/policy" for a policy under a key.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

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

Returns
Type	Description
Policy.Builder	This builder for chaining.