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.



8457
8458
8459
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8457

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) 


8372
8373
8374
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8372

def action
  @action
end

#description ⇒ String

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

Returns:

  • (String) 


8377
8378
8379
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8377

def description
  @description
end

#direction ⇒ String

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

Returns:

  • (String) 


8382
8383
8384
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8382

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) 


8389
8390
8391
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8389

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) 


8398
8399
8400
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8398

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) 


8405
8406
8407
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8405

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:



8411
8412
8413
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8411

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) 


8419
8420
8421
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8419

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) 


8425
8426
8427
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8425

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) 


8430
8431
8432
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8430

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


8437
8438
8439
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8437

def target_resources
  @target_resources
end

#target_secure_tags ⇒ Array<Google::Apis::ComputeV1::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:



8449
8450
8451
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8449

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


8455
8456
8457
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8455

def target_service_accounts
  @target_service_accounts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8462

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