Class: Google::Apis::ComputeBeta::Subnetwork
- Inherits:
-
Object
- Object
- Google::Apis::ComputeBeta::Subnetwork
- 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 $api_version
.subnetworks ==)
Instance Attribute Summary collapse
-
#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.
-
#fingerprint ⇒ String
Fingerprint of this resource.
-
#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_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::ComputeBeta::SubnetworkLogConfig
The available logging options for this subnetwork.
-
#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::ComputeBeta::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.
-
#state ⇒ String
[Output Only] The state of the subnetwork, which can be one of READY or DRAINING.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Subnetwork
constructor
A new instance of Subnetwork.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Subnetwork
Returns a new instance of Subnetwork.
29155 29156 29157 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29155 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
28993 28994 28995 |
# File 'generated/google/apis/compute_beta/classes.rb', line 28993 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
28999 29000 29001 |
# File 'generated/google/apis/compute_beta/classes.rb', line 28999 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
29005 29006 29007 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29005 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
29012 29013 29014 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29012 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.
29024 29025 29026 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29024 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
29030 29031 29032 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29030 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
29036 29037 29038 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29036 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
29044 29045 29046 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29044 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
29050 29051 29052 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29050 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
29056 29057 29058 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29056 def kind @kind end |
#log_config ⇒ Google::Apis::ComputeBeta::SubnetworkLogConfig
The available logging options for this subnetwork.
Corresponds to the JSON property logConfig
29061 29062 29063 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29061 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
29071 29072 29073 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29071 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
29079 29080 29081 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29079 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
29086 29087 29088 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29086 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
29095 29096 29097 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29095 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
29105 29106 29107 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29105 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
29114 29115 29116 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29114 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
29120 29121 29122 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29120 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
29130 29131 29132 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29130 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
29138 29139 29140 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29138 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
29143 29144 29145 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29143 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
29153 29154 29155 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29153 def state @state end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
29160 29161 29162 29163 29164 29165 29166 29167 29168 29169 29170 29171 29172 29173 29174 29175 29176 29177 29178 29179 29180 29181 29182 29183 |
# File 'generated/google/apis/compute_beta/classes.rb', line 29160 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) @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) @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) @state = args[:state] if args.key?(:state) end |