Reference documentation and code samples for the Compute V1 Client class 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.
Generated from protobuf message google.cloud.compute.v1.Interconnect
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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.
↳ available_features
array
[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_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
array< 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. Provide this property when you create the resource.
↳ expected_outages
array< 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. This can be used only for ping tests.
↳ 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
int|string
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ interconnect_attachments
array
[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. - 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
string
[Output Only] Type of the resource. Always compute#interconnect for interconnects.
↳ 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.
↳ labels
array| Google\Protobuf\Internal\MapField
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
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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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
string
URL of the InterconnectLocation object that represents where this connection is to be provisioned.
↳ macsec
InterconnectMacsec
Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.
↳ macsec_enabled
bool
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
↳ 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.
↳ 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 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
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
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
int
[Output Only] Number of links actually provisioned in this interconnect.
↳ remote_location
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
array
Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_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.
↳ satisfies_pzs
bool
[Output Only] Reserved for future use.
↳ self_link
string
[Output Only] Server-defined URL for the resource.
↳ 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. Check the State enum for the list of possible values.
getAdminEnabled
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.
bool
hasAdminEnabled
clearAdminEnabled
setAdminEnabled
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.
var
bool
$this
getAvailableFeatures
[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_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.
setAvailableFeatures
[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_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.
var
string[]
$this
getCircuitInfos
[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
setCircuitInfos
[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
var
string
$this
getCustomerName
Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
string
hasCustomerName
clearCustomerName
setCustomerName
Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
var
string
$this
getExpectedOutages
[Output Only] A list of outages expected for this Interconnect.
setExpectedOutages
[Output Only] A list of outages expected for this Interconnect.
$this
getGoogleIpAddress
[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
string
hasGoogleIpAddress
clearGoogleIpAddress
setGoogleIpAddress
[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
var
string
$this
getGoogleReferenceId
[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
string
hasGoogleReferenceId
clearGoogleReferenceId
setGoogleReferenceId
[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
var
string
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
var
int|string
$this
getInterconnectAttachments
[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
setInterconnectAttachments
[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
var
string[]
$this
getInterconnectType
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.
string
hasInterconnectType
clearInterconnectType
setInterconnectType
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.
var
string
$this
getKind
[Output Only] Type of the resource. Always compute#interconnect for interconnects.
string
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#interconnect for interconnects.
var
string
$this
getLabelFingerprint
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.
string
hasLabelFingerprint
clearLabelFingerprint
setLabelFingerprint
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.
var
string
$this
getLabels
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.
setLabels
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.
$this
getLinkType
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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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.
string
hasLinkType
clearLinkType
setLinkType
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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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.
var
string
$this
getLocation
URL of the InterconnectLocation object that represents where this connection is to be provisioned.
string
hasLocation
clearLocation
setLocation
URL of the InterconnectLocation object that represents where this connection is to be provisioned.
var
string
$this
getMacsec
Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.
hasMacsec
clearMacsec
setMacsec
Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.
$this
getMacsecEnabled
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
bool
hasMacsecEnabled
clearMacsecEnabled
setMacsecEnabled
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
var
bool
$this
getName
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.
string
hasName
clearName
setName
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.
var
string
$this
getNocContactEmail
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.
string
hasNocContactEmail
clearNocContactEmail
setNocContactEmail
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.
var
string
$this
getOperationalStatus
[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.
string
hasOperationalStatus
clearOperationalStatus
setOperationalStatus
[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.
var
string
$this
getPeerIpAddress
[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.
string
hasPeerIpAddress
clearPeerIpAddress
setPeerIpAddress
[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.
var
string
$this
getProvisionedLinkCount
[Output Only] Number of links actually provisioned in this interconnect.
int
hasProvisionedLinkCount
clearProvisionedLinkCount
setProvisionedLinkCount
[Output Only] Number of links actually provisioned in this interconnect.
var
int
$this
getRemoteLocation
Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.
string
hasRemoteLocation
clearRemoteLocation
setRemoteLocation
Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.
var
string
$this
getRequestedFeatures
Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_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.
setRequestedFeatures
Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_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.
var
string[]
$this
getRequestedLinkCount
Target number of physical links in the link bundle, as requested by the customer.
int
hasRequestedLinkCount
clearRequestedLinkCount
setRequestedLinkCount
Target number of physical links in the link bundle, as requested by the customer.
var
int
$this
getSatisfiesPzs
[Output Only] Reserved for future use.
bool
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
[Output Only] Reserved for future use.
var
bool
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
var
string
$this
getState
[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.
string
hasState
clearState
setState
[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.
var
string
$this
