Google Cloud Recaptcha Enterprise V1 Client - Class FirewallAction (1.14.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.

Returns
Type	Description
`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\AllowAction\|null`

hasAllow

setAllow

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

Parameter
Name	Description
`var`	`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\AllowAction`

Returns
Type	Description
`$this`

getBlock

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

Returns
Type	Description
`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\BlockAction\|null`

hasBlock

setBlock

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

Parameter
Name	Description
`var`	`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\BlockAction`

Returns
Type	Description
`$this`

getIncludeRecaptchaScript

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

Returns
Type	Description
`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\IncludeRecaptchaScriptAction\|null`

hasIncludeRecaptchaScript

setIncludeRecaptchaScript

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

Parameter
Name	Description
`var`	`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\IncludeRecaptchaScriptAction`

Returns
Type	Description
`$this`

getRedirect

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

Returns
Type	Description
`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\RedirectAction\|null`

hasRedirect

setRedirect

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

Parameter
Name	Description
`var`	`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\RedirectAction`

Returns
Type	Description
`$this`

getSubstitute

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

Returns
Type	Description
`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SubstituteAction\|null`

hasSubstitute

setSubstitute

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

Parameter
Name	Description
`var`	`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SubstituteAction`

Returns
Type	Description
`$this`

getSetHeader

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

Returns
Type	Description
`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SetHeaderAction\|null`

hasSetHeader

setSetHeader

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

Parameter
Name	Description
`var`	`Google\Cloud\RecaptchaEnterprise\V1\FirewallAction\SetHeaderAction`

Returns
Type	Description
`$this`

getFirewallActionOneof

Returns
Type	Description
`string`