Class: Google::Apis::ComputeAlpha::Subnetwork

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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 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 $api_version.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.



32603
32604
32605
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32603

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

Instance Attribute Details

#aggregation_interval ⇒ String

Can only be specified if VPC flow logging for this subnetwork is enabled. Sets the aggregation interval for collecting flow logs. Increasing the interval time reduces the amount of generated flow logs for long-lasting connections. Default is an interval of 5 seconds per connection. Valid values: INTERVAL_5_SEC, INTERVAL_30_SEC, INTERVAL_1_MIN, INTERVAL_5_MIN, INTERVAL_10_MIN, INTERVAL_15_MIN. Corresponds to the JSON property aggregationInterval

Returns:

  • (String) 


32390
32391
32392
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32390

def aggregation_interval
  @aggregation_interval
end

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


32405
32406
32407
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32405

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) 


32411
32412
32413
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32411

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) 


32417
32418
32419
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32417

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) 


32424
32425
32426
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32424

def enable_flow_logs
  @enable_flow_logs
end

#enable_private_v6_access ⇒ Boolean Also known as: enable_private_v6_access?

Deprecated in favor of enable in PrivateIpv6GoogleAccess. Whether the VMs in this subnet can directly access Google services via internal IPv6 addresses. This field can be both set at resource creation time and updated using patch. Corresponds to the JSON property enablePrivateV6Access

Returns:

  • (Boolean) 


32432
32433
32434
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32432

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


32444
32445
32446
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32444

def fingerprint
  @fingerprint
end

#flow_sampling ⇒ Float

Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5, which means half of all collected logs are reported. Corresponds to the JSON property flowSampling

Returns:

  • (Float) 


32453
32454
32455
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32453

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


32459
32460
32461
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32459

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) 


32465
32466
32467
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32465

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) 


32473
32474
32475
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32473

def ip_cidr_range
  @ip_cidr_range
end

#ipv6_cidr_range ⇒ String

[Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. Corresponds to the JSON property ipv6CidrRange

Returns:

  • (String) 


32479
32480
32481
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32479

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) 


32485
32486
32487
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32485

def kind
  @kind
end

#log_config ⇒ Google::Apis::ComputeAlpha::SubnetworkLogConfig

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

Returns:



32490
32491
32492
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32490

def log_config
  @log_config
end

#metadata ⇒ String

Can only be specified if VPC flow logging for this subnetwork is enabled. Configures whether metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA. Corresponds to the JSON property metadata

Returns:

  • (String) 


32497
32498
32499
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32497

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


32507
32508
32509
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32507

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) 


32515
32516
32517
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32515

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) 


32522
32523
32524
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32522

def private_ip_google_access
  @private_ip_google_access
end

#private_ipv6_google_access ⇒ String

The private IPv6 google access type for the VMs in this subnet. This is an expanded field of enablePrivateV6Access. If both fields are set, privateIpv6GoogleAccess will take priority. This field can be both set at resource creation time and updated using patch. Corresponds to the JSON property privateIpv6GoogleAccess

Returns:

  • (String) 


32531
32532
32533
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32531

def private_ipv6_google_access
  @private_ipv6_google_access
end

#private_ipv6_google_access_service_accounts ⇒ Array<String>

Deprecated in favor of enable PrivateIpv6GoogleAccess on instance directly. The service accounts can be used to selectively turn on Private IPv6 Google Access only on the VMs primary service account matching the value. This value only takes effect when PrivateIpv6GoogleAccess is ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS or ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS. Corresponds to the JSON property privateIpv6GoogleAccessServiceAccounts

Returns:

  • (Array<String>) 


32541
32542
32543
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32541

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


32550
32551
32552
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32550

def purpose
  @purpose
end

#range_type ⇒ String

The type of IP CIDR range to associate with this subnetwork. The default is RFC_1918. When creating a subnetwork in non-RFC 1918 range, this field must be set to NON_RFC_1918. Corresponds to the JSON property rangeType

Returns:

  • (String) 


32557
32558
32559
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32557

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


32563
32564
32565
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32563

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) 


32573
32574
32575
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32573

def role
  @role
end

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



32581
32582
32583
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32581

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) 


32586
32587
32588
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32586

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


32591
32592
32593
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32591

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


32601
32602
32603
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32601

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32608
32609
32610
32611
32612
32613
32614
32615
32616
32617
32618
32619
32620
32621
32622
32623
32624
32625
32626
32627
32628
32629
32630
32631
32632
32633
32634
32635
32636
32637
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 32608

def update!(**args)
  @aggregation_interval = args[:aggregation_interval] if args.key?(:aggregation_interval)
  @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)
  @enable_private_v6_access = args[:enable_private_v6_access] if args.key?(:enable_private_v6_access)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @flow_sampling = args[:flow_sampling] if args.key?(:flow_sampling)
  @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)
  @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)
  @metadata = args[:metadata] if args.key?(:metadata)
  @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)
  @private_ipv6_google_access_service_accounts = args[:private_ipv6_google_access_service_accounts] if args.key?(:private_ipv6_google_access_service_accounts)
  @purpose = args[:purpose] if args.key?(:purpose)
  @range_type = args[:range_type] if args.key?(:range_type)
  @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)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @state = args[:state] if args.key?(:state)
end