Class: Google::Apis::ComputeAlpha::Interconnect
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Interconnect
- 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 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
-
#admin_enabled ⇒ Boolean
(also: #admin_enabled?)
Administrative status of the interconnect.
-
#circuit_infos ⇒ Array<Google::Apis::ComputeAlpha::InterconnectCircuitInfo>
[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#customer_name ⇒ String
Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
-
#description ⇒ String
An optional description of this resource.
-
#expected_outages ⇒ Array<Google::Apis::ComputeAlpha::InterconnectOutageNotification>
[Output Only] A list of outages expected for this Interconnect.
-
#google_ip_address ⇒ String
[Output Only] IP address configured on the Google side of the Interconnect link.
-
#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.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#interconnect_attachments ⇒ Array<String>
[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
-
#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.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#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.
-
#labels ⇒ Hash<String,String>
Labels to apply to this Interconnect resource.
-
#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.
-
#location ⇒ String
URL of the InterconnectLocation object that represents where this connection is to be provisioned.
-
#name ⇒ String
Name of the resource.
-
#noc_contact_email ⇒ String
Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect.
-
#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.
-
#peer_ip_address ⇒ String
[Output Only] IP address configured on the customer side of the Interconnect link.
-
#provisioned_link_count ⇒ Fixnum
[Output Only] Number of links actually provisioned in this interconnect.
-
#requested_link_count ⇒ Fixnum
Target number of physical links in the link bundle, as requested by the customer.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#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.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Interconnect
constructor
A new instance of Interconnect.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Interconnect
Returns a new instance of Interconnect.
15161 15162 15163 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15161 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
14986 14987 14988 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 14986 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
14993 14994 14995 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 14993 def circuit_infos @circuit_infos end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
14998 14999 15000 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 14998 def @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
15004 15005 15006 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15004 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
15010 15011 15012 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15010 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
15015 15016 15017 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15015 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
15021 15022 15023 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15021 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
15027 15028 15029 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15027 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
15033 15034 15035 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15033 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
15039 15040 15041 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15039 def @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
15048 15049 15050 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15048 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
15054 15055 15056 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15054 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.
15067 15068 15069 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15067 def label_fingerprint @label_fingerprint end |
#labels ⇒ Hash<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
15074 15075 15076 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15074 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
15083 15084 15085 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15083 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
15089 15090 15091 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15089 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
15099 15100 15101 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15099 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
15107 15108 15109 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15107 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
15119 15120 15121 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15119 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
15126 15127 15128 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15126 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
15131 15132 15133 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15131 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
15137 15138 15139 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15137 def requested_link_count @requested_link_count end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
15142 15143 15144 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15142 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
15147 15148 15149 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15147 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
15159 15160 15161 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15159 def state @state end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
15166 15167 15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 15166 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) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @state = args[:state] if args.key?(:state) end |