Class: Google::Apis::ComputeBeta::Subnetwork

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

Overview

Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==)

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) ⇒ Subnetwork

Returns a new instance of Subnetwork



25626
25627
25628
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25626

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

Instance Attribute Details

#allow_subnet_cidr_routes_overlap ⇒ Boolean Also known as: allow_subnet_cidr_routes_overlap?

Whether this subnetwork can conflict with static routes. Setting this to true allows this subnetwork's primary and secondary ranges to conflict with routes that have already been configured on the corresponding network. Static routes will take precedence over the subnetwork route if the route prefix length is at least as large as the subnetwork prefix length. Also, packets destined to IPs within subnetwork may contain private/sensitive data and are prevented from leaving the virtual network. Setting this field to true will disable this feature. The default value is false and applies to all existing subnetworks and automatically created subnetworks. This field cannot be set to true at resource creation time. Corresponds to the JSON property allowSubnetCidrRoutesOverlap

Returns:

  • (Boolean) 


25488
25489
25490
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25488

def allow_subnet_cidr_routes_overlap
  @allow_subnet_cidr_routes_overlap
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


25494
25495
25496
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25494

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. Corresponds to the JSON property description

Returns:

  • (String) 


25500
25501
25502
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25500

def description
  @description
end

#enable_flow_logs ⇒ Boolean Also known as: enable_flow_logs?

Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. Corresponds to the JSON property enableFlowLogs

Returns:

  • (Boolean) 


25507
25508
25509
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25507

def enable_flow_logs
  @enable_flow_logs
end

#fingerprint ⇒ String

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


25519
25520
25521
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25519

def fingerprint
  @fingerprint
end

#gateway_address ⇒ String

[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. Corresponds to the JSON property gatewayAddress

Returns:

  • (String) 


25525
25526
25527
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25525

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


25531
25532
25533
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25531

def id
  @id
end

#ip_cidr_range ⇒ String

The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192. 168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. Corresponds to the JSON property ipCidrRange

Returns:

  • (String) 


25539
25540
25541
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25539

def ip_cidr_range
  @ip_cidr_range
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. Corresponds to the JSON property kind

Returns:

  • (String) 


25545
25546
25547
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25545

def kind
  @kind
end

#log_config ⇒ Google::Apis::ComputeBeta::SubnetworkLogConfig

The available logging options for this subnetwork. Corresponds to the JSON property logConfig

Returns:



25550
25551
25552
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25550

def log_config
  @log_config
end

#name ⇒ String

The name of the resource, provided by the client when initially creating the resource. 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

Returns:

  • (String) 


25560
25561
25562
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25560

def name
  @name
end

#network ⇒ String

The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. Corresponds to the JSON property network

Returns:

  • (String) 


25568
25569
25570
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25568

def network
  @network
end

#private_ip_google_access ⇒ Boolean Also known as: private_ip_google_access?

Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. Corresponds to the JSON property privateIpGoogleAccess

Returns:

  • (Boolean) 


25575
25576
25577
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25575

def private_ip_google_access
  @private_ip_google_access
end

#purpose ⇒ String

The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. Corresponds to the JSON property purpose

Returns:

  • (String) 


25585
25586
25587
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25585

def purpose
  @purpose
end

#region ⇒ String

URL of the region where the Subnetwork resides. This field can be set only at resource creation time. Corresponds to the JSON property region

Returns:

  • (String) 


25591
25592
25593
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25591

def region
  @region
end

#role ⇒ String

The role of subnetwork. Currenly, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. Corresponds to the JSON property role

Returns:

  • (String) 


25601
25602
25603
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25601

def role
  @role
end

#secondary_ip_ranges ⇒ Array<Google::Apis::ComputeBeta::SubnetworkSecondaryRange>

An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. Corresponds to the JSON property secondaryIpRanges

Returns:



25609
25610
25611
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25609

def secondary_ip_ranges
  @secondary_ip_ranges
end

#self_link ⇒ String

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

Returns:

  • (String) 


25614
25615
25616
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25614

def self_link
  @self_link
end

#state ⇒ String

[Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY. Corresponds to the JSON property state

Returns:

  • (String) 


25624
25625
25626
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25624

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



25631
25632
25633
25634
25635
25636
25637
25638
25639
25640
25641
25642
25643
25644
25645
25646
25647
25648
25649
25650
25651
 
# File 'generated/google/apis/compute_beta/classes.rb', line 25631

def update!(**args)
  @allow_subnet_cidr_routes_overlap = args[:allow_subnet_cidr_routes_overlap] if args.key?(:allow_subnet_cidr_routes_overlap)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @enable_flow_logs = args[:enable_flow_logs] if args.key?(:enable_flow_logs)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @gateway_address = args[:gateway_address] if args.key?(:gateway_address)
  @id = args[:id] if args.key?(:id)
  @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
  @kind = args[:kind] if args.key?(:kind)
  @log_config = args[:log_config] if args.key?(:log_config)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @private_ip_google_access = args[:private_ip_google_access] if args.key?(:private_ip_google_access)
  @purpose = args[:purpose] if args.key?(:purpose)
  @region = args[:region] if args.key?(:region)
  @role = args[:role] if args.key?(:role)
  @secondary_ip_ranges = args[:secondary_ip_ranges] if args.key?(:secondary_ip_ranges)
  @self_link = args[:self_link] if args.key?(:self_link)
  @state = args[:state] if args.key?(:state)
end