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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Subnetwork

Returns a new instance of Subnetwork.



74823
74824
74825
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74823

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) 


74492
74493
74494
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74492

def aggregation_interval
  @aggregation_interval
end

#allow_subnet_cidr_routes_overlap ⇒ Boolean Also known as: allow_subnet_cidr_routes_overlap?

Whether this subnetwork's ranges can conflict with existing custom routes. Setting this to true allows this subnetwork's primary and secondary ranges to overlap with (and contain) custom routes that have already been configured on the corresponding network. For example if a static route has range 10.1.0.0/16, a subnet range 10.0.0.0/8 could only be created if allow_conflicting_routes=true. Overlapping is only allowed on subnetwork operations; routes whose ranges conflict with this subnetwork's ranges won't be allowed unless route.allow_conflicting_subnetworks is set to true. Typically packets destined to IPs within the subnetwork (which may contain private/sensitive data) 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. Corresponds to the JSON property allowSubnetCidrRoutesOverlap

Returns:

  • (Boolean) 


74510
74511
74512
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74510

def allow_subnet_cidr_routes_overlap
  @allow_subnet_cidr_routes_overlap
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


74517
74518
74519
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74517

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) 


74523
74524
74525
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74523

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 if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead. Corresponds to the JSON property enableFlowLogs

Returns:

  • (Boolean) 


74533
74534
74535
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74533

def enable_flow_logs
  @enable_flow_logs
end

#enable_l2 ⇒ Boolean Also known as: enable_l2?

Enables Layer2 communication on the subnetwork. Corresponds to the JSON property enableL2

Returns:

  • (Boolean) 


74539
74540
74541
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74539

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


74548
74549
74550
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74548

def enable_private_v6_access
  @enable_private_v6_access
end

#external_ipv6_prefix ⇒ String

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

Returns:

  • (String) 


74555
74556
74557
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74555

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) 


74567
74568
74569
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74567

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 is0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported. Corresponds to the JSON property flowSampling

Returns:

  • (Float) 


74577
74578
74579
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74577

def flow_sampling
  @flow_sampling
end

#gateway_address ⇒ String

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

Returns:

  • (String) 


74584
74585
74586
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74584

def gateway_address
  @gateway_address
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


74591
74592
74593
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74591

def id
  @id
end

#internal_ipv6_prefix ⇒ String

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

Returns:

  • (String) 


74597
74598
74599
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74597

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 theValid ranges list. The range can be expanded after creation usingexpandIpCidrRange. Corresponds to the JSON property ipCidrRange

Returns:

  • (String) 


74608
74609
74610
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74608

def ip_cidr_range
  @ip_cidr_range
end

#ip_collection ⇒ String

Reference to the source of IP, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION mode. Use one of the following formats to specify a sub-PDP when creating a dual stack or IPv6-only subnetwork with external access using BYOIP:

- Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/

projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name

Partial URL, as in

  • projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp- name
  • regions/region/publicDelegatedPrefixes/sub-pdp-name Corresponds to the JSON property ipCollection

Returns:

  • (String) 


74629
74630
74631
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74629

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


74636
74637
74638
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74636

def ipv6_access_type
  @ipv6_access_type
end

#ipv6_cidr_range ⇒ String

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

Returns:

  • (String) 


74641
74642
74643
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74641

def ipv6_cidr_range
  @ipv6_cidr_range
end

#ipv6_gce_endpoint ⇒ String

Output only. [Output Only] Possible endpoints of this subnetwork. It can be one of the following:

  • VM_ONLY: The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb.
  • VM_AND_FR: The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Google IP Pool directly. Corresponds to the JSON property ipv6GceEndpoint

Returns:

  • (String) 


74656
74657
74658
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74656

def ipv6_gce_endpoint
  @ipv6_gce_endpoint
end

#ipv6_network_tier ⇒ String

Specifies the network tier for EXTERNAL IPv6. Can only be set when ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not specified during the creation of the subnetwork. This field is IMMUTABLE once set with EXTERNAL IPv6. Corresponds to the JSON property ipv6NetworkTier

Returns:

  • (String) 


74664
74665
74666
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74664

def ipv6_network_tier
  @ipv6_network_tier
end

#kind ⇒ String

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

Returns:

  • (String) 


74670
74671
74672
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74670

def kind
  @kind
end

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

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

Returns:



74675
74676
74677
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74675

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. Options are INCLUDE_ALL_METADATA,EXCLUDE_ALL_METADATA, and CUSTOM_METADATA. Default is EXCLUDE_ALL_METADATA. Corresponds to the JSON property metadata

Returns:

  • (String) 


74684
74685
74686
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74684

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 withRFC1035. 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) 


74695
74696
74697
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74695

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) 


74702
74703
74704
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74702

def network
  @network
end

#params ⇒ Google::Apis::ComputeAlpha::SubnetworkParams

Additional subnetwork parameters. Corresponds to the JSON property params

Returns:



74707
74708
74709
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74707

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


74714
74715
74716
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74714

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 usingpatch. Corresponds to the JSON property privateIpv6GoogleAccess

Returns:

  • (String) 


74721
74722
74723
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74721

def private_ipv6_google_access
  @private_ipv6_google_access
end

#purpose ⇒ String

Corresponds to the JSON property purpose

Returns:

  • (String) 


74726
74727
74728
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74726

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) 


74732
74733
74734
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74732

def region
  @region
end

#reserved_internal_range ⇒ String

The URL of the reserved internal range. Corresponds to the JSON property reservedInternalRange

Returns:

  • (String) 


74737
74738
74739
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74737

def reserved_internal_range
  @reserved_internal_range
end

#resolve_subnet_mask ⇒ String

Configures subnet mask resolution for this subnetwork. Corresponds to the JSON property resolveSubnetMask

Returns:

  • (String) 


74742
74743
74744
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74742

def resolve_subnet_mask
  @resolve_subnet_mask
end

#role ⇒ String

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. 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) 


74753
74754
74755
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74753

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 apatch request. Supports both IPv4 and IPv6 ranges. Corresponds to the JSON property secondaryIpRanges

Returns:



74762
74763
74764
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74762

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) 


74767
74768
74769
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74767

def self_link
  @self_link
end

#self_link_with_id ⇒ String

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

Returns:

  • (String) 


74773
74774
74775
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74773

def self_link_with_id
  @self_link_with_id
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 toIPV4_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 usingpatch. Corresponds to the JSON property stackType

Returns:

  • (String) 


74782
74783
74784
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74782

def stack_type
  @stack_type
end

#state ⇒ String

Output only. [Output Only] The state of the subnetwork, which can be one of the following values:READY: Subnetwork is created and ready to useDRAINING: 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 ofREADY Corresponds to the JSON property state

Returns:

  • (String) 


74793
74794
74795
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74793

def state
  @state
end

#system_reserved_external_ipv6_ranges ⇒ Array<String>

Output only. [Output Only] The array of external IPv6 network ranges reserved from the subnetwork's external IPv6 range for system use. Corresponds to the JSON property systemReservedExternalIpv6Ranges

Returns:

  • (Array<String>) 


74800
74801
74802
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74800

def system_reserved_external_ipv6_ranges
  @system_reserved_external_ipv6_ranges
end

#system_reserved_internal_ipv6_ranges ⇒ Array<String>

Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use. Corresponds to the JSON property systemReservedInternalIpv6Ranges

Returns:

  • (Array<String>) 


74807
74808
74809
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74807

def system_reserved_internal_ipv6_ranges
  @system_reserved_internal_ipv6_ranges
end

#utilization_details ⇒ Google::Apis::ComputeAlpha::SubnetworkUtilizationDetails

The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. Corresponds to the JSON property utilizationDetails

Returns:



74813
74814
74815
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74813

def utilization_details
  @utilization_details
end

#vlans ⇒ Array<Fixnum>

A repeated field indicating the VLAN IDs supported on this subnetwork. During Subnet creation, specifying vlan is valid only if enable_l2 is true. During Subnet Update, specifying vlan is allowed only for l2 enabled subnets. Restricted to only one VLAN. Corresponds to the JSON property vlans

Returns:

  • (Array<Fixnum>) 


74821
74822
74823
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74821

def vlans
  @vlans
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



74828
74829
74830
74831
74832
74833
74834
74835
74836
74837
74838
74839
74840
74841
74842
74843
74844
74845
74846
74847
74848
74849
74850
74851
74852
74853
74854
74855
74856
74857
74858
74859
74860
74861
74862
74863
74864
74865
74866
74867
74868
74869
74870
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 74828

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_l2 = args[:enable_l2] if args.key?(:enable_l2)
  @enable_private_v6_access = args[:enable_private_v6_access] if args.key?(:enable_private_v6_access)
  @external_ipv6_prefix = args[:external_ipv6_prefix] if args.key?(:external_ipv6_prefix)
  @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)
  @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)
  @ip_collection = args[:ip_collection] if args.key?(:ip_collection)
  @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)
  @ipv6_gce_endpoint = args[:ipv6_gce_endpoint] if args.key?(:ipv6_gce_endpoint)
  @ipv6_network_tier = args[:ipv6_network_tier] if args.key?(:ipv6_network_tier)
  @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)
  @params = args[:params] if args.key?(:params)
  @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)
  @reserved_internal_range = args[:reserved_internal_range] if args.key?(:reserved_internal_range)
  @resolve_subnet_mask = args[:resolve_subnet_mask] if args.key?(:resolve_subnet_mask)
  @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)
  @stack_type = args[:stack_type] if args.key?(:stack_type)
  @state = args[:state] if args.key?(:state)
  @system_reserved_external_ipv6_ranges = args[:system_reserved_external_ipv6_ranges] if args.key?(:system_reserved_external_ipv6_ranges)
  @system_reserved_internal_ipv6_ranges = args[:system_reserved_internal_ipv6_ranges] if args.key?(:system_reserved_internal_ipv6_ranges)
  @utilization_details = args[:utilization_details] if args.key?(:utilization_details)
  @vlans = args[:vlans] if args.key?(:vlans)
end