
target.apidocs.com.google.api.services.compute.model.Interconnect.html Maven / Gradle / Ivy
Interconnect (Compute Engine API beta-rev20220312-1.32.1)
com.google.api.services.compute.model
Class Interconnect
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.compute.model.Interconnect
-
public final class Interconnect
extends 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.
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
GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Interconnect()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Interconnect
clone()
byte[]
decodeLabelFingerprint()
A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of
the labels set used for optimistic locking.
Interconnect
encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of
the labels set used for optimistic locking.
Boolean
getAdminEnabled()
Administrative status of the interconnect.
List<InterconnectCircuitInfo>
getCircuitInfos()
[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
String
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
String
getCustomerName()
Customer name, to put in the Letter of Authorization as the party authorized to request a
crossconnect.
String
getDescription()
An optional description of this resource.
List<InterconnectOutageNotification>
getExpectedOutages()
[Output Only] A list of outages expected for this Interconnect.
String
getGoogleIpAddress()
[Output Only] IP address configured on the Google side of the Interconnect link.
String
getGoogleReferenceId()
[Output Only] Google reference ID to be used when raising support tickets with Google or
otherwise to debug backend connectivity issues.
BigInteger
getId()
[Output Only] The unique identifier for the resource.
List<String>
getInterconnectAttachments()
[Output Only] A list of the URLs of all InterconnectAttachments configured to use this
Interconnect.
String
getInterconnectType()
Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed
interconnection shared between customers though a partner.
String
getKind()
[Output Only] Type of the resource.
String
getLabelFingerprint()
A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of
the labels set used for optimistic locking.
Map<String,String>
getLabels()
Labels for this resource.
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.
String
getLocation()
URL of the InterconnectLocation object that represents where this connection is to be
provisioned.
String
getName()
Name of the resource.
String
getNocContactEmail()
Email address to contact the customer NOC for operations and maintenance notifications
regarding this Interconnect.
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.
String
getPeerIpAddress()
[Output Only] IP address configured on the customer side of the Interconnect link.
Integer
getProvisionedLinkCount()
[Output Only] Number of links actually provisioned in this interconnect.
Integer
getRequestedLinkCount()
Target number of physical links in the link bundle, as requested by the customer.
Boolean
getSatisfiesPzs()
[Output Only] Set to true if the resource satisfies the zone separation organization policy
constraints and false otherwise.
String
getSelfLink()
[Output Only] Server-defined URL for the resource.
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(String fieldName,
Object value)
Interconnect
setAdminEnabled(Boolean adminEnabled)
Administrative status of the interconnect.
Interconnect
setCircuitInfos(List<InterconnectCircuitInfo> circuitInfos)
[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
Interconnect
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.
Interconnect
setCustomerName(String customerName)
Customer name, to put in the Letter of Authorization as the party authorized to request a
crossconnect.
Interconnect
setDescription(String description)
An optional description of this resource.
Interconnect
setExpectedOutages(List<InterconnectOutageNotification> expectedOutages)
[Output Only] A list of outages expected for this Interconnect.
Interconnect
setGoogleIpAddress(String googleIpAddress)
[Output Only] IP address configured on the Google side of the Interconnect link.
Interconnect
setGoogleReferenceId(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(BigInteger id)
[Output Only] The unique identifier for the resource.
Interconnect
setInterconnectAttachments(List<String> interconnectAttachments)
[Output Only] A list of the URLs of all InterconnectAttachments configured to use this
Interconnect.
Interconnect
setInterconnectType(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(String kind)
[Output Only] Type of the resource.
Interconnect
setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of
the labels set used for optimistic locking.
Interconnect
setLabels(Map<String,String> labels)
Labels for this resource.
Interconnect
setLinkType(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(String location)
URL of the InterconnectLocation object that represents where this connection is to be
provisioned.
Interconnect
setName(String name)
Name of the resource.
Interconnect
setNocContactEmail(String nocContactEmail)
Email address to contact the customer NOC for operations and maintenance notifications
regarding this Interconnect.
Interconnect
setOperationalStatus(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(String peerIpAddress)
[Output Only] IP address configured on the customer side of the Interconnect link.
Interconnect
setProvisionedLinkCount(Integer provisionedLinkCount)
[Output Only] Number of links actually provisioned in this interconnect.
Interconnect
setRequestedLinkCount(Integer requestedLinkCount)
Target number of physical links in the link bundle, as requested by the customer.
Interconnect
setSatisfiesPzs(Boolean satisfiesPzs)
[Output Only] Set to true if the resource satisfies the zone separation organization policy
constraints and false otherwise.
Interconnect
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.
Interconnect
setState(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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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
-
-
Method Detail
-
getAdminEnabled
public 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(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 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(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 String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
- Returns:
- value or
null
for none
-
setCreationTimestamp
public Interconnect setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.
- Parameters:
creationTimestamp
- creationTimestamp or null
for none
-
getCustomerName
public 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(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 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(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 List<InterconnectOutageNotification> getExpectedOutages()
[Output Only] A list of outages expected for this Interconnect.
- Returns:
- value or
null
for none
-
setExpectedOutages
public Interconnect setExpectedOutages(List<InterconnectOutageNotification> expectedOutages)
[Output Only] A list of outages expected for this Interconnect.
- Parameters:
expectedOutages
- expectedOutages or null
for none
-
getGoogleIpAddress
public 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(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 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(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 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(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 List<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(List<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 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(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 String getKind()
[Output Only] Type of the resource. Always compute#interconnect for interconnects.
- Returns:
- value or
null
for none
-
setKind
public Interconnect setKind(String kind)
[Output Only] Type of the resource. Always compute#interconnect for interconnects.
- Parameters:
kind
- kind or null
for none
-
getLabelFingerprint
public String 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.
- Returns:
- value or
null
for none
- See Also:
decodeLabelFingerprint()
-
decodeLabelFingerprint
public byte[] decodeLabelFingerprint()
A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of
the labels set used for optimistic locking. The fingerprint is initially generated by Compute
Engine and changes after every request to modify or update labels. You must always provide an
up-to-date fingerprint hash in order to update or change labels, otherwise the request will
fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to
retrieve an Interconnect.
- Returns:
- Base64 decoded value or
null
for none
- Since:
- 1.14
- See Also:
getLabelFingerprint()
-
setLabelFingerprint
public Interconnect setLabelFingerprint(String labelFingerprint)
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.
- Parameters:
labelFingerprint
- labelFingerprint or null
for none
- See Also:
#encodeLabelFingerprint()
-
encodeLabelFingerprint
public Interconnect encodeLabelFingerprint(byte[] labelFingerprint)
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.
- Since:
- 1.14
- See Also:
The value is encoded Base64 or {@code null} for none.
-
getLabels
public Map<String,String> 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.
- Returns:
- value or
null
for none
-
setLabels
public Interconnect setLabels(Map<String,String> labels)
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.
- Parameters:
labels
- labels or null
for none
-
getLinkType
public 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(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 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(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 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(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 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(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 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(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 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(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 Integer getProvisionedLinkCount()
[Output Only] Number of links actually provisioned in this interconnect.
- Returns:
- value or
null
for none
-
setProvisionedLinkCount
public Interconnect setProvisionedLinkCount(Integer provisionedLinkCount)
[Output Only] Number of links actually provisioned in this interconnect.
- Parameters:
provisionedLinkCount
- provisionedLinkCount or null
for none
-
getRequestedLinkCount
public 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(Integer requestedLinkCount)
Target number of physical links in the link bundle, as requested by the customer.
- Parameters:
requestedLinkCount
- requestedLinkCount or null
for none
-
getSatisfiesPzs
public Boolean getSatisfiesPzs()
[Output Only] Set to true if the resource satisfies the zone separation organization policy
constraints and false otherwise. Defaults to false if the field is not present.
- Returns:
- value or
null
for none
-
setSatisfiesPzs
public Interconnect setSatisfiesPzs(Boolean satisfiesPzs)
[Output Only] Set to true if the resource satisfies the zone separation organization policy
constraints and false otherwise. Defaults to false if the field is not present.
- Parameters:
satisfiesPzs
- satisfiesPzs or null
for none
-
getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
- Returns:
- value or
null
for none
-
setSelfLink
public Interconnect setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.
- Parameters:
selfLink
- selfLink or null
for none
-
getState
public 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(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(String fieldName,
Object value)
- Overrides:
set
in class GenericJson
-
clone
public Interconnect clone()
- Overrides:
clone
in class GenericJson
Copyright © 2011–2022 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy