Class: Google::Apis::ComputeBeta::Interconnect

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/representations.rb

Overview

Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Interconnect

Returns a new instance of Interconnect.



30252
30253
30254
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30252

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aai_enabled ⇒ Boolean Also known as: aai_enabled?

Enable or disable the application awareness feature on this Cloud Interconnect. Corresponds to the JSON property aaiEnabled

Returns:

  • (Boolean) 


29958
29959
29960
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29958

def aai_enabled
  @aai_enabled
end

#admin_enabled ⇒ Boolean Also known as: admin_enabled?

Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. Corresponds to the JSON property adminEnabled

Returns:

  • (Boolean) 


29967
29968
29969
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29967

def admin_enabled
  @admin_enabled
end

#application_aware_interconnect ⇒ Google::Apis::ComputeBeta::InterconnectApplicationAwareInterconnect

Configuration information for application awareness on this Cloud Interconnect. Corresponds to the JSON property applicationAwareInterconnect

Returns:



29974
29975
29976
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29974

def application_aware_interconnect
  @application_aware_interconnect
end

#available_features ⇒ Array<String>

[Output only] List of features available for this Interconnect connection, which can take one of the following values:

  • IF_MACSEC: If present, then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present, then the Interconnect connection is provisioned on non-MACsec capable ports. Any attempt to enable MACsec will fail.
  • IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is provisioned exclusively for Cross-Site Networking. Any attempt to configure VLAN attachments will fail. If not present, then the Interconnect connection is not provisioned for Cross-Site Networking. Any attempt to use it for Cross-Site Networking will fail. Corresponds to the JSON property availableFeatures

Returns:

  • (Array<String>) 


29990
29991
29992
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29990

def available_features
  @available_features
end

#circuit_infos ⇒ Array<Google::Apis::ComputeBeta::InterconnectCircuitInfo>

Output only. [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. Corresponds to the JSON property circuitInfos

Returns:



29997
29998
29999
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29997

def circuit_infos
  @circuit_infos
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


30003
30004
30005
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30003

def creation_timestamp
  @creation_timestamp
end

#customer_name ⇒ String

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. Corresponds to the JSON property customerName

Returns:

  • (String) 


30009
30010
30011
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30009

def customer_name
  @customer_name
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


30015
30016
30017
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30015

def description
  @description
end

#effective_location ⇒ String

Output only. [Output Only] URL of the InterconnectLocation object that represents where this connection is to be provisioned. By default it will be the same as the location field. Corresponds to the JSON property effectiveLocation

Returns:

  • (String) 


30023
30024
30025
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30023

def effective_location
  @effective_location
end

#expected_outages ⇒ Array<Google::Apis::ComputeBeta::InterconnectOutageNotification>

Output only. [Output Only] A list of outages expected for this Interconnect. Corresponds to the JSON property expectedOutages

Returns:



30028
30029
30030
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30028

def expected_outages
  @expected_outages
end

#google_ip_address ⇒ String

Output only. [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. Corresponds to the JSON property googleIpAddress

Returns:

  • (String) 


30035
30036
30037
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30035

def google_ip_address
  @google_ip_address
end

#google_reference_id ⇒ String

Output only. [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. Corresponds to the JSON property googleReferenceId

Returns:

  • (String) 


30042
30043
30044
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30042

def google_reference_id
  @google_reference_id
end

#id ⇒ Fixnum

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


30049
30050
30051
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30049

def id
  @id
end

#interconnect_attachments ⇒ Array<String>

Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. Corresponds to the JSON property interconnectAttachments

Returns:

  • (Array<String>) 


30056
30057
30058
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30056

def interconnect_attachments
  @interconnect_attachments
end

#interconnect_groups ⇒ Array<String>

Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect. Order is arbitrary and items are unique. Corresponds to the JSON property interconnectGroups

Returns:

  • (Array<String>) 


30063
30064
30065
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30063

def interconnect_groups
  @interconnect_groups
end

#interconnect_type ⇒ String

Type of interconnect, which can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Corresponds to the JSON property interconnectType

Returns:

  • (String) 


30074
30075
30076
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30074

def interconnect_type
  @interconnect_type
end

#kind ⇒ String

Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects. Corresponds to the JSON property kind

Returns:

  • (String) 


30080
30081
30082
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30080

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for the labels being applied to this Interconnect, 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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


30093
30094
30095
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30093

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<String,String>

Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


30100
30101
30102
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30100

def labels
  @labels
end

#link_type ⇒ String

Type of link requested, which can take one of the following values:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. Corresponds to the JSON property linkType

Returns:

  • (String) 


30111
30112
30113
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30111

def link_type
  @link_type
end

#location ⇒ String

URL of the InterconnectLocation object that represents where this connection is to be provisioned. Corresponds to the JSON property location

Returns:

  • (String) 


30117
30118
30119
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30117

def location
  @location
end

#macsec ⇒ Google::Apis::ComputeBeta::InterconnectMacsec

Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router. Corresponds to the JSON property macsec

Returns:



30124
30125
30126
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30124

def macsec
  @macsec
end

#macsec_enabled ⇒ Boolean Also known as: macsec_enabled?

Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified. Corresponds to the JSON property macsecEnabled

Returns:

  • (Boolean) 


30130
30131
30132
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30130

def macsec_enabled
  @macsec_enabled
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 withRFC1035. 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

Returns:

  • (String) 


30142
30143
30144
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30142

def name
  @name
end

#noc_contact_email ⇒ String

Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation. Corresponds to the JSON property nocContactEmail

Returns:

  • (String) 


30152
30153
30154
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30152

def noc_contact_email
  @noc_contact_email
end

#operational_status ⇒ String

Output only. [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. Corresponds to the JSON property operationalStatus

Returns:

  • (String) 


30167
30168
30169
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30167

def operational_status
  @operational_status
end

#params ⇒ Google::Apis::ComputeBeta::InterconnectParams

Additional interconnect parameters. Corresponds to the JSON property params

Returns:



30172
30173
30174
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30172

def params
  @params
end

#peer_ip_address ⇒ String

Output only. [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. Corresponds to the JSON property peerIpAddress

Returns:

  • (String) 


30179
30180
30181
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30179

def peer_ip_address
  @peer_ip_address
end

#provisioned_link_count ⇒ Fixnum

Output only. [Output Only] Number of links actually provisioned in this interconnect. Corresponds to the JSON property provisionedLinkCount

Returns:

  • (Fixnum) 


30185
30186
30187
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30185

def provisioned_link_count
  @provisioned_link_count
end

#remote_location ⇒ String

Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. Corresponds to the JSON property remoteLocation

Returns:

  • (String) 


30191
30192
30193
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30191

def remote_location
  @remote_location
end

#requested_features ⇒ Array<String>

Optional. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. List of features requested for this Interconnect connection, which can take one of the following values:

  • IF_MACSEC: If specified, then the connection is created on MACsec capable hardware ports. If not specified, non-MACsec capable ports will also be considered.
  • IF_CROSS_SITE_NETWORK: If specified, then the connection is created exclusively for Cross-Site Networking. The connection can not be used for Cross-Site Networking unless this feature is specified. Corresponds to the JSON property requestedFeatures

Returns:

  • (Array<String>) 


30205
30206
30207
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30205

def requested_features
  @requested_features
end

#requested_link_count ⇒ Fixnum

Target number of physical links in the link bundle, as requested by the customer. Corresponds to the JSON property requestedLinkCount

Returns:

  • (Fixnum) 


30211
30212
30213
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30211

def requested_link_count
  @requested_link_count
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. [Output Only] Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


30216
30217
30218
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30216

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

Output only. [Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


30222
30223
30224
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30222

def self_link
  @self_link
end

#state ⇒ String

Output only. [Output Only] The current state of Interconnect functionality, which can take one of the following values:

  • ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
  • UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
  • UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. Corresponds to the JSON property state

Returns:

  • (String) 


30237
30238
30239
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30237

def state
  @state
end

#subzone ⇒ String

To be deprecated. Corresponds to the JSON property subzone

Returns:

  • (String) 


30242
30243
30244
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30242

def subzone
  @subzone
end

#wire_groups ⇒ Array<String>

Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty. Corresponds to the JSON property wireGroups

Returns:

  • (Array<String>) 


30250
30251
30252
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30250

def wire_groups
  @wire_groups
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30257
30258
30259
30260
30261
30262
30263
30264
30265
30266
30267
30268
30269
30270
30271
30272
30273
30274
30275
30276
30277
30278
30279
30280
30281
30282
30283
30284
30285
30286
30287
30288
30289
30290
30291
30292
30293
30294
30295
 
# File 'lib/google/apis/compute_beta/classes.rb', line 30257

def update!(**args)
  @aai_enabled = args[:aai_enabled] if args.key?(:aai_enabled)
  @admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled)
  @application_aware_interconnect = args[:application_aware_interconnect] if args.key?(:application_aware_interconnect)
  @available_features = args[:available_features] if args.key?(:available_features)
  @circuit_infos = args[:circuit_infos] if args.key?(:circuit_infos)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @customer_name = args[:customer_name] if args.key?(:customer_name)
  @description = args[:description] if args.key?(:description)
  @effective_location = args[:effective_location] if args.key?(:effective_location)
  @expected_outages = args[:expected_outages] if args.key?(:expected_outages)
  @google_ip_address = args[:google_ip_address] if args.key?(:google_ip_address)
  @google_reference_id = args[:google_reference_id] if args.key?(:google_reference_id)
  @id = args[:id] if args.key?(:id)
  @interconnect_attachments = args[:interconnect_attachments] if args.key?(:interconnect_attachments)
  @interconnect_groups = args[:interconnect_groups] if args.key?(:interconnect_groups)
  @interconnect_type = args[:interconnect_type] if args.key?(:interconnect_type)
  @kind = args[:kind] if args.key?(:kind)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @labels = args[:labels] if args.key?(:labels)
  @link_type = args[:link_type] if args.key?(:link_type)
  @location = args[:location] if args.key?(:location)
  @macsec = args[:macsec] if args.key?(:macsec)
  @macsec_enabled = args[:macsec_enabled] if args.key?(:macsec_enabled)
  @name = args[:name] if args.key?(:name)
  @noc_contact_email = args[:noc_contact_email] if args.key?(:noc_contact_email)
  @operational_status = args[:operational_status] if args.key?(:operational_status)
  @params = args[:params] if args.key?(:params)
  @peer_ip_address = args[:peer_ip_address] if args.key?(:peer_ip_address)
  @provisioned_link_count = args[:provisioned_link_count] if args.key?(:provisioned_link_count)
  @remote_location = args[:remote_location] if args.key?(:remote_location)
  @requested_features = args[:requested_features] if args.key?(:requested_features)
  @requested_link_count = args[:requested_link_count] if args.key?(:requested_link_count)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @self_link = args[:self_link] if args.key?(:self_link)
  @state = args[:state] if args.key?(:state)
  @subzone = args[:subzone] if args.key?(:subzone)
  @wire_groups = args[:wire_groups] if args.key?(:wire_groups)
end