Class FirewallAction (3.31.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

Static Fields

ALLOW_FIELD_NUMBER

public static final int ALLOW_FIELD_NUMBER
Field Value
TypeDescription
int

BLOCK_FIELD_NUMBER

public static final int BLOCK_FIELD_NUMBER
Field Value
TypeDescription
int

REDIRECT_FIELD_NUMBER

public static final int REDIRECT_FIELD_NUMBER
Field Value
TypeDescription
int

SET_HEADER_FIELD_NUMBER

public static final int SET_HEADER_FIELD_NUMBER
Field Value
TypeDescription
int

SUBSTITUTE_FIELD_NUMBER

public static final int SUBSTITUTE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FirewallAction getDefaultInstance()
Returns
TypeDescription
FirewallAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static FirewallAction.Builder newBuilder()
Returns
TypeDescription
FirewallAction.Builder

newBuilder(FirewallAction prototype)

public static FirewallAction.Builder newBuilder(FirewallAction prototype)
Parameter
NameDescription
prototypeFirewallAction
Returns
TypeDescription
FirewallAction.Builder

parseDelimitedFrom(InputStream input)

public static FirewallAction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FirewallAction parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FirewallAction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FirewallAction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FirewallAction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FirewallAction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FirewallAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FirewallAction> parser()
Returns
TypeDescription
Parser<FirewallAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
FirewallAction.BlockActionOrBuilder

getDefaultInstanceForType()

public FirewallAction getDefaultInstanceForType()
Returns
TypeDescription
FirewallAction

getFirewallActionOneofCase()

public FirewallAction.FirewallActionOneofCase getFirewallActionOneofCase()
Returns
TypeDescription
FirewallAction.FirewallActionOneofCase

getParserForType()

public Parser<FirewallAction> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
FirewallAction.RedirectActionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the block 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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the substitute field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FirewallAction.Builder newBuilderForType()
Returns
TypeDescription
FirewallAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FirewallAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FirewallAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FirewallAction.Builder toBuilder()
Returns
TypeDescription
FirewallAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException