Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Firewall (v2.7.2)

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

Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#allowed

def allowed() -> ::Array<::Google::Cloud::Compute::V1::Allowed>

Returns

(::Array<::Google::Cloud::Compute::V1::Allowed>) — The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

#allowed=

def allowed=(value) -> ::Array<::Google::Cloud::Compute::V1::Allowed>

Parameter

value (::Array<::Google::Cloud::Compute::V1::Allowed>) — The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

Returns

(::Array<::Google::Cloud::Compute::V1::Allowed>) — The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

#creation_timestamp

def creation_timestamp() -> ::String

Returns

(::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String

Parameter

value (::String) — [Output Only] Creation timestamp in RFC3339 text format.

Returns

(::String) — [Output Only] Creation timestamp in RFC3339 text format.

#denied

def denied() -> ::Array<::Google::Cloud::Compute::V1::Denied>

Returns

(::Array<::Google::Cloud::Compute::V1::Denied>) — The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

#denied=

def denied=(value) -> ::Array<::Google::Cloud::Compute::V1::Denied>

Parameter

value (::Array<::Google::Cloud::Compute::V1::Denied>) — The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

Returns

(::Array<::Google::Cloud::Compute::V1::Denied>) — The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

#description

def description() -> ::String

Returns

(::String) — An optional description of this resource. Provide this field when you create the resource.

#description=

def description=(value) -> ::String

Parameter

value (::String) — An optional description of this resource. Provide this field when you create the resource.

Returns

(::String) — An optional description of this resource. Provide this field when you create the resource.

#destination_ranges

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

Returns

(::Array<::String>) — If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

#destination_ranges=

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

Parameter

value (::Array<::String>) — If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

Returns

(::Array<::String>) — If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

#direction

def direction() -> ::String

Returns

(::String) — Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields. Check the Direction enum for the list of possible values.

#direction=

def direction=(value) -> ::String

Parameter

value (::String) — Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields. Check the Direction enum for the list of possible values.

Returns

(::String) — Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields. Check the Direction enum for the list of possible values.

#disabled

def disabled() -> ::Boolean

Returns

(::Boolean) — Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

#disabled=

def disabled=(value) -> ::Boolean

Parameter

value (::Boolean) — Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

Returns

(::Boolean) — Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

#id

def id() -> ::Integer

Returns

(::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer

Parameter

value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns

(::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#kind

def kind() -> ::String

Returns

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

#kind=

def kind=(value) -> ::String

Parameter

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

Returns

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

#log_config

def log_config() -> ::Google::Cloud::Compute::V1::FirewallLogConfig

Returns

(::Google::Cloud::Compute::V1::FirewallLogConfig) — This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

#log_config=

def log_config=(value) -> ::Google::Cloud::Compute::V1::FirewallLogConfig

Parameter

value (::Google::Cloud::Compute::V1::FirewallLogConfig) — This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

Returns

(::Google::Cloud::Compute::V1::FirewallLogConfig) — This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

#name

def name() -> ::String

Returns

(::String) — Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

Returns

(::String) — Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

#network

def network() -> ::String

Returns

(::String) — URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

#network=

def network=(value) -> ::String

Parameter

value (::String) — URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

Returns

(::String) — URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

#priority

def priority() -> ::Integer

Returns

(::Integer) — Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535.

#priority=

def priority=(value) -> ::Integer

Parameter

value (::Integer) — Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535.

Returns

(::Integer) — Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535.

#self_link

def self_link() -> ::String

Returns

(::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String

Parameter

value (::String) — [Output Only] Server-defined URL for the resource.

Returns

(::String) — [Output Only] Server-defined URL for the resource.

#source_ranges

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

Returns

(::Array<::String>) — If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

#source_ranges=

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

Parameter

value (::Array<::String>) — If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

Returns

(::Array<::String>) — If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

#source_service_accounts

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

Returns

(::Array<::String>) — If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

#source_service_accounts=

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

Parameter

value (::Array<::String>) — If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

Returns

(::Array<::String>) — If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

#source_tags

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

Returns

(::Array<::String>) — If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

#source_tags=

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

Parameter

value (::Array<::String>) — If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

Returns

(::Array<::String>) — If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

#target_service_accounts

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

Returns

(::Array<::String>) — A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

#target_service_accounts=

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

Parameter

value (::Array<::String>) — A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

Returns

(::Array<::String>) — A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

#target_tags

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

Returns

(::Array<::String>) — A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

#target_tags=

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

Parameter

value (::Array<::String>) — A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

Returns

(::Array<::String>) — A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.