Class: Google::Apis::ComputeAlpha::Subnetwork
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Subnetwork
- 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. (==
resource_for $api_version
.subnetworks ==)
Instance Attribute Summary collapse
-
#aggregation_interval ⇒ String
Can only be specified if VPC flow logging for this subnetwork is enabled.
-
#allow_subnet_cidr_routes_overlap ⇒ Boolean
(also: #allow_subnet_cidr_routes_overlap?)
Whether this subnetwork can conflict with static routes.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#enable_flow_logs ⇒ Boolean
(also: #enable_flow_logs?)
Whether to enable flow logging for this subnetwork.
-
#enable_l2 ⇒ Boolean
(also: #enable_l2?)
Enables Layer2 communication on the subnetwork.
-
#enable_private_v6_access ⇒ Boolean
(also: #enable_private_v6_access?)
Deprecated in favor of enable in PrivateIpv6GoogleAccess.
-
#external_ipv6_prefix ⇒ String
[Output Only] The range of external IPv6 addresses that are owned by this subnetwork.
-
#fingerprint ⇒ String
Fingerprint of this resource.
-
#flow_sampling ⇒ Float
Can only be specified if VPC flow logging for this subnetwork is enabled.
-
#gateway_address ⇒ String
[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#ip_cidr_range ⇒ String
The range of internal addresses that are owned by this subnetwork.
-
#ipv6_access_type ⇒ String
The access type of IPv6 address this subnet holds.
-
#ipv6_cidr_range ⇒ String
[Output Only] The range of internal IPv6 addresses that are owned by this subnetwork.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#log_config ⇒ Google::Apis::ComputeAlpha::SubnetworkLogConfig
The available logging options for this subnetwork.
-
#metadata ⇒ String
Can only be specified if VPC flow logging for this subnetwork is enabled.
-
#name ⇒ String
The name of the resource, provided by the client when initially creating the resource.
-
#network ⇒ String
The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork.
-
#private_ip_google_access ⇒ Boolean
(also: #private_ip_google_access?)
Whether the VMs in this subnet can access Google services without assigned external IP addresses.
-
#private_ipv6_google_access ⇒ String
The private IPv6 google access type for the VMs in this subnet.
-
#private_ipv6_google_access_service_accounts ⇒ Array<String>
Deprecated in favor of enable PrivateIpv6GoogleAccess on instance directly.
-
#purpose ⇒ String
The purpose of the resource.
-
#region ⇒ String
URL of the region where the Subnetwork resides.
-
#role ⇒ String
The role of subnetwork.
-
#secondary_ip_ranges ⇒ Array<Google::Apis::ComputeAlpha::SubnetworkSecondaryRange>
An array of configurations for secondary IP ranges for VM instances contained in this subnetwork.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#stack_type ⇒ String
The stack type for this subnet to identify whether the IPv6 feature is enabled or not.
-
#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.
-
#vlans ⇒ Array<Fixnum>
A repeated field indicating the VLAN IDs supported on this subnetwork.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Subnetwork
constructor
A new instance of Subnetwork.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Subnetwork
Returns a new instance of Subnetwork.
38169 38170 38171 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38169 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
37921 37922 37923 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 37921 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
37936 37937 37938 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 37936 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
37942 37943 37944 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 37942 def @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
37948 37949 37950 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 37948 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. This field isn't supported with the
purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.
Corresponds to the JSON property enableFlowLogs
37956 37957 37958 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 37956 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
37962 37963 37964 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 37962 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
37970 37971 37972 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 37970 def enable_private_v6_access @enable_private_v6_access end |
#external_ipv6_prefix ⇒ String
[Output Only] The range of external IPv6 addresses that are owned by this
subnetwork.
Corresponds to the JSON property externalIpv6Prefix
37977 37978 37979 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 37977 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.
37988 37989 37990 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 37988 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
37997 37998 37999 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 37997 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
38003 38004 38005 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38003 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
38009 38010 38011 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38009 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 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
38019 38020 38021 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38019 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. If the ipv6_type is EXTERNAL then this subnet cannot
enable direct path.
Corresponds to the JSON property ipv6AccessType
38027 38028 38029 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38027 def ipv6_access_type @ipv6_access_type 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
38033 38034 38035 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38033 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
38039 38040 38041 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38039 def kind @kind end |
#log_config ⇒ Google::Apis::ComputeAlpha::SubnetworkLogConfig
The available logging options for this subnetwork.
Corresponds to the JSON property logConfig
38044 38045 38046 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38044 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 INCLUDE_ALL_METADATA.
Corresponds to the JSON property metadata
38052 38053 38054 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38052 def @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
38062 38063 38064 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38062 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
38070 38071 38072 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38070 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
38077 38078 38079 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38077 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
38086 38087 38088 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38086 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
38096 38097 38098 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38096 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. The enableFlowLogs field isn't supported with the purpose
field set to INTERNAL_HTTPS_LOAD_BALANCER.
Corresponds to the JSON property purpose
38106 38107 38108 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38106 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
38112 38113 38114 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38112 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
38122 38123 38124 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38122 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
38130 38131 38132 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38130 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
38135 38136 38137 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38135 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
38140 38141 38142 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38140 def self_link_with_id @self_link_with_id end |
#stack_type ⇒ String
The stack type for this subnet to identify whether the IPv6 feature is enabled
or not. If not specified IPV4_ONLY will be used.
This field can be both set at resource creation time and updated using patch.
Corresponds to the JSON property stackType
38147 38148 38149 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38147 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 CREATING: Subnetwork is
provisioning DELETING: Subnetwork is being deleted UPDATING: Subnetwork is
being updated
Corresponds to the JSON property state
38159 38160 38161 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38159 def state @state 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
38167 38168 38169 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38167 def vlans @vlans end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
38174 38175 38176 38177 38178 38179 38180 38181 38182 38183 38184 38185 38186 38187 38188 38189 38190 38191 38192 38193 38194 38195 38196 38197 38198 38199 38200 38201 38202 38203 38204 38205 38206 38207 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 38174 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) @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) @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) @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) @stack_type = args[:stack_type] if args.key?(:stack_type) @state = args[:state] if args.key?(:state) @vlans = args[:vlans] if args.key?(:vlans) end |