Class: Google::Apis::ComputeAlpha::InterconnectAttachment
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::InterconnectAttachment
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/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.
-
#description ⇒ String
An optional description of this resource.
-
#edge_availability_domain ⇒ String
Desired availability domain for the attachment.
-
#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.
-
#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 to apply to this InterconnectAttachment 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.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ InterconnectAttachment
Returns a new instance of InterconnectAttachment.
15440 15441 15442 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15440 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
15207 15208 15209 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15207 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
15229 15230 15231 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15229 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
15240 15241 15242 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15240 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
15246 15247 15248 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15246 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
15251 15252 15253 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15251 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
15257 15258 15259 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15257 def customer_router_ip_address @customer_router_ip_address end |
#description ⇒ String
An optional description of this resource.
Corresponds to the JSON property description
15262 15263 15264 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15262 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
15275 15276 15277 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15275 def edge_availability_domain @edge_availability_domain 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
15282 15283 15284 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15282 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
15288 15289 15290 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15288 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
15294 15295 15296 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15294 def interconnect @interconnect end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#interconnectAttachment for
interconnect attachments.
Corresponds to the JSON property kind
15300 15301 15302 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15300 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.
15313 15314 15315 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15313 def label_fingerprint @label_fingerprint end |
#labels ⇒ Hash<String,String>
Labels to apply to this InterconnectAttachment resource. These can be later
modified by the setLabels method. Each label key/value must comply with
RFC1035. Label values may be empty.
Corresponds to the JSON property labels
15320 15321 15322 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15320 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
15327 15328 15329 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15327 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
15337 15338 15339 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15337 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
15346 15347 15348 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15346 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
15354 15355 15356 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15354 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
15361 15362 15363 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15361 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
15368 15369 15370 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15368 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
15374 15375 15376 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15374 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
15381 15382 15383 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15381 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
15389 15390 15391 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15389 def router @router end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
15394 15395 15396 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15394 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
15399 15400 15401 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15399 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
15422 15423 15424 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15422 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
15432 15433 15434 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15432 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
15438 15439 15440 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15438 def vlan_tag8021q @vlan_tag8021q end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
15445 15446 15447 15448 15449 15450 15451 15452 15453 15454 15455 15456 15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471 15472 15473 15474 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15445 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) @description = args[:description] if args.key?(:description) @edge_availability_domain = args[:edge_availability_domain] if args.key?(:edge_availability_domain) @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) @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 |