Class FirewallAction (3.52.0)

Version latest

• 3.52.0 (latest)
• 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 final class FirewallAction extends GeneratedMessageV3 implements FirewallActionOrBuilder

An individual action. Each action represents what to do if a policy matches.

Protobuf type google.cloud.recaptchaenterprise.v1.FirewallAction

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FirewallAction

Implements

FirewallActionOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

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

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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

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

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

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

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

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

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

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

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

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

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

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOW_FIELD_NUMBER

public static final int ALLOW_FIELD_NUMBER

Field Value
Type	Description
int

BLOCK_FIELD_NUMBER

public static final int BLOCK_FIELD_NUMBER

Field Value
Type	Description
int

INCLUDE_RECAPTCHA_SCRIPT_FIELD_NUMBER

public static final int INCLUDE_RECAPTCHA_SCRIPT_FIELD_NUMBER

Field Value
Type	Description
int

REDIRECT_FIELD_NUMBER

public static final int REDIRECT_FIELD_NUMBER

Field Value
Type	Description
int

SET_HEADER_FIELD_NUMBER

public static final int SET_HEADER_FIELD_NUMBER

Field Value
Type	Description
int

SUBSTITUTE_FIELD_NUMBER

public static final int SUBSTITUTE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static FirewallAction getDefaultInstance()

Returns
Type	Description
FirewallAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static FirewallAction.Builder newBuilder()

Returns
Type	Description
FirewallAction.Builder

newBuilder(FirewallAction prototype)

public static FirewallAction.Builder newBuilder(FirewallAction prototype)

Parameter
Name	Description
prototype	FirewallAction

Returns
Type	Description
FirewallAction.Builder

parseDelimitedFrom(InputStream input)

public static FirewallAction parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static FirewallAction parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FirewallAction parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FirewallAction parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static FirewallAction parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static FirewallAction parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FirewallAction

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<FirewallAction> parser()

Returns
Type	Description
Parser<FirewallAction>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAllow()

public FirewallAction.AllowAction getAllow()

The user request did not match any policy and should be allowed access to the requested resource.

.google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;

Returns
Type	Description
FirewallAction.AllowAction	The allow.

getAllowOrBuilder()

public FirewallAction.AllowActionOrBuilder getAllowOrBuilder()

The user request did not match any policy and should be allowed access to the requested resource.

.google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;

Returns
Type	Description
FirewallAction.AllowActionOrBuilder

getBlock()

public FirewallAction.BlockAction getBlock()

This action denies access to a given page. The user gets an HTTP error code.

.google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;

Returns
Type	Description
FirewallAction.BlockAction	The block.

getBlockOrBuilder()

public FirewallAction.BlockActionOrBuilder getBlockOrBuilder()

This action denies access to a given page. The user gets an HTTP error code.

.google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;

Returns
Type	Description
FirewallAction.BlockActionOrBuilder

getDefaultInstanceForType()

public FirewallAction getDefaultInstanceForType()

Returns
Type	Description
FirewallAction

getFirewallActionOneofCase()

public FirewallAction.FirewallActionOneofCase getFirewallActionOneofCase()

Returns
Type	Description
FirewallAction.FirewallActionOneofCase

getIncludeRecaptchaScript()

public FirewallAction.IncludeRecaptchaScriptAction getIncludeRecaptchaScript()

This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.

.google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6;

Returns
Type	Description
FirewallAction.IncludeRecaptchaScriptAction	The includeRecaptchaScript.

getIncludeRecaptchaScriptOrBuilder()

public FirewallAction.IncludeRecaptchaScriptActionOrBuilder getIncludeRecaptchaScriptOrBuilder()

This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.

.google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6;

Returns
Type	Description
FirewallAction.IncludeRecaptchaScriptActionOrBuilder

getParserForType()

public Parser<FirewallAction> getParserForType()

Returns
Type	Description
Parser<FirewallAction>

Overrides

GeneratedMessageV3.getParserForType()

getRedirect()

public FirewallAction.RedirectAction getRedirect()

This action redirects the request to a reCAPTCHA interstitial to attach a token.

.google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;

Returns
Type	Description
FirewallAction.RedirectAction	The redirect.

getRedirectOrBuilder()

public FirewallAction.RedirectActionOrBuilder getRedirectOrBuilder()

This action redirects the request to a reCAPTCHA interstitial to attach a token.

.google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;

Returns
Type	Description
FirewallAction.RedirectActionOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSetHeader()

public FirewallAction.SetHeaderAction getSetHeader()

This action sets a custom header but allow the request to continue to the customer backend.

.google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;

Returns
Type	Description
FirewallAction.SetHeaderAction	The setHeader.

getSetHeaderOrBuilder()

public FirewallAction.SetHeaderActionOrBuilder getSetHeaderOrBuilder()

This action sets a custom header but allow the request to continue to the customer backend.

.google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;

Returns
Type	Description
FirewallAction.SetHeaderActionOrBuilder

getSubstitute()

public FirewallAction.SubstituteAction getSubstitute()

This action transparently serves a different page to an offending user.

.google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;

Returns
Type	Description
FirewallAction.SubstituteAction	The substitute.

getSubstituteOrBuilder()

public FirewallAction.SubstituteActionOrBuilder getSubstituteOrBuilder()

This action transparently serves a different page to an offending user.

.google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;

Returns
Type	Description
FirewallAction.SubstituteActionOrBuilder

hasAllow()

public boolean hasAllow()

The user request did not match any policy and should be allowed access to the requested resource.

.google.cloud.recaptchaenterprise.v1.FirewallAction.AllowAction allow = 1;

Returns
Type	Description
boolean	Whether the allow field is set.

hasBlock()

public boolean hasBlock()

This action denies access to a given page. The user gets an HTTP error code.

.google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;

Returns
Type	Description
boolean	Whether the block field is set.

hasIncludeRecaptchaScript()

public boolean hasIncludeRecaptchaScript()

This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.

.google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6;

Returns
Type	Description
boolean	Whether the includeRecaptchaScript field is set.

hasRedirect()

public boolean hasRedirect()

This action redirects the request to a reCAPTCHA interstitial to attach a token.

.google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;

Returns
Type	Description
boolean	Whether the redirect field is set.

hasSetHeader()

public boolean hasSetHeader()

This action sets a custom header but allow the request to continue to the customer backend.

.google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;

Returns
Type	Description
boolean	Whether the setHeader field is set.

hasSubstitute()

public boolean hasSubstitute()

This action transparently serves a different page to an offending user.

.google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;

Returns
Type	Description
boolean	Whether the substitute field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public FirewallAction.Builder newBuilderForType()

Returns
Type	Description
FirewallAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FirewallAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
FirewallAction.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public FirewallAction.Builder toBuilder()

Returns
Type	Description
FirewallAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException