public final class Policy extends GeneratedMessage 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
Inherited Members
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)
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()
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()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
CHALLENGE_RULE_GROUPS_FIELD_NUMBER
public static final int CHALLENGE_RULE_GROUPS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLIENT_SETTINGS_FIELD_NUMBER
public static final int CLIENT_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Policy getDefaultInstance()
| Returns |
| Type |
Description |
Policy |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Policy.Builder newBuilder()
newBuilder(Policy prototype)
public static Policy.Builder newBuilder(Policy prototype)
| Parameter |
| Name |
Description |
prototype |
Policy
|
public static Policy parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Policy |
|
public static Policy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Policy |
|
parseFrom(byte[] data)
public static Policy parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Policy |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Policy |
|
parseFrom(ByteString data)
public static Policy parseFrom(ByteString data)
| Returns |
| Type |
Description |
Policy |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Policy |
|
public static Policy parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Policy |
|
public static Policy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Policy |
|
public static Policy parseFrom(InputStream input)
| Returns |
| Type |
Description |
Policy |
|
public static Policy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Policy |
|
parseFrom(ByteBuffer data)
public static Policy parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Policy |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Policy |
|
parser()
public static Parser<Policy> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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
|
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];
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
|
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];
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];
getDefaultInstanceForType()
public Policy getDefaultInstanceForType()
| Returns |
| Type |
Description |
Policy |
|
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.
|
getParserForType()
public Parser<Policy> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Policy.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Policy.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Policy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides