Class: Google::Apis::ComputeAlpha::Interconnect

Inherits:
Object
  • Object
show all
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 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.



21534
21535
21536
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21534

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

Instance Attribute Details

#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) 


21318
21319
21320
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21318

def admin_enabled
  @admin_enabled
end

#available_features ⇒ Array<String>

[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the interconnect was created on MACsec capable hardware ports. If not present then the interconnect is provisioned on non-MACsec capable ports and MACsec enablement will fail. Corresponds to the JSON property availableFeatures

Returns:

  • (Array<String>) 


21328
21329
21330
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21328

def available_features
  @available_features
end

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

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

Returns:



21334
21335
21336
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21334

def circuit_infos
  @circuit_infos
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


21339
21340
21341
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21339

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) 


21345
21346
21347
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21345

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) 


21351
21352
21353
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21351

def description
  @description
end

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

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

Returns:



21356
21357
21358
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21356

def expected_outages
  @expected_outages
end

#google_ip_address ⇒ String

[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) 


21362
21363
21364
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21362

def google_ip_address
  @google_ip_address
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. Corresponds to the JSON property googleReferenceId

Returns:

  • (String) 


21368
21369
21370
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21368

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

Returns:

  • (Fixnum) 


21374
21375
21376
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21374

def id
  @id
end

#interconnect_attachments ⇒ Array<String>

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

Returns:

  • (Array<String>) 


21380
21381
21382
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21380

def interconnect_attachments
  @interconnect_attachments
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) 


21388
21389
21390
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21388

def interconnect_type
  @interconnect_type
end

#kind ⇒ String

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

Returns:

  • (String) 


21394
21395
21396
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21394

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 error 412 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) 


21406
21407
21408
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21406

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

Returns:

  • (Hash<String,String>) 


21413
21414
21415
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21413

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. 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) 


21422
21423
21424
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21422

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) 


21428
21429
21430
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21428

def location
  @location
end

#macsec ⇒ Google::Apis::ComputeAlpha::InterconnectMacsec

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

Returns:



21434
21435
21436
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21434

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) 


21440
21441
21442
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21440

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 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

Returns:

  • (String) 


21451
21452
21453
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21451

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) 


21460
21461
21462
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21460

def noc_contact_email
  @noc_contact_email
end

#operational_status ⇒ String

[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) 


21471
21472
21473
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21471

def operational_status
  @operational_status
end

#peer_ip_address ⇒ String

[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) 


21478
21479
21480
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21478

def peer_ip_address
  @peer_ip_address
end

#provisioned_link_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


21483
21484
21485
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21483

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) 


21489
21490
21491
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21489

def remote_location
  @remote_location
end

#requested_features ⇒ Array<String>

Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the interconnect will be created on MACsec capable hardware ports. If not specified, the default value is false, which will allocate non-MACsec capable ports first if available. This parameter can only be provided during interconnect INSERT and cannot be changed using interconnect PATCH. Corresponds to the JSON property requestedFeatures

Returns:

  • (Array<String>) 


21499
21500
21501
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21499

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) 


21505
21506
21507
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21505

def requested_link_count
  @requested_link_count
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


21510
21511
21512
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21510

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

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

Returns:

  • (String) 


21516
21517
21518
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21516

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

Returns:

  • (String) 


21521
21522
21523
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21521

def self_link_with_id
  @self_link_with_id
end

#state ⇒ String

[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) 


21532
21533
21534
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21532

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21539
21540
21541
21542
21543
21544
21545
21546
21547
21548
21549
21550
21551
21552
21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
21564
21565
21566
21567
21568
21569
21570
21571
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 21539

def update!(**args)
  @admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled)
  @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)
  @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_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)
  @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)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @state = args[:state] if args.key?(:state)
end