Class: Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1FirewallPolicy

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/recaptchaenterprise_v1/classes.rb,
lib/google/apis/recaptchaenterprise_v1/representations.rb,
lib/google/apis/recaptchaenterprise_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecaptchaenterpriseV1FirewallPolicy

Returns a new instance of GoogleCloudRecaptchaenterpriseV1FirewallPolicy.



612
613
614
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 612

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#actions ⇒ Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1FirewallAction>

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. Corresponds to the JSON property actions

Returns:



579
580
581
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 579

def actions
  @actions
end

#condition ⇒ String

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. Corresponds to the JSON property condition

Returns:

  • (String) 


591
592
593
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 591

def condition
  @condition
end

#description ⇒ String

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

Returns:

  • (String) 


597
598
599
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 597

def description
  @description
end

#name ⇒ String

The resource name for the FirewallPolicy in the format "projects/project/ firewallpolicies/firewallpolicy". Corresponds to the JSON property name

Returns:

  • (String) 


603
604
605
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 603

def name
  @name
end

#path ⇒ String

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. Corresponds to the JSON property path

Returns:

  • (String) 


610
611
612
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 610

def path
  @path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



617
618
619
620
621
622
623
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 617

def update!(**args)
  @actions = args[:actions] if args.key?(:actions)
  @condition = args[:condition] if args.key?(:condition)
  @description = args[:description] if args.key?(:description)
  @name = args[:name] if args.key?(:name)
  @path = args[:path] if args.key?(:path)
end