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.
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's ranges can conflict with existing 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 external IPv6 address range that is assigned to 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.
-
#internal_ipv6_prefix ⇒ String
[Output Only] The internal IPv6 address range that is assigned to this subnetwork.
-
#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] This field is for internal use.
-
#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
This field is for internal use.
-
#purpose ⇒ String
The purpose of the resource.
-
#region ⇒ String
URL of the region where the Subnetwork resides.
-
#reserved_internal_range ⇒ String
The URL of the reserved internal range.
-
#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 the subnet.
-
#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.
41622 41623 41624 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41622 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
41376 41377 41378 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41376 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 static routes.
Setting this to true allows this subnetwork's primary and secondary ranges to
overlap with (and contain) static 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. This field cannot be set to
true at resource creation time.
Corresponds to the JSON property allowSubnetCidrRoutesOverlap
41393 41394 41395 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41393 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
41399 41400 41401 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41399 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
41405 41406 41407 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41405 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
41414 41415 41416 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41414 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
41420 41421 41422 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41420 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
41428 41429 41430 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41428 def enable_private_v6_access @enable_private_v6_access end |
#external_ipv6_prefix ⇒ String
[Output Only] The external IPv6 address range that is assigned to this
subnetwork.
Corresponds to the JSON property externalIpv6Prefix
41435 41436 41437 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41435 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.
41446 41447 41448 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41446 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 unless otherwise specified by the
org policy, which means half of all collected logs are reported.
Corresponds to the JSON property flowSampling
41455 41456 41457 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41455 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
41461 41462 41463 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41461 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
41467 41468 41469 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41467 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
41473 41474 41475 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41473 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
41483 41484 41485 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41483 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
41490 41491 41492 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41490 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
41495 41496 41497 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41495 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
41501 41502 41503 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41501 def kind @kind end |
#log_config ⇒ Google::Apis::ComputeAlpha::SubnetworkLogConfig
The available logging options for this subnetwork.
Corresponds to the JSON property logConfig
41506 41507 41508 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41506 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
41514 41515 41516 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41514 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
41524 41525 41526 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41524 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
41531 41532 41533 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41531 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
41538 41539 41540 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41538 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
41545 41546 41547 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41545 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
41555 41556 41557 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41555 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
41561 41562 41563 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41561 def region @region end |
#reserved_internal_range ⇒ String
The URL of the reserved internal range.
Corresponds to the JSON property reservedInternalRange
41566 41567 41568 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41566 def reserved_internal_range @reserved_internal_range 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
41576 41577 41578 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41576 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
41584 41585 41586 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41584 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
41589 41590 41591 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41589 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
41594 41595 41596 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41594 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 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
41602 41603 41604 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41602 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
41612 41613 41614 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41612 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
41620 41621 41622 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41620 def vlans @vlans end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
41627 41628 41629 41630 41631 41632 41633 41634 41635 41636 41637 41638 41639 41640 41641 41642 41643 41644 41645 41646 41647 41648 41649 41650 41651 41652 41653 41654 41655 41656 41657 41658 41659 41660 41661 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41627 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) @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) @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) @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 |