Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Interconnect (v2.12.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Interconnect.

Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#admin_enabled

def admin_enabled() -> ::Boolean
Returns
  • (::Boolean) — 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.

#admin_enabled=

def admin_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#available_features

def available_features() -> ::Array<::String>
Returns
  • (::Array<::String>) — [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. Check the AvailableFeatures enum for the list of possible values.

#available_features=

def available_features=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. Check the AvailableFeatures enum for the list of possible values.
Returns
  • (::Array<::String>) — [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. Check the AvailableFeatures enum for the list of possible values.

#circuit_infos

def circuit_infos() -> ::Array<::Google::Cloud::Compute::V1::InterconnectCircuitInfo>
Returns

#circuit_infos=

def circuit_infos=(value) -> ::Array<::Google::Cloud::Compute::V1::InterconnectCircuitInfo>
Parameter
Returns

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Creation timestamp in RFC3339 text format.
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#customer_name

def customer_name() -> ::String
Returns
  • (::String) — Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

#customer_name=

def customer_name=(value) -> ::String
Parameter
  • value (::String) — Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
Returns
  • (::String) — Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#expected_outages

def expected_outages() -> ::Array<::Google::Cloud::Compute::V1::InterconnectOutageNotification>
Returns

#expected_outages=

def expected_outages=(value) -> ::Array<::Google::Cloud::Compute::V1::InterconnectOutageNotification>
Parameter
Returns

#google_ip_address

def google_ip_address() -> ::String
Returns
  • (::String) — [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

#google_ip_address=

def google_ip_address=(value) -> ::String
Parameter
  • value (::String) — [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
Returns
  • (::String) — [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

#google_reference_id

def google_reference_id() -> ::String
Returns
  • (::String) — [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

#google_reference_id=

def google_reference_id=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
Returns
  • (::String) — [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

#id

def id() -> ::Integer
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#interconnect_attachments

def interconnect_attachments() -> ::Array<::String>
Returns
  • (::Array<::String>) — [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

#interconnect_attachments=

def interconnect_attachments=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
Returns
  • (::Array<::String>) — [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

#interconnect_type

def interconnect_type() -> ::String
Returns
  • (::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. Check the InterconnectType enum for the list of possible values.

#interconnect_type=

def interconnect_type=(value) -> ::String
Parameter
  • value (::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. Check the InterconnectType enum for the list of possible values.
Returns
  • (::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. Check the InterconnectType enum for the list of possible values.

#kind

def kind() -> ::String
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#interconnect for interconnects.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Type of the resource. Always compute#interconnect for interconnects.
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#interconnect for interconnects.

#label_fingerprint

def label_fingerprint() -> ::String
Returns
  • (::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.

#label_fingerprint=

def label_fingerprint=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::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.
Returns
  • (::Google::Protobuf::Map{::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.

#link_type

def link_type() -> ::String
Returns
  • (::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. Check the LinkType enum for the list of possible values.

#link_type=

def link_type=(value) -> ::String
Parameter
  • value (::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. Check the LinkType enum for the list of possible values.
Returns
  • (::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. Check the LinkType enum for the list of possible values.

#location

def location() -> ::String
Returns
  • (::String) — URL of the InterconnectLocation object that represents where this connection is to be provisioned.

#location=

def location=(value) -> ::String
Parameter
  • value (::String) — URL of the InterconnectLocation object that represents where this connection is to be provisioned.
Returns
  • (::String) — URL of the InterconnectLocation object that represents where this connection is to be provisioned.

#macsec

def macsec() -> ::Google::Cloud::Compute::V1::InterconnectMacsec
Returns

#macsec=

def macsec=(value) -> ::Google::Cloud::Compute::V1::InterconnectMacsec
Parameter
Returns

#macsec_enabled

def macsec_enabled() -> ::Boolean
Returns
  • (::Boolean) — Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.

#macsec_enabled=

def macsec_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
Returns
  • (::Boolean) — Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#noc_contact_email

def noc_contact_email() -> ::String
Returns
  • (::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 Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.

#noc_contact_email=

def noc_contact_email=(value) -> ::String
Parameter
  • value (::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 Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.
Returns
  • (::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 Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.

#operational_status

def operational_status() -> ::String
Returns
  • (::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. Check the OperationalStatus enum for the list of possible values.

#operational_status=

def operational_status=(value) -> ::String
Parameter
  • value (::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. Check the OperationalStatus enum for the list of possible values.
Returns
  • (::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. Check the OperationalStatus enum for the list of possible values.

#peer_ip_address

def peer_ip_address() -> ::String
Returns
  • (::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.

#peer_ip_address=

def peer_ip_address=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#provisioned_link_count

def provisioned_link_count() -> ::Integer
Returns
  • (::Integer) — [Output Only] Number of links actually provisioned in this interconnect.

#provisioned_link_count=

def provisioned_link_count=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] Number of links actually provisioned in this interconnect.
Returns
  • (::Integer) — [Output Only] Number of links actually provisioned in this interconnect.

#remote_location

def remote_location() -> ::String
Returns
  • (::String) — Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.

#remote_location=

def remote_location=(value) -> ::String
Parameter
  • value (::String) — Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.
Returns
  • (::String) — Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.

#requested_features

def requested_features() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. Check the RequestedFeatures enum for the list of possible values.

#requested_features=

def requested_features=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. Check the RequestedFeatures enum for the list of possible values.
Returns
  • (::Array<::String>) — Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. Check the RequestedFeatures enum for the list of possible values.

#requested_link_count

def requested_link_count() -> ::Integer
Returns
  • (::Integer) — Target number of physical links in the link bundle, as requested by the customer.

#requested_link_count=

def requested_link_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Target number of physical links in the link bundle, as requested by the customer.
Returns
  • (::Integer) — Target number of physical links in the link bundle, as requested by the customer.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — [Output Only] Reserved for future use.

#satisfies_pzs=

def satisfies_pzs=(value) -> ::Boolean
Parameter
  • value (::Boolean) — [Output Only] Reserved for future use.
Returns
  • (::Boolean) — [Output Only] Reserved for future use.

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Server-defined URL for the resource.
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#state

def state() -> ::String
Returns
  • (::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. Check the State enum for the list of possible values.

#state=

def state=(value) -> ::String
Parameter
  • value (::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. Check the State enum for the list of possible values.
Returns
  • (::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. Check the State enum for the list of possible values.