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.



9067
9068
9069
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9067

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) 


8982
8983
8984
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8982

def action
  @action
end

#description ⇒ String

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

Returns:

  • (String) 


8987
8988
8989
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8987

def description
  @description
end

#direction ⇒ String

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

Returns:

  • (String) 


8992
8993
8994
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8992

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) 


8999
9000
9001
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8999

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) 


9008
9009
9010
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9008

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) 


9015
9016
9017
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9015

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:



9021
9022
9023
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9021

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) 


9029
9030
9031
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9029

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) 


9035
9036
9037
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9035

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) 


9040
9041
9042
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9040

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


9047
9048
9049
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9047

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:



9059
9060
9061
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9059

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


9065
9066
9067
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9065

def target_service_accounts
  @target_service_accounts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
 
# File 'lib/google/apis/compute_v1/classes.rb', line 9072

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