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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ aai_enabled |
bool
Enable or disable the application awareness feature on this Cloud Interconnect. |
↳ 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. |
↳ application_aware_interconnect |
InterconnectApplicationAwareInterconnect
Configuration information for application awareness on this Cloud Interconnect. |
↳ 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. Any attempt to enable MACsec will fail. - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is provisioned exclusively for Cross-Site Networking. Any attempt to configure VLAN attachments will fail. If not present, then the Interconnect connection is not provisioned for Cross-Site Networking. Any attempt to use it for Cross-Site Networking will fail. Check the AvailableFeatures enum for the list of possible values. |
↳ circuit_infos |
array<InterconnectCircuitInfo>
Output only. [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. |
↳ creation_timestamp |
string
Output only. [Output Only] Creation timestamp inRFC3339 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. [Output Only] A list of outages expected for this Interconnect. |
↳ google_ip_address |
string
Output only. [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. [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. [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
↳ interconnect_attachments |
array
Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. |
↳ interconnect_groups |
array
Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect. Order is arbitrary and items are unique. |
↳ 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. [Output Only] Type of the resource. Alwayscompute#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 error412 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 thesetLabels method. Each label key/value pair must comply withRFC1035. 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 withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
↳ 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. [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. |
↳ params |
InterconnectParams
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. |
↳ peer_ip_address |
string
Output only. [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. [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. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. 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, non-MACsec capable ports will also be considered. - IF_CROSS_SITE_NETWORK: If specified, then the connection is created exclusively for Cross-Site Networking. The connection can not be used for Cross-Site Networking unless this feature is specified. 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. [Output Only] Reserved for future use. |
↳ self_link |
string
Output only. [Output Only] Server-defined URL for the resource. |
↳ state |
string
Output only. [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. |
↳ subzone |
string
Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned. Check the Subzone enum for the list of possible values. |
↳ wire_groups |
array
Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty. |
getAaiEnabled
Enable or disable the application awareness feature on this Cloud Interconnect.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasAaiEnabled
clearAaiEnabled
setAaiEnabled
Enable or disable the application awareness feature on this Cloud Interconnect.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApplicationAwareInterconnect
Configuration information for application awareness on this Cloud Interconnect.
| Returns | |
|---|---|
| Type | Description |
InterconnectApplicationAwareInterconnect|null |
|
hasApplicationAwareInterconnect
clearApplicationAwareInterconnect
setApplicationAwareInterconnect
Configuration information for application awareness on this Cloud Interconnect.
| Parameter | |
|---|---|
| Name | Description |
var |
InterconnectApplicationAwareInterconnect
|
| Returns | |
|---|---|
| Type | Description |
$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. Any attempt to enable MACsec will fail.
- IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is provisioned exclusively for Cross-Site Networking. Any attempt to configure VLAN attachments will fail. If not present, then the Interconnect connection is not provisioned for Cross-Site Networking. Any attempt to use it for Cross-Site Networking will fail. Check the AvailableFeatures enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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. Any attempt to enable MACsec will fail.
- IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is provisioned exclusively for Cross-Site Networking. Any attempt to configure VLAN attachments will fail. If not present, then the Interconnect connection is not provisioned for Cross-Site Networking. Any attempt to use it for Cross-Site Networking will fail. Check the AvailableFeatures enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCircuitInfos
Output only. [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCircuitInfos
Output only. [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InterconnectCircuitInfo>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomerName
Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCustomerName
clearCustomerName
setCustomerName
Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
An optional description of this resource. Provide this property when you create the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpectedOutages
Output only. [Output Only] A list of outages expected for this Interconnect.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setExpectedOutages
Output only. [Output Only] A list of outages expected for this Interconnect.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InterconnectOutageNotification>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGoogleIpAddress
Output only. [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasGoogleIpAddress
clearGoogleIpAddress
setGoogleIpAddress
Output only. [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGoogleReferenceId
Output only. [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasGoogleReferenceId
clearGoogleReferenceId
setGoogleReferenceId
Output only. [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasId
clearId
setId
Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInterconnectAttachments
Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setInterconnectAttachments
Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInterconnectGroups
Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.
Order is arbitrary and items are unique.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setInterconnectGroups
Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.
Order is arbitrary and items are unique.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKind
Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasKind
clearKind
setKind
Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 error412 conditionNotMet.
To see the latest fingerprint, make a get() request to retrieve an Interconnect.
| Returns | |
|---|---|
| Type | Description |
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 error412 conditionNotMet.
To see the latest fingerprint, make a get() request to retrieve an Interconnect.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
Label values may be empty.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
Label values may be empty.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocation
URL of the InterconnectLocation object that represents where this connection is to be provisioned.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasLocation
clearLocation
setLocation
URL of the InterconnectLocation object that represents where this connection is to be provisioned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMacsec
Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.
| Returns | |
|---|---|
| Type | Description |
InterconnectMacsec|null |
|
hasMacsec
clearMacsec
setMacsec
Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.
| Parameter | |
|---|---|
| Name | Description |
var |
InterconnectMacsec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMacsecEnabled
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasMacsecEnabled
clearMacsecEnabled
setMacsecEnabled
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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 withRFC1035.
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 | |
|---|---|
| Type | Description |
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 withRFC1035.
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOperationalStatus
Output only. [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 | |
|---|---|
| Type | Description |
string |
|
hasOperationalStatus
clearOperationalStatus
setOperationalStatus
Output only. [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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParams
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
| Returns | |
|---|---|
| Type | Description |
InterconnectParams|null |
|
hasParams
clearParams
setParams
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
| Parameter | |
|---|---|
| Name | Description |
var |
InterconnectParams
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPeerIpAddress
Output only. [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 | |
|---|---|
| Type | Description |
string |
|
hasPeerIpAddress
clearPeerIpAddress
setPeerIpAddress
Output only. [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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProvisionedLinkCount
Output only. [Output Only] Number of links actually provisioned in this interconnect.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasProvisionedLinkCount
clearProvisionedLinkCount
setProvisionedLinkCount
Output only. [Output Only] Number of links actually provisioned in this interconnect.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestedFeatures
Optional. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. 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, non-MACsec capable ports will also be considered.
- IF_CROSS_SITE_NETWORK: If specified, then the connection is created exclusively for Cross-Site Networking. The connection can not be used for Cross-Site Networking unless this feature is specified. Check the RequestedFeatures enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setRequestedFeatures
Optional. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. 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, non-MACsec capable ports will also be considered.
- IF_CROSS_SITE_NETWORK: If specified, then the connection is created exclusively for Cross-Site Networking. The connection can not be used for Cross-Site Networking unless this feature is specified. Check the RequestedFeatures enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestedLinkCount
Target number of physical links in the link bundle, as requested by the customer.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasRequestedLinkCount
clearRequestedLinkCount
setRequestedLinkCount
Target number of physical links in the link bundle, as requested by the customer.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzs
Output only. [Output Only] Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
Output only. [Output Only] Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLink
Output only. [Output Only] Server-defined URL for the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSelfLink
clearSelfLink
setSelfLink
Output only. [Output Only] Server-defined URL for the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. [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 | |
|---|---|
| Type | Description |
string |
|
hasState
clearState
setState
Output only. [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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubzone
Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.
Check the Subzone enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSubzone
clearSubzone
setSubzone
Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.
Check the Subzone enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWireGroups
Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setWireGroups
Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|