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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb

Overview

Represents an Interconnects resource. The Interconnects resource is a dedicated connection between Google's network and your on-premises network. For more information, see the Dedicated overview page. (== 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



11914
11915
11916
# File 'generated/google/apis/compute_alpha/classes.rb', line 11914

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

Instance Attribute Details

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


11762
11763
11764
# File 'generated/google/apis/compute_alpha/classes.rb', line 11762

def admin_enabled
  @admin_enabled
end

#circuit_infosArray<Google::Apis::ComputeAlpha::InterconnectCircuitInfo>

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



11769
11770
11771
# File 'generated/google/apis/compute_alpha/classes.rb', line 11769

def circuit_infos
  @circuit_infos
end

#creation_timestampString

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

Returns:

  • (String)


11774
11775
11776
# File 'generated/google/apis/compute_alpha/classes.rb', line 11774

def creation_timestamp
  @creation_timestamp
end

#customer_nameString

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)


11780
11781
11782
# File 'generated/google/apis/compute_alpha/classes.rb', line 11780

def customer_name
  @customer_name
end

#descriptionString

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)


11786
11787
11788
# File 'generated/google/apis/compute_alpha/classes.rb', line 11786

def description
  @description
end

#expected_outagesArray<Google::Apis::ComputeAlpha::InterconnectOutageNotification>

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



11791
11792
11793
# File 'generated/google/apis/compute_alpha/classes.rb', line 11791

def expected_outages
  @expected_outages
end

#google_ip_addressString

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


11797
11798
11799
# File 'generated/google/apis/compute_alpha/classes.rb', line 11797

def google_ip_address
  @google_ip_address
end

#google_reference_idString

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


11803
11804
11805
# File 'generated/google/apis/compute_alpha/classes.rb', line 11803

def google_reference_id
  @google_reference_id
end

#idFixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum)


11809
11810
11811
# File 'generated/google/apis/compute_alpha/classes.rb', line 11809

def id
  @id
end

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


11815
11816
11817
# File 'generated/google/apis/compute_alpha/classes.rb', line 11815

def interconnect_attachments
  @interconnect_attachments
end

#interconnect_typeString

Type of interconnect. Note that "IT_PRIVATE" has been deprecated in favor of " DEDICATED" Corresponds to the JSON property interconnectType

Returns:

  • (String)


11821
11822
11823
# File 'generated/google/apis/compute_alpha/classes.rb', line 11821

def interconnect_type
  @interconnect_type
end

#kindString

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

Returns:

  • (String)


11827
11828
11829
# File 'generated/google/apis/compute_alpha/classes.rb', line 11827

def kind
  @kind
end

#label_fingerprintString

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


11839
11840
11841
# File 'generated/google/apis/compute_alpha/classes.rb', line 11839

def label_fingerprint
  @label_fingerprint
end

#labelsHash<String,String>

Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)


11846
11847
11848
# File 'generated/google/apis/compute_alpha/classes.rb', line 11846

def labels
  @labels
end

Type of link requested. This field indicates speed of each of the links in the bundle, not the entire bundle. Only 10G per link is allowed for a dedicated interconnect. Options: Ethernet_10G_LR Corresponds to the JSON property linkType

Returns:

  • (String)


11853
11854
11855
# File 'generated/google/apis/compute_alpha/classes.rb', line 11853

def link_type
  @link_type
end

#locationString

URL of the InterconnectLocation object that represents where this connection is to be provisioned. Corresponds to the JSON property location

Returns:

  • (String)


11859
11860
11861
# File 'generated/google/apis/compute_alpha/classes.rb', line 11859

def location
  @location
end

#nameString

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


11869
11870
11871
# File 'generated/google/apis/compute_alpha/classes.rb', line 11869

def name
  @name
end

#noc_contact_emailString

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)


11877
11878
11879
# File 'generated/google/apis/compute_alpha/classes.rb', line 11877

def noc_contact_email
  @noc_contact_email
end

#operational_statusString

[Output Only] The current status of whether or not this Interconnect is functional. Corresponds to the JSON property operationalStatus

Returns:

  • (String)


11883
11884
11885
# File 'generated/google/apis/compute_alpha/classes.rb', line 11883

def operational_status
  @operational_status
end

#peer_ip_addressString

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


11890
11891
11892
# File 'generated/google/apis/compute_alpha/classes.rb', line 11890

def peer_ip_address
  @peer_ip_address
end

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

Returns:

  • (Fixnum)


11895
11896
11897
# File 'generated/google/apis/compute_alpha/classes.rb', line 11895

def provisioned_link_count
  @provisioned_link_count
end

Target number of physical links in the link bundle, as requested by the customer. Corresponds to the JSON property requestedLinkCount

Returns:

  • (Fixnum)


11901
11902
11903
# File 'generated/google/apis/compute_alpha/classes.rb', line 11901

def requested_link_count
  @requested_link_count
end

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

Returns:

  • (String)


11906
11907
11908
# File 'generated/google/apis/compute_alpha/classes.rb', line 11906

def self_link
  @self_link
end

#stateString

[Output Only] The current state of whether or not this Interconnect is functional. Corresponds to the JSON property state

Returns:

  • (String)


11912
11913
11914
# File 'generated/google/apis/compute_alpha/classes.rb', line 11912

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
# File 'generated/google/apis/compute_alpha/classes.rb', line 11919

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