Google Cloud reCAPTCHA Enterprise v1 API - Class FirewallPolicy (2.16.0)

public sealed class FirewallPolicy : IMessage<FirewallPolicy>, IEquatable<FirewallPolicy>, IDeepCloneable<FirewallPolicy>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class FirewallPolicy.

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

Inheritance

object > FirewallPolicy

Implements

IMessage FirewallPolicy, IEquatable FirewallPolicy, IDeepCloneable FirewallPolicy, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

FirewallPolicy()

public FirewallPolicy()

FirewallPolicy(FirewallPolicy)

public FirewallPolicy(FirewallPolicy other)

Parameter
Name	Description
`other`	`FirewallPolicy`

Properties

Actions

public RepeatedField<FirewallAction> Actions { get; }

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.

Property Value
Type	Description
`RepeatedFieldFirewallAction`

Condition

public string Condition { get; set; }

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.

Property Value
Type	Description
`string`

Description

public string Description { get; set; }

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

Property Value
Type	Description
`string`

FirewallPolicyName

public FirewallPolicyName FirewallPolicyName { get; set; }

FirewallPolicyName-typed view over the Name resource name property.

Property Value
Type	Description
`FirewallPolicyName`

Name

public string Name { get; set; }

Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.

Property Value
Type	Description
`string`

Path

public string Path { get; set; }

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.

Property Value
Type	Description
`string`