Class: Google::Apis::ComputeAlpha::InterconnectAttachment
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::InterconnectAttachment
- 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 an Interconnect Attachment (VLAN) resource.
You can use Interconnect attachments (VLANS) to connect your Virtual Private
Cloud networks to your on-premises networks through an Interconnect. For more
information, read Creating VLAN Attachments. (== resource_for $api_version
.
interconnectAttachments ==)
Instance Attribute Summary collapse
-
#admin_enabled ⇒ Boolean
(also: #admin_enabled?)
Determines whether this Attachment will carry packets.
-
#bandwidth ⇒ String
Provisioned bandwidth capacity for the interconnect attachment.
-
#candidate_subnets ⇒ Array<String>
Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment.
-
#cloud_router_ip_address ⇒ String
[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#customer_router_ip_address ⇒ String
[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
-
#dataplane_version ⇒ Fixnum
[Output Only] Dataplane version for this InterconnectAttachment.
-
#description ⇒ String
An optional description of this resource.
-
#edge_availability_domain ⇒ String
Desired availability domain for the attachment.
-
#encryption ⇒ String
Indicates the user-supplied encryption option of this interconnect attachment: - NONE is the default value, which means that the attachment carries unencrypted traffic.
-
#google_reference_id ⇒ String
[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#interconnect ⇒ String
URL of the underlying Interconnect object that this attachment's traffic will traverse through.
-
#ipsec_internal_addresses ⇒ Array<String>
URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#label_fingerprint ⇒ String
A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking.
-
#labels ⇒ Hash<String,String>
Labels for this resource.
-
#mtu ⇒ Fixnum
Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment.
-
#name ⇒ String
Name of the resource.
-
#operational_status ⇒ String
[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use.
-
#pairing_key ⇒ String
[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED].
-
#partner_asn ⇒ Fixnum
Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer.
-
#partner_metadata ⇒ Google::Apis::ComputeAlpha::InterconnectAttachmentPartnerMetadata
Informational metadata about Partner attachments from Partners to display to customers.
-
#private_interconnect_info ⇒ Google::Apis::ComputeAlpha::InterconnectAttachmentPrivateInfo
Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.
-
#region ⇒ String
[Output Only] URL of the region where the regional interconnect attachment resides.
-
#router ⇒ String
URL of the Cloud Router to be used for dynamic routing.
-
#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.
-
#state ⇒ String
[Output Only] The current state of this attachment's functionality.
-
#type ⇒ String
The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect.
-
#vlan_tag8021q ⇒ Fixnum
The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094.
Instance Method Summary collapse
-
#initialize(**args) ⇒ InterconnectAttachment
constructor
A new instance of InterconnectAttachment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ InterconnectAttachment
Returns a new instance of InterconnectAttachment.
18477 18478 18479 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18477 def initialize(**args) update!(**args) end |
Instance Attribute Details
#admin_enabled ⇒ Boolean Also known as: admin_enabled?
Determines whether this Attachment will carry packets. Not present for
PARTNER_PROVIDER.
Corresponds to the JSON property adminEnabled
18211 18212 18213 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18211 def admin_enabled @admin_enabled end |
#bandwidth ⇒ String
Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
- BPS_50M: 50 Mbit/s
- BPS_100M: 100 Mbit/s
- BPS_200M: 200 Mbit/s
- BPS_300M: 300 Mbit/s
- BPS_400M: 400 Mbit/s
- BPS_500M: 500 Mbit/s
- BPS_1G: 1 Gbit/s
- BPS_2G: 2 Gbit/s
- BPS_5G: 5 Gbit/s
- BPS_10G: 10 Gbit/s
- BPS_20G: 20 Gbit/s
- BPS_50G: 50 Gbit/s
Corresponds to the JSON property
bandwidth
18233 18234 18235 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18233 def bandwidth @bandwidth end |
#candidate_subnets ⇒ Array<String>
Up to 16 candidate prefixes that can be used to restrict the allocation of
cloudRouterIpAddress and customerRouterIpAddress for this attachment. All
prefixes must be within link-local address space (169.254.0.0/16) and must be /
29 or shorter (/28, /27, etc). Google will attempt to select an unused /29
from the supplied candidate prefix(es). The request will fail if all possible /
29s are in use on Google's edge. If not supplied, Google will randomly select
an unused /29 from all of link-local space.
Corresponds to the JSON property candidateSubnets
18244 18245 18246 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18244 def candidate_subnets @candidate_subnets end |
#cloud_router_ip_address ⇒ String
[Output Only] IPv4 address + prefix length to be configured on Cloud Router
Interface for this interconnect attachment.
Corresponds to the JSON property cloudRouterIpAddress
18250 18251 18252 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18250 def cloud_router_ip_address @cloud_router_ip_address end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
18255 18256 18257 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18255 def @creation_timestamp end |
#customer_router_ip_address ⇒ String
[Output Only] IPv4 address + prefix length to be configured on the customer
router subinterface for this interconnect attachment.
Corresponds to the JSON property customerRouterIpAddress
18261 18262 18263 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18261 def customer_router_ip_address @customer_router_ip_address end |
#dataplane_version ⇒ Fixnum
[Output Only] Dataplane version for this InterconnectAttachment.
Corresponds to the JSON property dataplaneVersion
18266 18267 18268 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18266 def dataplane_version @dataplane_version end |
#description ⇒ String
An optional description of this resource.
Corresponds to the JSON property description
18271 18272 18273 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18271 def description @description end |
#edge_availability_domain ⇒ String
Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
- AVAILABILITY_DOMAIN_ANY
- AVAILABILITY_DOMAIN_1
- AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a
pair of attachments, one per availability domain. The selected availability
domain will be provided to the Partner via the pairing key, so that the
provisioned circuit will lie in the specified domain. If not specified, the
value will default to AVAILABILITY_DOMAIN_ANY.
Corresponds to the JSON property
edgeAvailabilityDomain
18284 18285 18286 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18284 def edge_availability_domain @edge_availability_domain end |
#encryption ⇒ String
Indicates the user-supplied encryption option of this interconnect attachment:
- NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.
- IPSEC indicates that the attachment carries only traffic encrypted by an
IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to,
or receive traffic from, such an attachment. To use IPsec-encrypted Cloud
Interconnect, create the attachment using this option.
Corresponds to the JSON property
encryption
18296 18297 18298 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18296 def encryption @encryption end |
#google_reference_id ⇒ String
[Output Only] Google reference ID, to be used when raising support tickets
with Google or otherwise to debug backend connectivity issues. [Deprecated]
This field is not used.
Corresponds to the JSON property googleReferenceId
18303 18304 18305 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18303 def google_reference_id @google_reference_id end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
18309 18310 18311 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18309 def id @id end |
#interconnect ⇒ String
URL of the underlying Interconnect object that this attachment's traffic will
traverse through.
Corresponds to the JSON property interconnect
18315 18316 18317 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18315 def interconnect @interconnect end |
#ipsec_internal_addresses ⇒ Array<String>
URL of addresses that have been reserved for the interconnect attachment, Used
only for interconnect attachment that has the encryption option as IPSEC. The
addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway
over the interconnect attachment, if the attachment is configured to use an
RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from
the IP address range specified here. For example, if the HA VPN gateway?s
interface 0 is paired to this interconnect attachment, then an RFC 1918 IP
address for the VPN gateway interface 0 will be allocated from the IP address
specified for this interconnect attachment. If this field is not specified for
interconnect attachment that has encryption option as IPSEC, later on when
creating HA VPN gateway on this interconnect attachment, the HA VPN gateway's
IP address will be allocated from regional external IP address pool.
Corresponds to the JSON property ipsecInternalAddresses
18331 18332 18333 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18331 def ipsec_internal_addresses @ipsec_internal_addresses end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#interconnectAttachment for
interconnect attachments.
Corresponds to the JSON property kind
18337 18338 18339 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18337 def kind @kind end |
#label_fingerprint ⇒ String
A fingerprint for the labels being applied to this InterconnectAttachment,
which is essentially a hash of the labels set used for optimistic locking. The
fingerprint is initially generated by Compute Engine and changes after every
request to modify or update labels. You must always provide an up-to-date
fingerprint hash in order to update or change labels, otherwise the request
will fail with error 412 conditionNotMet.
To see the latest fingerprint, make a get() request to retrieve an
InterconnectAttachment.
Corresponds to the JSON property labelFingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
18350 18351 18352 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18350 def label_fingerprint @label_fingerprint end |
#labels ⇒ Hash<String,String>
Labels for this resource. These can only be added or modified by the setLabels
method. Each label key/value pair must comply with RFC1035. Label values may
be empty.
Corresponds to the JSON property labels
18357 18358 18359 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18357 def labels @labels end |
#mtu ⇒ Fixnum
Maximum Transmission Unit (MTU), in bytes, of packets passing through this
interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the
value will default to 1440.
Corresponds to the JSON property mtu
18364 18365 18366 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18364 def mtu @mtu end |
#name ⇒ String
Name of the resource. Provided by the client when the resource is created. 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
18374 18375 18376 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18374 def name @name end |
#operational_status ⇒ String
[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
- OS_ACTIVE: The attachment has been turned up and is ready to use.
- OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is
not complete.
Corresponds to the JSON property
operationalStatus
18383 18384 18385 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18383 def operational_status @operational_status end |
#pairing_key ⇒ String
[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present
for DEDICATED]. The opaque identifier of an PARTNER attachment used to
initiate provisioning with a selected partner. Of the form "XXXXX/region/
domain"
Corresponds to the JSON property pairingKey
18391 18392 18393 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18391 def pairing_key @pairing_key end |
#partner_asn ⇒ Fixnum
Optional BGP ASN for the router supplied by a Layer 3 Partner if they
configured BGP on behalf of the customer. Output only for PARTNER type, input
only for PARTNER_PROVIDER, not available for DEDICATED.
Corresponds to the JSON property partnerAsn
18398 18399 18400 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18398 def partner_asn @partner_asn end |
#partner_metadata ⇒ Google::Apis::ComputeAlpha::InterconnectAttachmentPartnerMetadata
Informational metadata about Partner attachments from Partners to display to
customers. These fields are propagated from PARTNER_PROVIDER attachments to
their corresponding PARTNER attachments.
Corresponds to the JSON property partnerMetadata
18405 18406 18407 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18405 def @partner_metadata end |
#private_interconnect_info ⇒ Google::Apis::ComputeAlpha::InterconnectAttachmentPrivateInfo
Information for an interconnect attachment when this belongs to an
interconnect of type DEDICATED.
Corresponds to the JSON property privateInterconnectInfo
18411 18412 18413 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18411 def private_interconnect_info @private_interconnect_info end |
#region ⇒ String
[Output Only] URL of the region where the regional interconnect attachment
resides. You must specify this field as part of the HTTP request URL. It is
not settable as a field in the request body.
Corresponds to the JSON property region
18418 18419 18420 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18418 def region @region end |
#router ⇒ String
URL of the Cloud Router to be used for dynamic routing. This router must be in
the same region as this InterconnectAttachment. The InterconnectAttachment
will automatically connect the Interconnect to the network & region within
which the Cloud Router is configured.
Corresponds to the JSON property router
18426 18427 18428 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18426 def router @router end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
18431 18432 18433 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18431 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
18436 18437 18438 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18436 def self_link_with_id @self_link_with_id end |
#state ⇒ String
[Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
- ACTIVE: The attachment has been turned up and is ready to use.
- UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
- PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
- PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
- PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
- DEFUNCT: The attachment was deleted externally and is no longer functional.
This could be because the associated Interconnect was removed, or because the
other side of a Partner attachment was deleted.
Corresponds to the JSON property
state
18459 18460 18461 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18459 def state @state end |
#type ⇒ String
The type of interconnect attachment this is, which can take one of the following values:
- DEDICATED: an attachment to a Dedicated Interconnect.
- PARTNER: an attachment to a Partner Interconnect, created by the customer.
- PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the
partner.
Corresponds to the JSON property
type
18469 18470 18471 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18469 def type @type end |
#vlan_tag8021q ⇒ Fixnum
The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only
specified at creation time.
Corresponds to the JSON property vlanTag8021q
18475 18476 18477 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18475 def vlan_tag8021q @vlan_tag8021q end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
18482 18483 18484 18485 18486 18487 18488 18489 18490 18491 18492 18493 18494 18495 18496 18497 18498 18499 18500 18501 18502 18503 18504 18505 18506 18507 18508 18509 18510 18511 18512 18513 18514 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 18482 def update!(**args) @admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled) @bandwidth = args[:bandwidth] if args.key?(:bandwidth) @candidate_subnets = args[:candidate_subnets] if args.key?(:candidate_subnets) @cloud_router_ip_address = args[:cloud_router_ip_address] if args.key?(:cloud_router_ip_address) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @customer_router_ip_address = args[:customer_router_ip_address] if args.key?(:customer_router_ip_address) @dataplane_version = args[:dataplane_version] if args.key?(:dataplane_version) @description = args[:description] if args.key?(:description) @edge_availability_domain = args[:edge_availability_domain] if args.key?(:edge_availability_domain) @encryption = args[:encryption] if args.key?(:encryption) @google_reference_id = args[:google_reference_id] if args.key?(:google_reference_id) @id = args[:id] if args.key?(:id) @interconnect = args[:interconnect] if args.key?(:interconnect) @ipsec_internal_addresses = args[:ipsec_internal_addresses] if args.key?(:ipsec_internal_addresses) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @mtu = args[:mtu] if args.key?(:mtu) @name = args[:name] if args.key?(:name) @operational_status = args[:operational_status] if args.key?(:operational_status) @pairing_key = args[:pairing_key] if args.key?(:pairing_key) @partner_asn = args[:partner_asn] if args.key?(:partner_asn) @partner_metadata = args[:partner_metadata] if args.key?(:partner_metadata) @private_interconnect_info = args[:private_interconnect_info] if args.key?(:private_interconnect_info) @region = args[:region] if args.key?(:region) @router = args[:router] if args.key?(:router) @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) @type = args[:type] if args.key?(:type) @vlan_tag8021q = args[:vlan_tag8021q] if args.key?(:vlan_tag8021q) end |