Google Cloud Recaptcha Enterprise V1 Client - Class FirewallAction (1.15.0)

Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class FirewallAction.

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

Generated from protobuf message google.cloud.recaptchaenterprise.v1.FirewallAction

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ allow
Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\AllowAction

The user request did not match any policy and should be allowed access to the requested resource.

↳ block
Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\BlockAction

This action will deny access to a given page. The user will get an HTTP error code.

↳ include_recaptcha_script
Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\IncludeRecaptchaScriptAction

This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend.

↳ redirect
Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\RedirectAction

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

↳ substitute
Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SubstituteAction

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

↳ set_header
Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SetHeaderAction

This action will set a custom header but allow the request to continue to the customer backend.

getAllow

The user request did not match any policy and should be allowed access to the requested resource.

hasAllow

setAllow

The user request did not match any policy and should be allowed access to the requested resource.

Returns
Type
Description
$this

getBlock

This action will deny access to a given page. The user will get an HTTP error code.

hasBlock

setBlock

This action will deny access to a given page. The user will get an HTTP error code.

Returns
Type
Description
$this

getIncludeRecaptchaScript

This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend.

hasIncludeRecaptchaScript

setIncludeRecaptchaScript

This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend.

Returns
Type
Description
$this

getRedirect

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

hasRedirect

setRedirect

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

Returns
Type
Description
$this

getSubstitute

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

hasSubstitute

setSubstitute

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

Returns
Type
Description
$this

getSetHeader

This action will set a custom header but allow the request to continue to the customer backend.

hasSetHeader

setSetHeader

This action will set a custom header but allow the request to continue to the customer backend.

Returns
Type
Description
$this

getFirewallActionOneof

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: