Class FirewallAction (3.37.0)
Version 3.37.0keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static FirewallAction . Builder newBuilder ()
newBuilder(FirewallAction prototype)
public static FirewallAction . Builder newBuilder ( FirewallAction prototype )
public static FirewallAction parseDelimitedFrom ( InputStream input )
public static FirewallAction parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static FirewallAction parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FirewallAction parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static FirewallAction parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FirewallAction parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static FirewallAction parseFrom ( CodedInputStream input )
public static FirewallAction parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static FirewallAction parseFrom ( InputStream input )
public static FirewallAction parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static FirewallAction parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static FirewallAction parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<FirewallAction> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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;
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;
getBlock()
public FirewallAction . BlockAction getBlock ()
This action will deny access to a given page. The user will get an HTTP
error code.
.google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
getBlockOrBuilder()
public FirewallAction . BlockActionOrBuilder getBlockOrBuilder ()
This action will deny access to a given page. The user will get an HTTP
error code.
.google.cloud.recaptchaenterprise.v1.FirewallAction.BlockAction block = 2;
getDefaultInstanceForType()
public FirewallAction getDefaultInstanceForType ()
getFirewallActionOneofCase()
public FirewallAction . FirewallActionOneofCase getFirewallActionOneofCase ()
getIncludeRecaptchaScript()
public FirewallAction . IncludeRecaptchaScriptAction getIncludeRecaptchaScript ()
This action will inject reCAPTCHA JavaScript code into the HTML page
returned by the site backend.
.google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6;
getIncludeRecaptchaScriptOrBuilder()
public FirewallAction . IncludeRecaptchaScriptActionOrBuilder getIncludeRecaptchaScriptOrBuilder ()
This action will inject reCAPTCHA JavaScript code into the HTML page
returned by the site backend.
.google.cloud.recaptchaenterprise.v1.FirewallAction.IncludeRecaptchaScriptAction include_recaptcha_script = 6;
getParserForType()
public Parser<FirewallAction> getParserForType ()
Overrides
getRedirect()
public FirewallAction . RedirectAction getRedirect ()
This action will redirect the request to a ReCaptcha interstitial to
attach a token.
.google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
getRedirectOrBuilder()
public FirewallAction . RedirectActionOrBuilder getRedirectOrBuilder ()
This action will redirect the request to a ReCaptcha interstitial to
attach a token.
.google.cloud.recaptchaenterprise.v1.FirewallAction.RedirectAction redirect = 5;
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public FirewallAction . SetHeaderAction getSetHeader ()
This action will set a custom header but allow the request to continue
to the customer backend.
.google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;
public FirewallAction . SetHeaderActionOrBuilder getSetHeaderOrBuilder ()
This action will set a custom header but allow the request to continue
to the customer backend.
.google.cloud.recaptchaenterprise.v1.FirewallAction.SetHeaderAction set_header = 4;
getSubstitute()
public FirewallAction . SubstituteAction getSubstitute ()
This action will transparently serve a different page to an offending
user.
.google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
getSubstituteOrBuilder()
public FirewallAction . SubstituteActionOrBuilder getSubstituteOrBuilder ()
This action will transparently serve a different page to an offending
user.
.google.cloud.recaptchaenterprise.v1.FirewallAction.SubstituteAction substitute = 3;
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 will deny access to a given page. The user will get 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 will inject 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 will redirect 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.
public boolean hasSetHeader ()
This action will set 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 will transparently serve 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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public FirewallAction . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected FirewallAction . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public FirewallAction . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
