Class: Google::Apis::ComputeV1::Subnetwork

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Subnetwork

Returns a new instance of Subnetwork.



35581
35582
35583
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35581

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

Instance Attribute Details

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


35408
35409
35410
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35408

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) 


35414
35415
35416
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35414

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 determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER. Corresponds to the JSON property enableFlowLogs

Returns:

  • (Boolean) 


35423
35424
35425
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35423

def enable_flow_logs
  @enable_flow_logs
end

#external_ipv6_prefix ⇒ String

The external IPv6 address range that is owned by this subnetwork. Corresponds to the JSON property externalIpv6Prefix

Returns:

  • (String) 


35429
35430
35431
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35429

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


35440
35441
35442
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35440

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) 


35446
35447
35448
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35446

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) 


35452
35453
35454
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35452

def id
  @id
end

#internal_ipv6_prefix ⇒ String

[Output Only] The internal IPv6 address range that is assigned to this subnetwork. Corresponds to the JSON property internalIpv6Prefix

Returns:

  • (String) 


35458
35459
35460
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35458

def internal_ipv6_prefix
  @internal_ipv6_prefix
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 100. 64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. Corresponds to the JSON property ipCidrRange

Returns:

  • (String) 


35468
35469
35470
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35468

def ip_cidr_range
  @ip_cidr_range
end

#ipv6_access_type ⇒ String

The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. Corresponds to the JSON property ipv6AccessType

Returns:

  • (String) 


35475
35476
35477
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35475

def ipv6_access_type
  @ipv6_access_type
end

#ipv6_cidr_range ⇒ String

[Output Only] This field is for internal use. Corresponds to the JSON property ipv6CidrRange

Returns:

  • (String) 


35480
35481
35482
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35480

def ipv6_cidr_range
  @ipv6_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) 


35486
35487
35488
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35486

def kind
  @kind
end

#log_config ⇒ Google::Apis::ComputeV1::SubnetworkLogConfig

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

Returns:



35491
35492
35493
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35491

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) 


35501
35502
35503
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35501

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. This field can be set only at resource creation time. Corresponds to the JSON property network

Returns:

  • (String) 


35508
35509
35510
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35508

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) 


35515
35516
35517
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35515

def private_ip_google_access
  @private_ip_google_access
end

#private_ipv6_google_access ⇒ String

This field is for internal use. This field can be both set at resource creation time and updated using patch. Corresponds to the JSON property privateIpv6GoogleAccess

Returns:

  • (String) 


35522
35523
35524
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35522

def private_ipv6_google_access
  @private_ipv6_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. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER. Corresponds to the JSON property purpose

Returns:

  • (String) 


35532
35533
35534
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35532

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) 


35538
35539
35540
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35538

def region
  @region
end

#role ⇒ String

The role of subnetwork. Currently, 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) 


35548
35549
35550
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35548

def role
  @role
end

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



35556
35557
35558
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35556

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) 


35561
35562
35563
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35561

def self_link
  @self_link
end

#stack_type ⇒ String

The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. Corresponds to the JSON property stackType

Returns:

  • (String) 


35569
35570
35571
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35569

def stack_type
  @stack_type
end

#state ⇒ String

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: 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) 


35579
35580
35581
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35579

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



35586
35587
35588
35589
35590
35591
35592
35593
35594
35595
35596
35597
35598
35599
35600
35601
35602
35603
35604
35605
35606
35607
35608
35609
35610
35611
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35586

def update!(**args)
  @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)
  @external_ipv6_prefix = args[:external_ipv6_prefix] if args.key?(:external_ipv6_prefix)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @gateway_address = args[:gateway_address] if args.key?(:gateway_address)
  @id = args[:id] if args.key?(:id)
  @internal_ipv6_prefix = args[:internal_ipv6_prefix] if args.key?(:internal_ipv6_prefix)
  @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
  @ipv6_access_type = args[:ipv6_access_type] if args.key?(:ipv6_access_type)
  @ipv6_cidr_range = args[:ipv6_cidr_range] if args.key?(:ipv6_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)
  @private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_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)
  @stack_type = args[:stack_type] if args.key?(:stack_type)
  @state = args[:state] if args.key?(:state)
end