Class: Google::Apis::ComputeV1::SecurityPolicyRule

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

Overview

Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SecurityPolicyRule

Returns a new instance of SecurityPolicyRule.



30869
30870
30871
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30869

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

Instance Attribute Details

#action ⇒ String

The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502).

  • rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. Corresponds to the JSON property action

Returns:

  • (String) 


30818
30819
30820
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30818

def action
  @action
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


30824
30825
30826
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30824

def description
  @description
end

#header_action ⇒ Google::Apis::ComputeV1::SecurityPolicyRuleHttpHeaderAction

Optional, additional actions that are performed on headers. Corresponds to the JSON property headerAction

Returns:



30829
30830
30831
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30829

def header_action
  @header_action
end

#kind ⇒ String

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules Corresponds to the JSON property kind

Returns:

  • (String) 


30835
30836
30837
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30835

def kind
  @kind
end

#match ⇒ Google::Apis::ComputeV1::SecurityPolicyRuleMatcher

Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. Corresponds to the JSON property match

Returns:



30841
30842
30843
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30841

def match
  @match
end

#preview ⇒ Boolean Also known as: preview?

If set to true, the specified action is not enforced. Corresponds to the JSON property preview

Returns:

  • (Boolean) 


30846
30847
30848
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30846

def preview
  @preview
end

#priority ⇒ Fixnum

An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


30855
30856
30857
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30855

def priority
  @priority
end

#rate_limit_options ⇒ Google::Apis::ComputeV1::SecurityPolicyRuleRateLimitOptions

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. Corresponds to the JSON property rateLimitOptions

Returns:



30861
30862
30863
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30861

def rate_limit_options
  @rate_limit_options
end

#redirect_options ⇒ Google::Apis::ComputeV1::SecurityPolicyRuleRedirectOptions

Parameters defining the redirect action. Cannot be specified for any other actions. Corresponds to the JSON property redirectOptions

Returns:



30867
30868
30869
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30867

def redirect_options
  @redirect_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30874
30875
30876
30877
30878
30879
30880
30881
30882
30883
30884
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30874

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @description = args[:description] if args.key?(:description)
  @header_action = args[:header_action] if args.key?(:header_action)
  @kind = args[:kind] if args.key?(:kind)
  @match = args[:match] if args.key?(:match)
  @preview = args[:preview] if args.key?(:preview)
  @priority = args[:priority] if args.key?(:priority)
  @rate_limit_options = args[:rate_limit_options] if args.key?(:rate_limit_options)
  @redirect_options = args[:redirect_options] if args.key?(:redirect_options)
end