Class Interconnect (1.18.0)

Interconnect(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`admin_enabled`	`bool` 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. This field is a member of `oneof`_ `_admin_enabled`.
`available_features`	`MutableSequence[str]` [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`	`MutableSequence[google.cloud.compute_v1.types.InterconnectCircuitInfo]` [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
`creation_timestamp`	`str` [Output Only] Creation timestamp in RFC3339 text format. This field is a member of `oneof`_ `_creation_timestamp`.
`customer_name`	`str` Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. This field is a member of `oneof`_ `_customer_name`.
`description`	`str` An optional description of this resource. Provide this property when you create the resource. This field is a member of `oneof`_ `_description`.
`expected_outages`	`MutableSequence[google.cloud.compute_v1.types.InterconnectOutageNotification]` [Output Only] A list of outages expected for this Interconnect.
`google_ip_address`	`str` [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. This field is a member of `oneof`_ `_google_ip_address`.
`google_reference_id`	`str` [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. This field is a member of `oneof`_ `_google_reference_id`.
`id`	`int` [Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of `oneof`_ `_id`.
`interconnect_attachments`	`MutableSequence[str]` [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
`interconnect_type`	`str` 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. This field is a member of `oneof`_ `_interconnect_type`.
`kind`	`str` [Output Only] Type of the resource. Always compute#interconnect for interconnects. This field is a member of `oneof`_ `_kind`.
`label_fingerprint`	`str` 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. This field is a member of `oneof`_ `_label_fingerprint`.
`labels`	`MutableMapping[str, str]` 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`	`str` 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. This field is a member of `oneof`_ `_link_type`.
`location`	`str` URL of the InterconnectLocation object that represents where this connection is to be provisioned. This field is a member of `oneof`_ `_location`.
`macsec`	`google.cloud.compute_v1.types.InterconnectMacsec` Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router. This field is a member of `oneof`_ `_macsec`.
`macsec_enabled`	`bool` Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified. This field is a member of `oneof`_ `_macsec_enabled`.
`name`	`str` 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. This field is a member of `oneof`_ `_name`.
`noc_contact_email`	`str` 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. This field is a member of `oneof`_ `_noc_contact_email`.
`operational_status`	`str` [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. This field is a member of `oneof`_ `_operational_status`.
`peer_ip_address`	`str` [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. This field is a member of `oneof`_ `_peer_ip_address`.
`provisioned_link_count`	`int` [Output Only] Number of links actually provisioned in this interconnect. This field is a member of `oneof`_ `_provisioned_link_count`.
`remote_location`	`str` Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. This field is a member of `oneof`_ `_remote_location`.
`requested_features`	`MutableSequence[str]` 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`	`int` Target number of physical links in the link bundle, as requested by the customer. This field is a member of `oneof`_ `_requested_link_count`.
`satisfies_pzs`	`bool` [Output Only] Reserved for future use. This field is a member of `oneof`_ `_satisfies_pzs`.
`self_link`	`str` [Output Only] Server-defined URL for the resource. This field is a member of `oneof`_ `_self_link`.
`state`	`str` [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. This field is a member of `oneof`_ `_state`.

Classes

AvailableFeatures

AvailableFeatures(value)

Additional supported values which may be not listed in the enum directly due to technical reasons: IF_MACSEC

Values: UNDEFINED_AVAILABLE_FEATURES (0): A value indicating that the enum field is not set.

InterconnectType

InterconnectType(value)

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.

Values: UNDEFINED_INTERCONNECT_TYPE (0): A value indicating that the enum field is not set. DEDICATED (258411983): A dedicated physical interconnection with the customer. IT_PRIVATE (335677007): [Deprecated] A private, physical interconnection with the customer. PARTNER (461924520): A partner-managed interconnection shared between customers via partner.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

LinkType

LinkType(value)

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.

Values: UNDEFINED_LINK_TYPE (0): A value indicating that the enum field is not set. LINK_TYPE_ETHERNET_100G_LR (337672551): 100G Ethernet, LR Optics. LINK_TYPE_ETHERNET_10G_LR (236739749): 10G Ethernet, LR Optics. [(rate_bps) = 10000000000];

OperationalStatus

OperationalStatus(value)

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

Values: UNDEFINED_OPERATIONAL_STATUS (0): A value indicating that the enum field is not set. OS_ACTIVE (55721409): The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect. OS_UNPROVISIONED (239771840): The interconnect has not completed turnup. No attachments may be provisioned on this interconnect.

RequestedFeatures

RequestedFeatures(value)

Additional supported values which may be not listed in the enum directly due to technical reasons: IF_MACSEC

Values: UNDEFINED_REQUESTED_FEATURES (0): A value indicating that the enum field is not set.

State

State(value)

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

Values: UNDEFINED_STATE (0): A value indicating that the enum field is not set. ACTIVE (314733318): The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect. UNPROVISIONED (517333979): The interconnect has not completed turnup. No attachments may be provisioned on this interconnect.