Class FirewallAction (3.40.0) 

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

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

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 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
FirewallAction.BlockAction

The block.

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;

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 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
FirewallAction.IncludeRecaptchaScriptAction

The includeRecaptchaScript.

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;

Returns
Type Description
FirewallAction.IncludeRecaptchaScriptActionOrBuilder

getParserForType()

public Parser<FirewallAction> getParserForType()
Returns
Type Description
Parser<FirewallAction>
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;

Returns
Type Description
FirewallAction.RedirectAction

The redirect.

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;

Returns
Type Description
FirewallAction.RedirectActionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSetHeader()

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;

Returns
Type Description
FirewallAction.SetHeaderAction

The setHeader.

getSetHeaderOrBuilder()

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;

Returns
Type Description
FirewallAction.SetHeaderActionOrBuilder

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;

Returns
Type Description
FirewallAction.SubstituteAction

The substitute.

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;

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 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.

hasSetHeader()

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FirewallAction.Builder toBuilder()
Returns
Type Description
FirewallAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException