Class: Google::Apis::ComputeAlpha::FirewallPolicyRule

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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.



15822
15823
15824
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15822

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

Instance Attribute Details

#action ⇒ String

The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next" ( "apply_security_profile_group" can be specified only for global network firewall policies or hierarchical firewall policies). Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". Corresponds to the JSON property action

Returns:

  • (String) 


15689
15690
15691
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15689

def action
  @action
end

#description ⇒ String

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

Returns:

  • (String) 


15694
15695
15696
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15694

def description
  @description
end

#direction ⇒ String

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

Returns:

  • (String) 


15699
15700
15701
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15699

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) 


15707
15708
15709
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15707

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) 


15716
15717
15718
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15716

def enable_logging
  @enable_logging
end

#kind ⇒ String

Output only. [Output only] Type of the resource. Returnscompute# firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules. Corresponds to the JSON property kind

Returns:

  • (String) 


15724
15725
15726
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15724

def kind
  @kind
end

#match ⇒ Google::Apis::ComputeAlpha::FirewallPolicyRuleMatcher

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

Returns:



15730
15731
15732
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15730

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

Returns:

  • (Fixnum) 


15738
15739
15740
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15738

def priority
  @priority
end

#rule_name ⇒ String

An optional name for the rule. This field is not a unique identifier and can be updated. Corresponds to the JSON property ruleName

Returns:

  • (String) 


15744
15745
15746
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15744

def rule_name
  @rule_name
end

#rule_tuple_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


15751
15752
15753
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15751

def rule_tuple_count
  @rule_tuple_count
end

#security_profile_group ⇒ String

A fully-qualified URL of a SecurityProfileGroup resource instance. Example: https://networksecurity.googleapis.com/v1/projects/`project`/locations/` location/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. Can be specified only for global network firewall policies or hierarchical firewall policies. Corresponds to the JSON propertysecurityProfileGroup`

Returns:

  • (String) 


15762
15763
15764
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15762

def security_profile_group
  @security_profile_group
end

#target_forwarding_rules ⇒ Array<String>

A list of forwarding rules to which this rule applies. This field allows you to control which load balancers get this rule. For example, the following are valid values:

Returns:

  • (Array<String>) 


15779
15780
15781
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15779

def target_forwarding_rules
  @target_forwarding_rules
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>) 


15786
15787
15788
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15786

def target_resources
  @target_resources
end

#target_secure_tags ⇒ Array<Google::Apis::ComputeAlpha::FirewallPolicyRuleSecureTag>

A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts. If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. Corresponds to the JSON property targetSecureTags

Returns:



15800
15801
15802
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15800

def target_secure_tags
  @target_secure_tags
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>) 


15806
15807
15808
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15806

def target_service_accounts
  @target_service_accounts
end

#target_type ⇒ String

Target types of the firewall policy rule. Default value is INSTANCES. Corresponds to the JSON property targetType

Returns:

  • (String) 


15812
15813
15814
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15812

def target_type
  @target_type
end

#tls_inspect ⇒ Boolean Also known as: tls_inspect?

Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. Corresponds to the JSON property tlsInspect

Returns:

  • (Boolean) 


15819
15820
15821
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15819

def tls_inspect
  @tls_inspect
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15827

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_name = args[:rule_name] if args.key?(:rule_name)
  @rule_tuple_count = args[:rule_tuple_count] if args.key?(:rule_tuple_count)
  @security_profile_group = args[:security_profile_group] if args.key?(:security_profile_group)
  @target_forwarding_rules = args[:target_forwarding_rules] if args.key?(:target_forwarding_rules)
  @target_resources = args[:target_resources] if args.key?(:target_resources)
  @target_secure_tags = args[:target_secure_tags] if args.key?(:target_secure_tags)
  @target_service_accounts = args[:target_service_accounts] if args.key?(:target_service_accounts)
  @target_type = args[:target_type] if args.key?(:target_type)
  @tls_inspect = args[:tls_inspect] if args.key?(:tls_inspect)
end