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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ allow |
FirewallAction\AllowAction
The user request did not match any policy and should be allowed access to the requested resource. |
↳ block |
FirewallAction\BlockAction
This action denies access to a given page. The user gets an HTTP error code. |
↳ include_recaptcha_script |
FirewallAction\IncludeRecaptchaScriptAction
This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend. |
↳ redirect |
FirewallAction\RedirectAction
This action redirects the request to a reCAPTCHA interstitial to attach a token. |
↳ substitute |
FirewallAction\SubstituteAction
This action transparently serves a different page to an offending user. |
↳ set_header |
FirewallAction\SetHeaderAction
This action sets 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 |
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 |
FirewallAction\AllowAction
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBlock
This action denies access to a given page. The user gets an HTTP error code.
| Returns | |
|---|---|
| Type | Description |
FirewallAction\BlockAction|null |
|
hasBlock
setBlock
This action denies access to a given page. The user gets an HTTP error code.
| Parameter | |
|---|---|
| Name | Description |
var |
FirewallAction\BlockAction
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIncludeRecaptchaScript
This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
| Returns | |
|---|---|
| Type | Description |
FirewallAction\IncludeRecaptchaScriptAction|null |
|
hasIncludeRecaptchaScript
setIncludeRecaptchaScript
This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend.
| Parameter | |
|---|---|
| Name | Description |
var |
FirewallAction\IncludeRecaptchaScriptAction
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRedirect
This action redirects the request to a reCAPTCHA interstitial to attach a token.
| Returns | |
|---|---|
| Type | Description |
FirewallAction\RedirectAction|null |
|
hasRedirect
setRedirect
This action redirects the request to a reCAPTCHA interstitial to attach a token.
| Parameter | |
|---|---|
| Name | Description |
var |
FirewallAction\RedirectAction
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubstitute
This action transparently serves a different page to an offending user.
| Returns | |
|---|---|
| Type | Description |
FirewallAction\SubstituteAction|null |
|
hasSubstitute
setSubstitute
This action transparently serves a different page to an offending user.
| Parameter | |
|---|---|
| Name | Description |
var |
FirewallAction\SubstituteAction
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSetHeader
This action sets a custom header but allow the request to continue to the customer backend.
| Returns | |
|---|---|
| Type | Description |
FirewallAction\SetHeaderAction|null |
|
hasSetHeader
setSetHeader
This action sets a custom header but allow the request to continue to the customer backend.
| Parameter | |
|---|---|
| Name | Description |
var |
FirewallAction\SetHeaderAction
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFirewallActionOneof
| Returns | |
|---|---|
| Type | Description |
string |
|