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.



7792
7793
7794
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7792

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) 


7725
7726
7727
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7725

def action
  @action
end

#description ⇒ String

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

Returns:

  • (String) 


7730
7731
7732
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7730

def description
  @description
end

#direction ⇒ String

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

Returns:

  • (String) 


7735
7736
7737
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7735

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) 


7742
7743
7744
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7742

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) 


7751
7752
7753
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7751

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) 


7758
7759
7760
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7758

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:



7764
7765
7766
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7764

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) 


7772
7773
7774
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7772

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) 


7777
7778
7779
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7777

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


7784
7785
7786
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7784

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


7790
7791
7792
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7790

def target_service_accounts
  @target_service_accounts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
 
# File 'lib/google/apis/compute_v1/classes.rb', line 7797

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