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.



10403
10404
10405
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10403

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

Instance Attribute Details

#action ⇒ String

The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". Corresponds to the JSON property action

Returns:

  • (String) 


10302
10303
10304
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10302

def action
  @action
end

#description ⇒ String

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

Returns:

  • (String) 


10307
10308
10309
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10307

def description
  @description
end

#direction ⇒ String

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

Returns:

  • (String) 


10312
10313
10314
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10312

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) 


10319
10320
10321
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10319

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) 


10328
10329
10330
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10328

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) 


10335
10336
10337
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10335

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:



10341
10342
10343
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10341

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) 


10349
10350
10351
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10349

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) 


10355
10356
10357
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10355

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


10360
10361
10362
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10360

def rule_tuple_count
  @rule_tuple_count
end

#security_profile_group ⇒ String

A fully-qualified URL of a SecurityProfile resource instance. Example: https:// networksecurity.googleapis.com/v1/projects/project/locations/location/ securityProfileGroups/my-security-profile-group Must be specified if action = ' apply_security_profile_group' and cannot be specified for other actions. Corresponds to the JSON property securityProfileGroup

Returns:

  • (String) 


10368
10369
10370
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10368

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


10375
10376
10377
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10375

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 as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag 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:



10387
10388
10389
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10387

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


10393
10394
10395
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10393

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


10400
10401
10402
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10400

def tls_inspect
  @tls_inspect
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10408

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_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)
  @tls_inspect = args[:tls_inspect] if args.key?(:tls_inspect)
end