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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Interconnect

Returns a new instance of Interconnect.



15812
15813
15814
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15812

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) 


15657
15658
15659
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15657

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:



15664
15665
15666
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15664

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) 


15669
15670
15671
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15669

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) 


15675
15676
15677
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15675

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) 


15681
15682
15683
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15681

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:



15686
15687
15688
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15686

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) 


15692
15693
15694
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15692

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) 


15698
15699
15700
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15698

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) 


15704
15705
15706
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15704

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


15710
15711
15712
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15710

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) 


15718
15719
15720
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15718

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) 


15724
15725
15726
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15724

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) 


15733
15734
15735
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15733

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) 


15739
15740
15741
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15739

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) 


15749
15750
15751
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15749

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) 


15757
15758
15759
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15757

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) 


15768
15769
15770
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15768

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) 


15775
15776
15777
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15775

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) 


15780
15781
15782
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15780

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) 


15786
15787
15788
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15786

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) 


15793
15794
15795
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15793

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) 


15799
15800
15801
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15799

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) 


15810
15811
15812
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15810

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15817

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