Class FirewallAction.Builder (3.48.0)

public static final class FirewallAction.Builder extends GeneratedMessageV3.Builder<FirewallAction.Builder> implements FirewallActionOrBuilder

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

Protobuf type google.cloud.recaptchaenterprise.v1.FirewallAction

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FirewallAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FirewallAction.Builder
Overrides

build()

public FirewallAction build()
Returns
Type Description
FirewallAction

buildPartial()

public FirewallAction buildPartial()
Returns
Type Description
FirewallAction

clear()

public FirewallAction.Builder clear()
Returns
Type Description
FirewallAction.Builder
Overrides

clearAllow()

public FirewallAction.Builder clearAllow()

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

clearBlock()

public FirewallAction.Builder clearBlock()

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

clearField(Descriptors.FieldDescriptor field)

public FirewallAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FirewallAction.Builder
Overrides

clearFirewallActionOneof()

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

clearIncludeRecaptchaScript()

public FirewallAction.Builder clearIncludeRecaptchaScript()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public FirewallAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FirewallAction.Builder
Overrides

clearRedirect()

public FirewallAction.Builder clearRedirect()

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

clearSetHeader()

public FirewallAction.Builder clearSetHeader()

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

clearSubstitute()

public FirewallAction.Builder clearSubstitute()

This action will transparently serve a different page to an offending user.

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

Returns
Type Description
FirewallAction.Builder

clone()

public FirewallAction.Builder clone()
Returns
Type Description
FirewallAction.Builder
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.

getAllowBuilder()

public FirewallAction.AllowAction.Builder getAllowBuilder()

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

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.

getBlockBuilder()

public FirewallAction.BlockAction.Builder getBlockBuilder()

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getIncludeRecaptchaScriptBuilder()

public FirewallAction.IncludeRecaptchaScriptAction.Builder getIncludeRecaptchaScriptBuilder()

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

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

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.

getRedirectBuilder()

public FirewallAction.RedirectAction.Builder getRedirectBuilder()

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

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

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.

getSetHeaderBuilder()

public FirewallAction.SetHeaderAction.Builder getSetHeaderBuilder()

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

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.

getSubstituteBuilder()

public FirewallAction.SubstituteAction.Builder getSubstituteBuilder()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAllow(FirewallAction.AllowAction value)

public FirewallAction.Builder mergeAllow(FirewallAction.AllowAction value)

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;

Parameter
Name Description
value FirewallAction.AllowAction
Returns
Type Description
FirewallAction.Builder

mergeBlock(FirewallAction.BlockAction value)

public FirewallAction.Builder mergeBlock(FirewallAction.BlockAction value)

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;

Parameter
Name Description
value FirewallAction.BlockAction
Returns
Type Description
FirewallAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FirewallAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirewallAction.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FirewallAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FirewallAction.Builder
Overrides

mergeFrom(FirewallAction other)

public FirewallAction.Builder mergeFrom(FirewallAction other)
Parameter
Name Description
other FirewallAction
Returns
Type Description
FirewallAction.Builder

mergeIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction value)

public FirewallAction.Builder mergeIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction value)

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;

Parameter
Name Description
value FirewallAction.IncludeRecaptchaScriptAction
Returns
Type Description
FirewallAction.Builder

mergeRedirect(FirewallAction.RedirectAction value)

public FirewallAction.Builder mergeRedirect(FirewallAction.RedirectAction value)

This action will redirect the request to a ReCaptcha interstitial to attach a token.

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

Parameter
Name Description
value FirewallAction.RedirectAction
Returns
Type Description
FirewallAction.Builder

mergeSetHeader(FirewallAction.SetHeaderAction value)

public FirewallAction.Builder mergeSetHeader(FirewallAction.SetHeaderAction value)

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;

Parameter
Name Description
value FirewallAction.SetHeaderAction
Returns
Type Description
FirewallAction.Builder

mergeSubstitute(FirewallAction.SubstituteAction value)

public FirewallAction.Builder mergeSubstitute(FirewallAction.SubstituteAction value)

This action will transparently serve a different page to an offending user.

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

Parameter
Name Description
value FirewallAction.SubstituteAction
Returns
Type Description
FirewallAction.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FirewallAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FirewallAction.Builder
Overrides

setAllow(FirewallAction.AllowAction value)

public FirewallAction.Builder setAllow(FirewallAction.AllowAction value)

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;

Parameter
Name Description
value FirewallAction.AllowAction
Returns
Type Description
FirewallAction.Builder

setAllow(FirewallAction.AllowAction.Builder builderForValue)

public FirewallAction.Builder setAllow(FirewallAction.AllowAction.Builder builderForValue)

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;

Parameter
Name Description
builderForValue FirewallAction.AllowAction.Builder
Returns
Type Description
FirewallAction.Builder

setBlock(FirewallAction.BlockAction value)

public FirewallAction.Builder setBlock(FirewallAction.BlockAction value)

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;

Parameter
Name Description
value FirewallAction.BlockAction
Returns
Type Description
FirewallAction.Builder

setBlock(FirewallAction.BlockAction.Builder builderForValue)

public FirewallAction.Builder setBlock(FirewallAction.BlockAction.Builder builderForValue)

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;

Parameter
Name Description
builderForValue FirewallAction.BlockAction.Builder
Returns
Type Description
FirewallAction.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FirewallAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FirewallAction.Builder
Overrides

setIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction value)

public FirewallAction.Builder setIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction value)

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;

Parameter
Name Description
value FirewallAction.IncludeRecaptchaScriptAction
Returns
Type Description
FirewallAction.Builder

setIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction.Builder builderForValue)

public FirewallAction.Builder setIncludeRecaptchaScript(FirewallAction.IncludeRecaptchaScriptAction.Builder builderForValue)

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;

Parameter
Name Description
builderForValue FirewallAction.IncludeRecaptchaScriptAction.Builder
Returns
Type Description
FirewallAction.Builder

setRedirect(FirewallAction.RedirectAction value)

public FirewallAction.Builder setRedirect(FirewallAction.RedirectAction value)

This action will redirect the request to a ReCaptcha interstitial to attach a token.

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

Parameter
Name Description
value FirewallAction.RedirectAction
Returns
Type Description
FirewallAction.Builder

setRedirect(FirewallAction.RedirectAction.Builder builderForValue)

public FirewallAction.Builder setRedirect(FirewallAction.RedirectAction.Builder builderForValue)

This action will redirect the request to a ReCaptcha interstitial to attach a token.

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

Parameter
Name Description
builderForValue FirewallAction.RedirectAction.Builder
Returns
Type Description
FirewallAction.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FirewallAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FirewallAction.Builder
Overrides

setSetHeader(FirewallAction.SetHeaderAction value)

public FirewallAction.Builder setSetHeader(FirewallAction.SetHeaderAction value)

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;

Parameter
Name Description
value FirewallAction.SetHeaderAction
Returns
Type Description
FirewallAction.Builder

setSetHeader(FirewallAction.SetHeaderAction.Builder builderForValue)

public FirewallAction.Builder setSetHeader(FirewallAction.SetHeaderAction.Builder builderForValue)

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;

Parameter
Name Description
builderForValue FirewallAction.SetHeaderAction.Builder
Returns
Type Description
FirewallAction.Builder

setSubstitute(FirewallAction.SubstituteAction value)

public FirewallAction.Builder setSubstitute(FirewallAction.SubstituteAction value)

This action will transparently serve a different page to an offending user.

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

Parameter
Name Description
value FirewallAction.SubstituteAction
Returns
Type Description
FirewallAction.Builder

setSubstitute(FirewallAction.SubstituteAction.Builder builderForValue)

public FirewallAction.Builder setSubstitute(FirewallAction.SubstituteAction.Builder builderForValue)

This action will transparently serve a different page to an offending user.

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

Parameter
Name Description
builderForValue FirewallAction.SubstituteAction.Builder
Returns
Type Description
FirewallAction.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final FirewallAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FirewallAction.Builder
Overrides