Class: Google::Apis::ComputeV1::Interconnect

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/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. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Interconnect

Returns a new instance of Interconnect



10708
10709
10710
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10708

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) 


10558
10559
10560
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10558

def admin_enabled
  @admin_enabled
end

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

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

Returns:



10565
10566
10567
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10565

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) 


10570
10571
10572
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10570

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) 


10576
10577
10578
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10576

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) 


10582
10583
10584
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10582

def description
  @description
end

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

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

Returns:



10587
10588
10589
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10587

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) 


10593
10594
10595
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10593

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) 


10599
10600
10601
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10599

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) 


10605
10606
10607
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10605

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


10611
10612
10613
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10611

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) 


10620
10621
10622
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10620

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) 


10626
10627
10628
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10626

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


10635
10636
10637
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10635

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) 


10641
10642
10643
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10641

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


10651
10652
10653
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10651

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) 


10659
10660
10661
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10659

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) 


10671
10672
10673
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10671

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) 


10678
10679
10680
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10678

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) 


10683
10684
10685
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10683

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


10689
10690
10691
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10689

def requested_link_count
  @requested_link_count
end

#self_link ⇒ String

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

Returns:

  • (String) 


10694
10695
10696
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10694

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


10706
10707
10708
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10706

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
 
# File 'generated/google/apis/compute_v1/classes.rb', line 10713

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)
  @link_type = args[:link_type] if args.key?(:link_type)
  @location = args[:location] if args.key?(:location)
  @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)
  @requested_link_count = args[:requested_link_count] if args.key?(:requested_link_count)
  @self_link = args[:self_link] if args.key?(:self_link)
  @state = args[:state] if args.key?(:state)
end