Interface FirewallActionOrBuilder (3.46.0)

public interface FirewallActionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllow()

public abstract 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 abstract 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 abstract 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 abstract 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

getFirewallActionOneofCase()

public abstract FirewallAction.FirewallActionOneofCase getFirewallActionOneofCase()
Returns
Type Description
FirewallAction.FirewallActionOneofCase

getIncludeRecaptchaScript()

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