Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class FirewallPolicy.
A FirewallPolicy represents a single matching pattern and resulting actions to take.
Generated from protobuf message google.cloud.recaptchaenterprise.v1.FirewallPolicy
Namespace
Google \ Cloud \ RecaptchaEnterprise \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The resource name for the FirewallPolicy in the format |
↳ description |
string
Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters. |
↳ path |
string
Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters. |
↳ condition |
string
Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters. |
↳ actions |
array<Google\Cloud\RecaptchaEnterprise\V1\FirewallAction>
Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as |
getName
The resource name for the FirewallPolicy in the format
projects/{project}/firewallpolicies/{firewallpolicy}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The resource name for the FirewallPolicy in the format
projects/{project}/firewallpolicies/{firewallpolicy}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPath
Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page.
A path has a max length of 200 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setPath
Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page.
A path has a max length of 200 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCondition
Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition.
A condition has a max length of 500 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setCondition
Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition.
A condition has a max length of 500 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getActions
Optional. The actions that the caller should take regarding user access.
There should be at most one terminal action. A terminal action is any
action that forces a response, such as AllowAction,
BlockAction or SubstituteAction.
Zero or more non-terminal actions such as SetHeader might be
specified. A single policy can contain up to 16 actions.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setActions
Optional. The actions that the caller should take regarding user access.
There should be at most one terminal action. A terminal action is any
action that forces a response, such as AllowAction,
BlockAction or SubstituteAction.
Zero or more non-terminal actions such as SetHeader might be
specified. A single policy can contain up to 16 actions.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\RecaptchaEnterprise\V1\FirewallAction>
|
| Returns | |
|---|---|
| Type | Description |
$this | |