Class: Google::Apis::ComputeAlpha::FirewallPolicyRule
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::FirewallPolicyRule
- 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
-
#action ⇒ String
The Action to perform when the client connection triggers the rule.
-
#description ⇒ String
An optional description for this resource.
-
#direction ⇒ String
The direction in which this rule applies.
-
#disabled ⇒ Boolean
(also: #disabled?)
Denotes whether the firewall policy rule is disabled.
-
#enable_logging ⇒ Boolean
(also: #enable_logging?)
Denotes whether to enable logging for a particular rule.
-
#kind ⇒ String
[Output only] Type of the resource.
-
#match ⇒ Google::Apis::ComputeAlpha::FirewallPolicyRuleMatcher
Represents a match condition that incoming traffic is evaluated against.
-
#priority ⇒ Fixnum
An integer indicating the priority of a rule in the list.
-
#rule_name ⇒ String
An optional name for the rule.
-
#rule_tuple_count ⇒ Fixnum
[Output Only] Calculation of the complexity of a single firewall policy rule.
-
#security_profile_group ⇒ String
A fully-qualified URL of a SecurityProfile resource instance.
-
#target_resources ⇒ Array<String>
A list of network resource URLs to which this rule applies.
-
#target_secure_tags ⇒ Array<Google::Apis::ComputeAlpha::FirewallPolicyRuleSecureTag>
A list of secure tags that controls which instances the firewall rule applies to.
-
#target_service_accounts ⇒ Array<String>
A list of service accounts indicating the sets of instances that are applied with this rule.
Instance Method Summary collapse
-
#initialize(**args) ⇒ FirewallPolicyRule
constructor
A new instance of FirewallPolicyRule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ FirewallPolicyRule
Returns a new instance of FirewallPolicyRule.
9427 9428 9429 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9427 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
9334 9335 9336 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9334 def action @action end |
#description ⇒ String
An optional description for this resource.
Corresponds to the JSON property description
9339 9340 9341 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9339 def description @description end |
#direction ⇒ String
The direction in which this rule applies.
Corresponds to the JSON property direction
9344 9345 9346 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9344 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
9351 9352 9353 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9351 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
9360 9361 9362 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9360 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
9367 9368 9369 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9367 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
9373 9374 9375 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9373 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
9381 9382 9383 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9381 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
9387 9388 9389 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9387 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
9392 9393 9394 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9392 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
9400 9401 9402 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9400 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
9407 9408 9409 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9407 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
9419 9420 9421 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9419 def @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
9425 9426 9427 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9425 def target_service_accounts @target_service_accounts end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 9432 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) end |