Class: Google::Apis::ComputeBeta::Interconnect

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



10386
10387
10388
# File 'generated/google/apis/compute_beta/classes.rb', line 10386

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)


10234
10235
10236
# File 'generated/google/apis/compute_beta/classes.rb', line 10234

def admin_enabled
  @admin_enabled
end

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

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



10241
10242
10243
# File 'generated/google/apis/compute_beta/classes.rb', line 10241

def circuit_infos
  @circuit_infos
end

#creation_timestampString

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

Returns:

  • (String)


10246
10247
10248
# File 'generated/google/apis/compute_beta/classes.rb', line 10246

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)


10252
10253
10254
# File 'generated/google/apis/compute_beta/classes.rb', line 10252

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)


10258
10259
10260
# File 'generated/google/apis/compute_beta/classes.rb', line 10258

def description
  @description
end

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

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



10263
10264
10265
# File 'generated/google/apis/compute_beta/classes.rb', line 10263

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)


10269
10270
10271
# File 'generated/google/apis/compute_beta/classes.rb', line 10269

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)


10275
10276
10277
# File 'generated/google/apis/compute_beta/classes.rb', line 10275

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)


10281
10282
10283
# File 'generated/google/apis/compute_beta/classes.rb', line 10281

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


10287
10288
10289
# File 'generated/google/apis/compute_beta/classes.rb', line 10287

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)


10293
10294
10295
# File 'generated/google/apis/compute_beta/classes.rb', line 10293

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)


10299
10300
10301
# File 'generated/google/apis/compute_beta/classes.rb', line 10299

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)


10311
10312
10313
# File 'generated/google/apis/compute_beta/classes.rb', line 10311

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


10318
10319
10320
# File 'generated/google/apis/compute_beta/classes.rb', line 10318

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)


10325
10326
10327
# File 'generated/google/apis/compute_beta/classes.rb', line 10325

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)


10331
10332
10333
# File 'generated/google/apis/compute_beta/classes.rb', line 10331

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)


10341
10342
10343
# File 'generated/google/apis/compute_beta/classes.rb', line 10341

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)


10349
10350
10351
# File 'generated/google/apis/compute_beta/classes.rb', line 10349

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)


10355
10356
10357
# File 'generated/google/apis/compute_beta/classes.rb', line 10355

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)


10362
10363
10364
# File 'generated/google/apis/compute_beta/classes.rb', line 10362

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)


10367
10368
10369
# File 'generated/google/apis/compute_beta/classes.rb', line 10367

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)


10373
10374
10375
# File 'generated/google/apis/compute_beta/classes.rb', line 10373

def requested_link_count
  @requested_link_count
end

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

Returns:

  • (String)


10378
10379
10380
# File 'generated/google/apis/compute_beta/classes.rb', line 10378

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)


10384
10385
10386
# File 'generated/google/apis/compute_beta/classes.rb', line 10384

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
# File 'generated/google/apis/compute_beta/classes.rb', line 10391

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