Class: Google::Apis::ComputeBeta::InterconnectAttachment
- Inherits:
-
Object
- Object
- Google::Apis::ComputeBeta::InterconnectAttachment
- 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 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 beta. interconnectAttachments ==) (== resource_for v1.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.
-
#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::ComputeBeta::InterconnectAttachmentPartnerMetadata
Informational metadata about Partner attachments from Partners to display to customers.
-
#private_interconnect_info ⇒ Google::Apis::ComputeBeta::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.
-
#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
13173 13174 13175 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13173 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
12954 12955 12956 |
# File 'generated/google/apis/compute_beta/classes.rb', line 12954 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
Corresponds to the JSON property
bandwidth
12974 12975 12976 |
# File 'generated/google/apis/compute_beta/classes.rb', line 12974 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
12985 12986 12987 |
# File 'generated/google/apis/compute_beta/classes.rb', line 12985 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
12991 12992 12993 |
# File 'generated/google/apis/compute_beta/classes.rb', line 12991 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
12996 12997 12998 |
# File 'generated/google/apis/compute_beta/classes.rb', line 12996 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
13002 13003 13004 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13002 def customer_router_ip_address @customer_router_ip_address end |
#description ⇒ String
An optional description of this resource.
Corresponds to the JSON property description
13007 13008 13009 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13007 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
13020 13021 13022 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13020 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
13027 13028 13029 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13027 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
13033 13034 13035 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13033 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
13039 13040 13041 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13039 def interconnect @interconnect end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#interconnectAttachment for
interconnect attachments.
Corresponds to the JSON property kind
13045 13046 13047 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13045 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.
13058 13059 13060 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13058 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
13065 13066 13067 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13065 def labels @labels 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
13075 13076 13077 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13075 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
13084 13085 13086 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13084 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
13092 13093 13094 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13092 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
13099 13100 13101 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13099 def partner_asn @partner_asn end |
#partner_metadata ⇒ Google::Apis::ComputeBeta::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
13106 13107 13108 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13106 def @partner_metadata end |
#private_interconnect_info ⇒ Google::Apis::ComputeBeta::InterconnectAttachmentPrivateInfo
Information for an interconnect attachment when this belongs to an
interconnect of type DEDICATED.
Corresponds to the JSON property privateInterconnectInfo
13112 13113 13114 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13112 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
13119 13120 13121 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13119 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
13127 13128 13129 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13127 def router @router end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
13132 13133 13134 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13132 def self_link @self_link 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
13155 13156 13157 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13155 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
13165 13166 13167 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13165 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
13171 13172 13173 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13171 def vlan_tag8021q @vlan_tag8021q end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 |
# File 'generated/google/apis/compute_beta/classes.rb', line 13178 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) @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) @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 |