Class: Google::Apis::ComputeV1::Firewall

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.rb

Overview

Represents a Firewall resource.

Defined Under Namespace

Classes: Allowed, Denied

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Firewall

Returns a new instance of Firewall



4438
4439
4440
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4438

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allowed ⇒ Array<Google::Apis::ComputeV1::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

Returns:



4300
4301
4302
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4300

def allowed
  @allowed
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


4305
4306
4307
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4305

def creation_timestamp
  @creation_timestamp
end

#denied ⇒ Array<Google::Apis::ComputeV1::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

Returns:



4311
4312
4313
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4311

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

Returns:

  • (String) 


4317
4318
4319
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4317

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

Returns:

  • (Array<String>) 


4324
4325
4326
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4324

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

Returns:

  • (String) 


4331
4332
4333
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4331

def direction
  @direction
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


4337
4338
4339
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4337

def id
  @id
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#firewall for firewall rules. Corresponds to the JSON property kind

Returns:

  • (String) 


4342
4343
4344
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4342

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

Returns:

  • (String) 


4352
4353
4354
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4352

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:

Returns:

  • (String) 


4365
4366
4367
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4365

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

Returns:

  • (Fixnum) 


4374
4375
4376
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4374

def priority
  @priority
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


4379
4380
4381
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4379

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

Returns:

  • (Array<String>) 


4390
4391
4392
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4390

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

Returns:

  • (Array<String>) 


4405
4406
4407
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4405

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

Returns:

  • (Array<String>) 


4419
4420
4421
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4419

def source_tags
  @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

Returns:

  • (Array<String>) 


4428
4429
4430
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4428

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

Returns:

  • (Array<String>) 


4436
4437
4438
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4436

def target_tags
  @target_tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4443

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