Interconnect (Compute Engine API v1 (Rev. 235) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.Interconnect

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Interconnect
extends com.google.api.client.json.GenericJson
```
Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==)
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Interconnect()

Constructors
Constructor and Description
`Interconnect()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Interconnect`	`clone()`
`java.lang.Boolean`	`getAdminEnabled()` Administrative status of the interconnect.
`java.util.List<InterconnectCircuitInfo>`	`getCircuitInfos()` [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
`java.lang.String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`java.lang.String`	`getCustomerName()` Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.util.List<InterconnectOutageNotification>`	`getExpectedOutages()` [Output Only] A list of outages expected for this Interconnect.
`java.lang.String`	`getGoogleIpAddress()` [Output Only] IP address configured on the Google side of the Interconnect link.
`java.lang.String`	`getGoogleReferenceId()` [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
`java.math.BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`java.util.List<java.lang.String>`	`getInterconnectAttachments()` [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
`java.lang.String`	`getInterconnectType()` Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner.
`java.lang.String`	`getKind()` [Output Only] Type of the resource.
`java.lang.String`	`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.
`java.lang.String`	`getLocation()` URL of the InterconnectLocation object that represents where this connection is to be provisioned.
`java.lang.String`	`getName()` Name of the resource.
`java.lang.String`	`getNocContactEmail()` Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect.
`java.lang.String`	`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.
`java.lang.String`	`getPeerIpAddress()` [Output Only] IP address configured on the customer side of the Interconnect link.
`java.lang.Integer`	`getProvisionedLinkCount()` [Output Only] Number of links actually provisioned in this interconnect.
`java.lang.Integer`	`getRequestedLinkCount()` Target number of physical links in the link bundle, as requested by the customer.
`java.lang.String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`java.lang.String`	`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.
`Interconnect`	`set(java.lang.String fieldName, java.lang.Object value)`
`Interconnect`	`setAdminEnabled(java.lang.Boolean adminEnabled)` Administrative status of the interconnect.
`Interconnect`	`setCircuitInfos(java.util.List<InterconnectCircuitInfo> circuitInfos)` [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
`Interconnect`	`setCreationTimestamp(java.lang.String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Interconnect`	`setCustomerName(java.lang.String customerName)` Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
`Interconnect`	`setDescription(java.lang.String description)` An optional description of this resource.
`Interconnect`	`setExpectedOutages(java.util.List<InterconnectOutageNotification> expectedOutages)` [Output Only] A list of outages expected for this Interconnect.
`Interconnect`	`setGoogleIpAddress(java.lang.String googleIpAddress)` [Output Only] IP address configured on the Google side of the Interconnect link.
`Interconnect`	`setGoogleReferenceId(java.lang.String googleReferenceId)` [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
`Interconnect`	`setId(java.math.BigInteger id)` [Output Only] The unique identifier for the resource.
`Interconnect`	`setInterconnectAttachments(java.util.List<java.lang.String> interconnectAttachments)` [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
`Interconnect`	`setInterconnectType(java.lang.String interconnectType)` Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner.
`Interconnect`	`setKind(java.lang.String kind)` [Output Only] Type of the resource.
`Interconnect`	`setLinkType(java.lang.String linkType)` 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.
`Interconnect`	`setLocation(java.lang.String location)` URL of the InterconnectLocation object that represents where this connection is to be provisioned.
`Interconnect`	`setName(java.lang.String name)` Name of the resource.
`Interconnect`	`setNocContactEmail(java.lang.String nocContactEmail)` Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect.
`Interconnect`	`setOperationalStatus(java.lang.String operationalStatus)` [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.
`Interconnect`	`setPeerIpAddress(java.lang.String peerIpAddress)` [Output Only] IP address configured on the customer side of the Interconnect link.
`Interconnect`	`setProvisionedLinkCount(java.lang.Integer provisionedLinkCount)` [Output Only] Number of links actually provisioned in this interconnect.
`Interconnect`	`setRequestedLinkCount(java.lang.Integer requestedLinkCount)` Target number of physical links in the link bundle, as requested by the customer.
`Interconnect`	`setSelfLink(java.lang.String selfLink)` [Output Only] Server-defined URL for the resource.
`Interconnect`	`setState(java.lang.String state)` [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.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Interconnect
```
public Interconnect()
```
- Method Detail
  - getAdminEnabled
```
public java.lang.Boolean 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:
    
    value or null for none
  - setAdminEnabled
```
public Interconnect setAdminEnabled(java.lang.Boolean adminEnabled)
```
    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.
    
    Parameters:
    
    adminEnabled - adminEnabled or null for none
  - getCircuitInfos
```
public java.util.List<InterconnectCircuitInfo> getCircuitInfos()
```
    [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
    
    Returns:
    
    value or null for none
  - setCircuitInfos
```
public Interconnect setCircuitInfos(java.util.List<InterconnectCircuitInfo> circuitInfos)
```
    [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
    
    Parameters:
    
    circuitInfos - circuitInfos or null for none
  - getCreationTimestamp
```
public java.lang.String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public Interconnect setCreationTimestamp(java.lang.String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getCustomerName
```
public java.lang.String getCustomerName()
```
    Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
    
    Returns:
    
    value or null for none
  - setCustomerName
```
public Interconnect setCustomerName(java.lang.String customerName)
```
    Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
    
    Parameters:
    
    customerName - customerName or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Interconnect setDescription(java.lang.String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - getExpectedOutages
```
public java.util.List<InterconnectOutageNotification> getExpectedOutages()
```
    [Output Only] A list of outages expected for this Interconnect.
    
    Returns:
    
    value or null for none
  - setExpectedOutages
```
public Interconnect setExpectedOutages(java.util.List<InterconnectOutageNotification> expectedOutages)
```
    [Output Only] A list of outages expected for this Interconnect.
    
    Parameters:
    
    expectedOutages - expectedOutages or null for none
  - getGoogleIpAddress
```
public java.lang.String getGoogleIpAddress()
```
    [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
    
    Returns:
    
    value or null for none
  - setGoogleIpAddress
```
public Interconnect setGoogleIpAddress(java.lang.String googleIpAddress)
```
    [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
    
    Parameters:
    
    googleIpAddress - googleIpAddress or null for none
  - getGoogleReferenceId
```
public java.lang.String getGoogleReferenceId()
```
    [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
    
    Returns:
    
    value or null for none
  - setGoogleReferenceId
```
public Interconnect setGoogleReferenceId(java.lang.String googleReferenceId)
```
    [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
    
    Parameters:
    
    googleReferenceId - googleReferenceId or null for none
  - getId
```
public java.math.BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    
    value or null for none
  - setId
```
public Interconnect setId(java.math.BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    
    id - id or null for none
  - getInterconnectAttachments
```
public java.util.List<java.lang.String> getInterconnectAttachments()
```
    [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
    
    Returns:
    
    value or null for none
  - setInterconnectAttachments
```
public Interconnect setInterconnectAttachments(java.util.List<java.lang.String> interconnectAttachments)
```
    [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
    
    Parameters:
    
    interconnectAttachments - interconnectAttachments or null for none
  - getInterconnectType
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
  - setInterconnectType
```
public Interconnect setInterconnectType(java.lang.String interconnectType)
```
    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.
    
    Parameters:
    
    interconnectType - interconnectType or null for none
  - getKind
```
public java.lang.String getKind()
```
    [Output Only] Type of the resource. Always compute#interconnect for interconnects.
    
    Returns:
    
    value or null for none
  - setKind
```
public Interconnect setKind(java.lang.String kind)
```
    [Output Only] Type of the resource. Always compute#interconnect for interconnects.
    
    Parameters:
    
    kind - kind or null for none
  - getLinkType
```
public java.lang.String 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. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
    
    Returns:
    
    value or null for none
  - setLinkType
```
public Interconnect setLinkType(java.lang.String linkType)
```
    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.
    
    Parameters:
    
    linkType - linkType or null for none
  - getLocation
```
public java.lang.String getLocation()
```
    URL of the InterconnectLocation object that represents where this connection is to be provisioned.
    
    Returns:
    
    value or null for none
  - setLocation
```
public Interconnect setLocation(java.lang.String location)
```
    URL of the InterconnectLocation object that represents where this connection is to be provisioned.
    
    Parameters:
    
    location - location or null for none
  - getName
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
  - setName
```
public Interconnect setName(java.lang.String name)
```
    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.
    
    Parameters:
    
    name - name or null for none
  - getNocContactEmail
```
public java.lang.String 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 Stackdriver logs alerting and Cloud Notifications.
    
    Returns:
    
    value or null for none
  - setNocContactEmail
```
public Interconnect setNocContactEmail(java.lang.String nocContactEmail)
```
    Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.
    
    Parameters:
    
    nocContactEmail - nocContactEmail or null for none
  - getOperationalStatus
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
  - setOperationalStatus
```
public Interconnect setOperationalStatus(java.lang.String operationalStatus)
```
    [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.
    
    Parameters:
    
    operationalStatus - operationalStatus or null for none
  - getPeerIpAddress
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
  - setPeerIpAddress
```
public Interconnect setPeerIpAddress(java.lang.String peerIpAddress)
```
    [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.
    
    Parameters:
    
    peerIpAddress - peerIpAddress or null for none
  - getProvisionedLinkCount
```
public java.lang.Integer getProvisionedLinkCount()
```
    [Output Only] Number of links actually provisioned in this interconnect.
    
    Returns:
    
    value or null for none
  - setProvisionedLinkCount
```
public Interconnect setProvisionedLinkCount(java.lang.Integer provisionedLinkCount)
```
    [Output Only] Number of links actually provisioned in this interconnect.
    
    Parameters:
    
    provisionedLinkCount - provisionedLinkCount or null for none
  - getRequestedLinkCount
```
public java.lang.Integer getRequestedLinkCount()
```
    Target number of physical links in the link bundle, as requested by the customer.
    
    Returns:
    
    value or null for none
  - setRequestedLinkCount
```
public Interconnect setRequestedLinkCount(java.lang.Integer requestedLinkCount)
```
    Target number of physical links in the link bundle, as requested by the customer.
    
    Parameters:
    
    requestedLinkCount - requestedLinkCount or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public Interconnect setSelfLink(java.lang.String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getState
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
  - setState
```
public Interconnect setState(java.lang.String state)
```
    [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.
    
    Parameters:
    
    state - state or null for none
  - set
```
public Interconnect set(java.lang.String fieldName,
                        java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Interconnect clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 235)

Class Interconnect

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Interconnect

Method Detail

getAdminEnabled

setAdminEnabled

getCircuitInfos

setCircuitInfos

getCreationTimestamp

setCreationTimestamp

getCustomerName

setCustomerName

getDescription

setDescription

getExpectedOutages

setExpectedOutages

getGoogleIpAddress

setGoogleIpAddress

getGoogleReferenceId

setGoogleReferenceId

getId

setId

getInterconnectAttachments

setInterconnectAttachments

getInterconnectType

setInterconnectType

getKind

setKind

getLinkType

setLinkType

getLocation

setLocation

getName

setName

getNocContactEmail

setNocContactEmail

getOperationalStatus

setOperationalStatus

getPeerIpAddress

setPeerIpAddress

getProvisionedLinkCount

setProvisionedLinkCount

getRequestedLinkCount

setRequestedLinkCount

getSelfLink

setSelfLink

getState

setState

set

clone