Class: Google::Apis::ComputeAlpha::Firewall
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Firewall
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
Represents a Firewall resource.
Defined Under Namespace
Instance Attribute Summary collapse
-
#allowed ⇒ Array<Google::Apis::ComputeAlpha::Firewall::Allowed>
The list of ALLOW rules specified by this firewall.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#denied ⇒ Array<Google::Apis::ComputeAlpha::Firewall::Denied>
The list of DENY rules specified by this firewall.
-
#description ⇒ String
An optional description of this resource.
-
#destination_ranges ⇒ Array<String>
If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges.
-
#direction ⇒ String
Direction of traffic to which this firewall applies; default is INGRESS.
-
#disabled ⇒ Boolean
(also: #disabled?)
Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with.
-
#enable_logging ⇒ Boolean
(also: #enable_logging?)
This field denotes whether to enable logging for a particular firewall rule.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#name ⇒ String
Name of the resource; provided by the client when the resource is created.
-
#network ⇒ String
URL of the network resource for this firewall rule.
-
#priority ⇒ Fixnum
Priority for this rule.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#source_ranges ⇒ Array<String>
If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges.
-
#source_service_accounts ⇒ Array<String>
If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list.
-
#source_tags ⇒ 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.
-
#target_service_accounts ⇒ Array<String>
A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[].
-
#target_tags ⇒ Array<String>
A list of tags that controls which instances the firewall rule applies to.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Firewall
constructor
A new instance of Firewall.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Firewall
Returns a new instance of Firewall
5374 5375 5376 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5374 def initialize(**args) update!(**args) end |
Instance Attribute Details
#allowed ⇒ Array<Google::Apis::ComputeAlpha::Firewall::Allowed>
The list of ALLOW rules specified by this firewall. Each rule specifies a
protocol and port-range tuple that describes a permitted connection.
Corresponds to the JSON property allowed
5218 5219 5220 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5218 def allowed @allowed end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
5223 5224 5225 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5223 def @creation_timestamp end |
#denied ⇒ Array<Google::Apis::ComputeAlpha::Firewall::Denied>
The list of DENY rules specified by this firewall. Each rule specifies a
protocol and port-range tuple that describes a denied connection.
Corresponds to the JSON property denied
5229 5230 5231 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5229 def denied @denied end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
5235 5236 5237 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5235 def description @description end |
#destination_ranges ⇒ Array<String>
If destination ranges are specified, the firewall will apply only to traffic
that has destination IP address in these ranges. These ranges must be
expressed in CIDR format. Only IPv4 is supported.
Corresponds to the JSON property destinationRanges
5242 5243 5244 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5242 def destination_ranges @destination_ranges end |
#direction ⇒ String
Direction of traffic to which this firewall applies; default is INGRESS. Note:
For INGRESS traffic, it is NOT supported to specify destinationRanges; For
EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
Corresponds to the JSON property direction
5249 5250 5251 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5249 def direction @direction end |
#disabled ⇒ Boolean Also known as: disabled?
Denotes whether the firewall rule is disabled, i.e not applied to the network
it is associated with. 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.
Corresponds to the JSON property disabled
5257 5258 5259 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5257 def disabled @disabled end |
#enable_logging ⇒ Boolean Also known as: enable_logging?
This field denotes whether to enable logging for a particular firewall rule.
If logging is enabled, logs will be exported to the configured export
destination for all firewall logs in the network. Logs may be exported to
BigQuery or Pub/Sub.
Corresponds to the JSON property enableLogging
5266 5267 5268 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5266 def enable_logging @enable_logging end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
5273 5274 5275 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5273 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#firewall for firewall rules.
Corresponds to the JSON property kind
5278 5279 5280 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5278 def kind @kind end |
#name ⇒ 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])?
which means the first character must be a lowercase letter,
and all following characters must be a dash, lowercase letter, or digit,
except the last character, which cannot be a dash.
Corresponds to the JSON property name
5288 5289 5290 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5288 def name @name end |
#network ⇒ 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 property, 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
Corresponds to the JSON property
network
5301 5302 5303 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5301 def network @network end |
#priority ⇒ Fixnum
Priority for this rule. This is an integer between 0 and 65535, both inclusive.
When not specified, the value assumed is 1000. Relative priorities determine
precedence of conflicting rules. Lower value of priority implies higher
precedence (eg, a rule with priority 0 has higher precedence than a rule with
priority 1). DENY rules take precedence over ALLOW rules having equal priority.
Corresponds to the JSON property priority
5310 5311 5312 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5310 def priority @priority end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
5315 5316 5317 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5315 def self_link @self_link end |
#source_ranges ⇒ Array<String>
If source ranges are specified, the firewall will apply only to traffic that
has 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
properties are set, the firewall will apply to traffic that has source IP
address within sourceRanges OR the source IP that belongs to a tag listed in
the sourceTags property. The connection does not need to match both properties
for the firewall to apply. Only IPv4 is supported.
Corresponds to the JSON property sourceRanges
5326 5327 5328 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5326 def source_ranges @source_ranges end |
#source_service_accounts ⇒ Array<String>
If source service accounts are specified, the firewall will 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 will apply to traffic
that has source IP address within sourceRanges OR the source IP belongs to an
instance with service account listed in sourceServiceAccount. The connection
does not need to match both properties for the firewall to apply.
sourceServiceAccounts cannot be used at the same time as sourceTags or
targetTags.
Corresponds to the JSON property sourceServiceAccounts
5341 5342 5343 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5341 def source_service_accounts @source_service_accounts end |
#source_tags ⇒ 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 properties are set, the firewall will apply to traffic
that has source IP address within sourceRanges OR the source IP that belongs
to a tag listed in the sourceTags property. The connection does not need to
match both properties for the firewall to apply.
Corresponds to the JSON property sourceTags
5355 5356 5357 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5355 def @source_tags end |
#target_service_accounts ⇒ 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.
Corresponds to the JSON property targetServiceAccounts
5364 5365 5366 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5364 def target_service_accounts @target_service_accounts end |
#target_tags ⇒ 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.
Corresponds to the JSON property targetTags
5372 5373 5374 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5372 def @target_tags end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5379 def update!(**args) @allowed = args[:allowed] if args.key?(:allowed) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @denied = args[:denied] if args.key?(:denied) @description = args[:description] if args.key?(:description) @destination_ranges = args[:destination_ranges] if args.key?(:destination_ranges) @direction = args[:direction] if args.key?(:direction) @disabled = args[:disabled] if args.key?(:disabled) @enable_logging = args[:enable_logging] if args.key?(:enable_logging) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) @priority = args[:priority] if args.key?(:priority) @self_link = args[:self_link] if args.key?(:self_link) @source_ranges = args[:source_ranges] if args.key?(:source_ranges) @source_service_accounts = args[:source_service_accounts] if args.key?(:source_service_accounts) @source_tags = args[:source_tags] if args.key?(:source_tags) @target_service_accounts = args[:target_service_accounts] if args.key?(:target_service_accounts) @target_tags = args[:target_tags] if args.key?(:target_tags) end |