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



12282
12283
12284
# File 'generated/google/apis/compute_alpha/classes.rb', line 12282

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)


12130
12131
12132
# File 'generated/google/apis/compute_alpha/classes.rb', line 12130

def admin_enabled
  @admin_enabled
end

#circuit_infosArray<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



12137
12138
12139
# File 'generated/google/apis/compute_alpha/classes.rb', line 12137

def circuit_infos
  @circuit_infos
end

#creation_timestampString

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

Returns:

  • (String)


12142
12143
12144
# File 'generated/google/apis/compute_alpha/classes.rb', line 12142

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)


12148
12149
12150
# File 'generated/google/apis/compute_alpha/classes.rb', line 12148

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)


12154
12155
12156
# File 'generated/google/apis/compute_alpha/classes.rb', line 12154

def description
  @description
end

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

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



12159
12160
12161
# File 'generated/google/apis/compute_alpha/classes.rb', line 12159

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)


12165
12166
12167
# File 'generated/google/apis/compute_alpha/classes.rb', line 12165

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)


12171
12172
12173
# File 'generated/google/apis/compute_alpha/classes.rb', line 12171

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)


12177
12178
12179
# File 'generated/google/apis/compute_alpha/classes.rb', line 12177

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


12183
12184
12185
# File 'generated/google/apis/compute_alpha/classes.rb', line 12183

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)


12189
12190
12191
# File 'generated/google/apis/compute_alpha/classes.rb', line 12189

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)


12195
12196
12197
# File 'generated/google/apis/compute_alpha/classes.rb', line 12195

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)


12207
12208
12209
# File 'generated/google/apis/compute_alpha/classes.rb', line 12207

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


12214
12215
12216
# File 'generated/google/apis/compute_alpha/classes.rb', line 12214

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)


12221
12222
12223
# File 'generated/google/apis/compute_alpha/classes.rb', line 12221

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)


12227
12228
12229
# File 'generated/google/apis/compute_alpha/classes.rb', line 12227

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


12237
12238
12239
# File 'generated/google/apis/compute_alpha/classes.rb', line 12237

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)


12245
12246
12247
# File 'generated/google/apis/compute_alpha/classes.rb', line 12245

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)


12251
12252
12253
# File 'generated/google/apis/compute_alpha/classes.rb', line 12251

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)


12258
12259
12260
# File 'generated/google/apis/compute_alpha/classes.rb', line 12258

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)


12263
12264
12265
# File 'generated/google/apis/compute_alpha/classes.rb', line 12263

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)


12269
12270
12271
# File 'generated/google/apis/compute_alpha/classes.rb', line 12269

def requested_link_count
  @requested_link_count
end

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

Returns:

  • (String)


12274
12275
12276
# File 'generated/google/apis/compute_alpha/classes.rb', line 12274

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)


12280
12281
12282
# File 'generated/google/apis/compute_alpha/classes.rb', line 12280

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
# File 'generated/google/apis/compute_alpha/classes.rb', line 12287

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