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. (== resource_for $api_version.interconnects ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Interconnect

Returns a new instance of Interconnect.



18761
18762
18763
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18761

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) 


18578
18579
18580
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18578

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:



18585
18586
18587
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18585

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) 


18590
18591
18592
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18590

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) 


18596
18597
18598
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18596

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) 


18602
18603
18604
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18602

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:



18607
18608
18609
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18607

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) 


18613
18614
18615
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18613

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) 


18619
18620
18621
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18619

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) 


18625
18626
18627
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18625

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


18631
18632
18633
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18631

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) 


18640
18641
18642
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18640

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) 


18646
18647
18648
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18646

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) 


18659
18660
18661
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18659

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


18666
18667
18668
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18666

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) 


18675
18676
18677
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18675

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) 


18681
18682
18683
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18681

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) 


18691
18692
18693
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18691

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) 


18699
18700
18701
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18699

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) 


18711
18712
18713
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18711

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) 


18718
18719
18720
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18718

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) 


18723
18724
18725
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18723

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) 


18729
18730
18731
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18729

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) 


18736
18737
18738
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18736

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) 


18742
18743
18744
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18742

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) 


18747
18748
18749
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18747

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) 


18759
18760
18761
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18759

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18766
18767
18768
18769
18770
18771
18772
18773
18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
18789
18790
18791
18792
18793
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18766

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