# reCAPTCHA Enterprise V1 API - Class Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy (v1.11.0)

1.11.0 (latest) 1.9.1 1.8.0 1.7.1 1.6.0 1.5.1 1.4.1 1.3.0 1.2.0 1.1.0 1.0.0 0.22.0 0.21.0 0.20.1 0.19.0 0.18.0 0.17.3 0.16.0 0.15.0 0.14.1 0.13.0 0.12.0 0.11.0 0.10.0 0.9.1 0.8.0 0.7.1 Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy.

A FirewallPolicy represents a single matching pattern and resulting actions
to take.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #actions

    def actions() -> ::Array<::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction>

**Returns**

- (::Array\<[::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/latest/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 `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.

### #actions=

    def actions=(value) -> ::Array<::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction>

**Parameter**

- **value** (::Array\<[::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/latest/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 `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**

- (::Array\<[::Google::Cloud::RecaptchaEnterprise::V1::FirewallAction](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/latest/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 `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.

### #condition

    def condition() -> ::String

**Returns**

- (::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](https://github.com/google/cel-spec) and its [language
  definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.

### #condition=

    def condition=(value) -> ::String

**Parameter**

- **value** (::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](https://github.com/google/cel-spec) and its [language
  definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
**Returns**

- (::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](https://github.com/google/cel-spec) and its [language
  definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.

### #description

    def description() -> ::String

**Returns**

- (::String) --- Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
**Returns**

- (::String) --- Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
**Returns**

- (::String) --- Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.

### #path

    def path() -> ::String

**Returns**

- (::String) --- Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual
  page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.

### #path=

    def path=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual
  page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
**Returns**

- (::String) --- Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual
  page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.