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



19618
19619
19620
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19618

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) 


19420
19421
19422
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19420

def admin_enabled
  @admin_enabled
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:



19427
19428
19429
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19427

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) 


19432
19433
19434
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19432

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) 


19438
19439
19440
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19438

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) 


19444
19445
19446
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19444

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:



19449
19450
19451
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19449

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) 


19455
19456
19457
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19455

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) 


19461
19462
19463
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19461

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) 


19467
19468
19469
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19467

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


19473
19474
19475
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19473

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) 


19481
19482
19483
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19481

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) 


19487
19488
19489
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19487

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) 


19499
19500
19501
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19499

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


19506
19507
19508
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19506

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) 


19515
19516
19517
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19515

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) 


19521
19522
19523
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19521

def location
  @location
end

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

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

Returns:



19527
19528
19529
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19527

def macsec
  @macsec
end

#macsec_enabled ⇒ Boolean Also known as: macsec_enabled?

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

Returns:

  • (Boolean) 


19533
19534
19535
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19533

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) 


19544
19545
19546
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19544

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 Stackdriver logs alerting and Cloud Notifications. Corresponds to the JSON property nocContactEmail

Returns:

  • (String) 


19552
19553
19554
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19552

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) 


19563
19564
19565
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19563

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) 


19570
19571
19572
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19570

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) 


19575
19576
19577
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19575

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) 


19581
19582
19583
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19581

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


19587
19588
19589
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19587

def requested_link_count
  @requested_link_count
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

[Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


19594
19595
19596
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19594

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) 


19600
19601
19602
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19600

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) 


19605
19606
19607
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19605

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) 


19616
19617
19618
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19616

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19623
19624
19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
19636
19637
19638
19639
19640
19641
19642
19643
19644
19645
19646
19647
19648
19649
19650
19651
19652
19653
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 19623

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