Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::FirewallPolicyRule (v2.3.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::FirewallPolicyRule.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#action

def action() -> ::String

Returns

(::String) — The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

#action=

def action=(value) -> ::String

Parameter

value (::String) — The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

Returns

(::String) — The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

#description

def description() -> ::String

Returns

(::String) — An optional description for this resource.

#description=

def description=(value) -> ::String

Parameter

value (::String) — An optional description for this resource.

Returns

(::String) — An optional description for this resource.

#direction

def direction() -> ::String

Returns

(::String) — The direction in which this rule applies. Check the Direction enum for the list of possible values.

#direction=

def direction=(value) -> ::String

Parameter

value (::String) — The direction in which this rule applies. Check the Direction enum for the list of possible values.

Returns

(::String) — The direction in which this rule applies. Check the Direction enum for the list of possible values.

#disabled

def disabled() -> ::Boolean

Returns

(::Boolean) — 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.

#disabled=

def disabled=(value) -> ::Boolean

Parameter

value (::Boolean) — 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.

Returns

(::Boolean) — 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.

#enable_logging

def enable_logging() -> ::Boolean

Returns

(::Boolean) — 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.

#enable_logging=

def enable_logging=(value) -> ::Boolean

Parameter

value (::Boolean) — 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.

Returns

(::Boolean) — 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.

#kind

def kind() -> ::String

Returns

(::String) — [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

#kind=

def kind=(value) -> ::String

Parameter

value (::String) — [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

Returns

(::String) — [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

#match

def match() -> ::Google::Cloud::Compute::V1::FirewallPolicyRuleMatcher

Returns

(::Google::Cloud::Compute::V1::FirewallPolicyRuleMatcher) — A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

#match=

def match=(value) -> ::Google::Cloud::Compute::V1::FirewallPolicyRuleMatcher

Parameter

value (::Google::Cloud::Compute::V1::FirewallPolicyRuleMatcher) — A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

Returns

(::Google::Cloud::Compute::V1::FirewallPolicyRuleMatcher) — A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

#priority

def priority() -> ::Integer

Returns

(::Integer) — 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.

#priority=

def priority=(value) -> ::Integer

Parameter

value (::Integer) — 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.

Returns

(::Integer) — 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.

#rule_name

def rule_name() -> ::String

Returns

(::String) — An optional name for the rule. This field is not a unique identifier and can be updated.

#rule_name=

def rule_name=(value) -> ::String

Parameter

value (::String) — An optional name for the rule. This field is not a unique identifier and can be updated.

Returns

(::String) — An optional name for the rule. This field is not a unique identifier and can be updated.

#rule_tuple_count

def rule_tuple_count() -> ::Integer

Returns

(::Integer) — [Output Only] Calculation of the complexity of a single firewall policy rule.

#rule_tuple_count=

def rule_tuple_count=(value) -> ::Integer

Parameter

value (::Integer) — [Output Only] Calculation of the complexity of a single firewall policy rule.

Returns

(::Integer) — [Output Only] Calculation of the complexity of a single firewall policy rule.

#target_resources

def target_resources() -> ::Array<::String>

Returns

(::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.

#target_resources=

def target_resources=(value) -> ::Array<::String>

Parameter

value (::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.

Returns

(::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.

#target_secure_tags

def target_secure_tags() -> ::Array<::Google::Cloud::Compute::V1::FirewallPolicyRuleSecureTag>

Returns

(::Array<::Google::Cloud::Compute::V1::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.

#target_secure_tags=

def target_secure_tags=(value) -> ::Array<::Google::Cloud::Compute::V1::FirewallPolicyRuleSecureTag>

Parameter

value (::Array<::Google::Cloud::Compute::V1::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.

Returns

(::Array<::Google::Cloud::Compute::V1::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.

#target_service_accounts

def target_service_accounts() -> ::Array<::String>

Returns

(::Array<::String>) — A list of service accounts indicating the sets of instances that are applied with this rule.

#target_service_accounts=

def target_service_accounts=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — A list of service accounts indicating the sets of instances that are applied with this rule.

Returns

(::Array<::String>) — A list of service accounts indicating the sets of instances that are applied with this rule.