Class: Google::Apis::ComputeV1::FirewallPolicyRule

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) ⇒ FirewallPolicyRule

Returns a new instance of FirewallPolicyRule.



7723
7724
7725
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7723

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

Instance Attribute Details

#action ⇒ String

The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. Corresponds to the JSON property action

Returns:

  • (String) 


7656
7657
7658
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7656

def action
  @action
end

#description ⇒ String

An optional description for this resource. Corresponds to the JSON property description

Returns:

  • (String) 


7661
7662
7663
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7661

def description
  @description
end

#direction ⇒ String

The direction in which this rule applies. Corresponds to the JSON property direction

Returns:

  • (String) 


7666
7667
7668
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7666

def direction
  @direction
end

#disabled ⇒ Boolean Also known as: disabled?

Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


7673
7674
7675
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7673

def disabled
  @disabled
end

#enable_logging ⇒ Boolean Also known as: enable_logging?

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. Corresponds to the JSON property enableLogging

Returns:

  • (Boolean) 


7682
7683
7684
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7682

def enable_logging
  @enable_logging
end

#kind ⇒ String

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

Returns:

  • (String) 


7689
7690
7691
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7689

def kind
  @kind
end

#match ⇒ Google::Apis::ComputeV1::FirewallPolicyRuleMatcher

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

Returns:



7695
7696
7697
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7695

def match
  @match
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 prority. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


7703
7704
7705
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7703

def priority
  @priority
end

#rule_tuple_count ⇒ Fixnum

[Output Only] Calculation of the complexity of a single firewall policy rule. Corresponds to the JSON property ruleTupleCount

Returns:

  • (Fixnum) 


7708
7709
7710
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7708

def rule_tuple_count
  @rule_tuple_count
end

#target_resources ⇒ Array<String>

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. Corresponds to the JSON property targetResources

Returns:

  • (Array<String>) 


7715
7716
7717
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7715

def target_resources
  @target_resources
end

#target_service_accounts ⇒ Array<String>

A list of service accounts indicating the sets of instances that are applied with this rule. Corresponds to the JSON property targetServiceAccounts

Returns:

  • (Array<String>) 


7721
7722
7723
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7721

def target_service_accounts
  @target_service_accounts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7728

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @description = args[:description] if args.key?(:description)
  @direction = args[:direction] if args.key?(:direction)
  @disabled = args[:disabled] if args.key?(:disabled)
  @enable_logging = args[:enable_logging] if args.key?(:enable_logging)
  @kind = args[:kind] if args.key?(:kind)
  @match = args[:match] if args.key?(:match)
  @priority = args[:priority] if args.key?(:priority)
  @rule_tuple_count = args[:rule_tuple_count] if args.key?(:rule_tuple_count)
  @target_resources = args[:target_resources] if args.key?(:target_resources)
  @target_service_accounts = args[:target_service_accounts] if args.key?(:target_service_accounts)
end