Class Interconnect (1.52.0)

public final class Interconnect extends GeneratedMessageV3 implements InterconnectOrBuilder

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.

Protobuf type google.cloud.compute.v1.Interconnect

Static Fields

ADMIN_ENABLED_FIELD_NUMBER

public static final int ADMIN_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

AVAILABLE_FEATURES_FIELD_NUMBER

public static final int AVAILABLE_FEATURES_FIELD_NUMBER
Field Value
Type Description
int

CIRCUIT_INFOS_FIELD_NUMBER

public static final int CIRCUIT_INFOS_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

CUSTOMER_NAME_FIELD_NUMBER

public static final int CUSTOMER_NAME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXPECTED_OUTAGES_FIELD_NUMBER

public static final int EXPECTED_OUTAGES_FIELD_NUMBER
Field Value
Type Description
int

GOOGLE_IP_ADDRESS_FIELD_NUMBER

public static final int GOOGLE_IP_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

GOOGLE_REFERENCE_ID_FIELD_NUMBER

public static final int GOOGLE_REFERENCE_ID_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

INTERCONNECT_ATTACHMENTS_FIELD_NUMBER

public static final int INTERCONNECT_ATTACHMENTS_FIELD_NUMBER
Field Value
Type Description
int

INTERCONNECT_TYPE_FIELD_NUMBER

public static final int INTERCONNECT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FINGERPRINT_FIELD_NUMBER

public static final int LABEL_FINGERPRINT_FIELD_NUMBER
Field Value
Type Description
int
public static final int LINK_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

MACSEC_ENABLED_FIELD_NUMBER

public static final int MACSEC_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

MACSEC_FIELD_NUMBER

public static final int MACSEC_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NOC_CONTACT_EMAIL_FIELD_NUMBER

public static final int NOC_CONTACT_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

OPERATIONAL_STATUS_FIELD_NUMBER

public static final int OPERATIONAL_STATUS_FIELD_NUMBER
Field Value
Type Description
int

PEER_IP_ADDRESS_FIELD_NUMBER

public static final int PEER_IP_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int
public static final int PROVISIONED_LINK_COUNT_FIELD_NUMBER
Field Value
Type Description
int

REMOTE_LOCATION_FIELD_NUMBER

public static final int REMOTE_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

REQUESTED_FEATURES_FIELD_NUMBER

public static final int REQUESTED_FEATURES_FIELD_NUMBER
Field Value
Type Description
int
public static final int REQUESTED_LINK_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Interconnect getDefaultInstance()
Returns
Type Description
Interconnect

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Interconnect.Builder newBuilder()
Returns
Type Description
Interconnect.Builder

newBuilder(Interconnect prototype)

public static Interconnect.Builder newBuilder(Interconnect prototype)
Parameter
Name Description
prototype Interconnect
Returns
Type Description
Interconnect.Builder

parseDelimitedFrom(InputStream input)

public static Interconnect parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Interconnect
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Interconnect parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Interconnect
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Interconnect parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Interconnect
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Interconnect parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Interconnect
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Interconnect parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Interconnect
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Interconnect parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Interconnect
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Interconnect parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Interconnect
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Interconnect parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Interconnect
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Interconnect parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Interconnect
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Interconnect parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Interconnect
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Interconnect parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Interconnect
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Interconnect parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Interconnect
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Interconnect> parser()
Returns
Type Description
Parser<Interconnect>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

optional bool admin_enabled = 445675089;

Returns
Type Description
boolean

The adminEnabled.

getAvailableFeatures(int index)

public String getAvailableFeatures(int index)

[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. Check the AvailableFeatures enum for the list of possible values.

repeated string available_features = 496344307;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The availableFeatures at the given index.

getAvailableFeaturesBytes(int index)

public ByteString getAvailableFeaturesBytes(int index)

[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. Check the AvailableFeatures enum for the list of possible values.

repeated string available_features = 496344307;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the availableFeatures at the given index.

getAvailableFeaturesCount()

public int getAvailableFeaturesCount()

[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. Check the AvailableFeatures enum for the list of possible values.

repeated string available_features = 496344307;

Returns
Type Description
int

The count of availableFeatures.

getAvailableFeaturesList()

public ProtocolStringList getAvailableFeaturesList()

[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. Check the AvailableFeatures enum for the list of possible values.

repeated string available_features = 496344307;

Returns
Type Description
ProtocolStringList

A list containing the availableFeatures.

getCircuitInfos(int index)

public InterconnectCircuitInfo getCircuitInfos(int index)

[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

repeated .google.cloud.compute.v1.InterconnectCircuitInfo circuit_infos = 164839855;

Parameter
Name Description
index int
Returns
Type Description
InterconnectCircuitInfo

getCircuitInfosCount()

public int getCircuitInfosCount()

[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

repeated .google.cloud.compute.v1.InterconnectCircuitInfo circuit_infos = 164839855;

Returns
Type Description
int

getCircuitInfosList()

public List<InterconnectCircuitInfo> getCircuitInfosList()

[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

repeated .google.cloud.compute.v1.InterconnectCircuitInfo circuit_infos = 164839855;

Returns
Type Description
List<InterconnectCircuitInfo>

getCircuitInfosOrBuilder(int index)

public InterconnectCircuitInfoOrBuilder getCircuitInfosOrBuilder(int index)

[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

repeated .google.cloud.compute.v1.InterconnectCircuitInfo circuit_infos = 164839855;

Parameter
Name Description
index int
Returns
Type Description
InterconnectCircuitInfoOrBuilder

getCircuitInfosOrBuilderList()

public List<? extends InterconnectCircuitInfoOrBuilder> getCircuitInfosOrBuilderList()

[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.

repeated .google.cloud.compute.v1.InterconnectCircuitInfo circuit_infos = 164839855;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.InterconnectCircuitInfoOrBuilder>

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getCustomerName()

public String getCustomerName()

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

optional string customer_name = 3665484;

Returns
Type Description
String

The customerName.

getCustomerNameBytes()

public ByteString getCustomerNameBytes()

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

optional string customer_name = 3665484;

Returns
Type Description
ByteString

The bytes for customerName.

getDefaultInstanceForType()

public Interconnect getDefaultInstanceForType()
Returns
Type Description
Interconnect

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getExpectedOutages(int index)

public InterconnectOutageNotification getExpectedOutages(int index)

[Output Only] A list of outages expected for this Interconnect.

repeated .google.cloud.compute.v1.InterconnectOutageNotification expected_outages = 264484123;

Parameter
Name Description
index int
Returns
Type Description
InterconnectOutageNotification

getExpectedOutagesCount()

public int getExpectedOutagesCount()

[Output Only] A list of outages expected for this Interconnect.

repeated .google.cloud.compute.v1.InterconnectOutageNotification expected_outages = 264484123;

Returns
Type Description
int

getExpectedOutagesList()

public List<InterconnectOutageNotification> getExpectedOutagesList()

[Output Only] A list of outages expected for this Interconnect.

repeated .google.cloud.compute.v1.InterconnectOutageNotification expected_outages = 264484123;

Returns
Type Description
List<InterconnectOutageNotification>

getExpectedOutagesOrBuilder(int index)

public InterconnectOutageNotificationOrBuilder getExpectedOutagesOrBuilder(int index)

[Output Only] A list of outages expected for this Interconnect.

repeated .google.cloud.compute.v1.InterconnectOutageNotification expected_outages = 264484123;

Parameter
Name Description
index int
Returns
Type Description
InterconnectOutageNotificationOrBuilder

getExpectedOutagesOrBuilderList()

public List<? extends InterconnectOutageNotificationOrBuilder> getExpectedOutagesOrBuilderList()

[Output Only] A list of outages expected for this Interconnect.

repeated .google.cloud.compute.v1.InterconnectOutageNotification expected_outages = 264484123;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.InterconnectOutageNotificationOrBuilder>

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.

optional string google_ip_address = 443105954;

Returns
Type Description
String

The googleIpAddress.

getGoogleIpAddressBytes()

public ByteString getGoogleIpAddressBytes()

[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

optional string google_ip_address = 443105954;

Returns
Type Description
ByteString

The bytes for googleIpAddress.

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.

optional string google_reference_id = 534944469;

Returns
Type Description
String

The googleReferenceId.

getGoogleReferenceIdBytes()

public ByteString getGoogleReferenceIdBytes()

[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

optional string google_reference_id = 534944469;

Returns
Type Description
ByteString

The bytes for googleReferenceId.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getInterconnectAttachments(int index)

public String getInterconnectAttachments(int index)

[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

repeated string interconnect_attachments = 425388415;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The interconnectAttachments at the given index.

getInterconnectAttachmentsBytes(int index)

public ByteString getInterconnectAttachmentsBytes(int index)

[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

repeated string interconnect_attachments = 425388415;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the interconnectAttachments at the given index.

getInterconnectAttachmentsCount()

public int getInterconnectAttachmentsCount()

[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

repeated string interconnect_attachments = 425388415;

Returns
Type Description
int

The count of interconnectAttachments.

getInterconnectAttachmentsList()

public ProtocolStringList getInterconnectAttachmentsList()

[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

repeated string interconnect_attachments = 425388415;

Returns
Type Description
ProtocolStringList

A list containing the interconnectAttachments.

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. Check the InterconnectType enum for the list of possible values.

optional string interconnect_type = 515165259;

Returns
Type Description
String

The interconnectType.

getInterconnectTypeBytes()

public ByteString getInterconnectTypeBytes()

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.

optional string interconnect_type = 515165259;

Returns
Type Description
ByteString

The bytes for interconnectType.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#interconnect for interconnects.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#interconnect for interconnects.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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.

map<string, string> labels = 500195327;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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.

map<string, string> labels = 500195327;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 500195327;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
String

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. Check the LinkType enum for the list of possible values.

optional string link_type = 523207775;

Returns
Type Description
String

The linkType.

getLinkTypeBytes()

public ByteString getLinkTypeBytes()

Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. Check the LinkType enum for the list of possible values.

optional string link_type = 523207775;

Returns
Type Description
ByteString

The bytes for linkType.

getLocation()

public String getLocation()

URL of the InterconnectLocation object that represents where this connection is to be provisioned.

optional string location = 290430901;

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

URL of the InterconnectLocation object that represents where this connection is to be provisioned.

optional string location = 290430901;

Returns
Type Description
ByteString

The bytes for location.

getMacsec()

public InterconnectMacsec getMacsec()

Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.

optional .google.cloud.compute.v1.InterconnectMacsec macsec = 528867490;

Returns
Type Description
InterconnectMacsec

The macsec.

getMacsecEnabled()

public boolean getMacsecEnabled()

Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.

optional bool macsec_enabled = 194203812;

Returns
Type Description
boolean

The macsecEnabled.

getMacsecOrBuilder()

public InterconnectMacsecOrBuilder getMacsecOrBuilder()

Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.

optional .google.cloud.compute.v1.InterconnectMacsec macsec = 528867490;

Returns
Type Description
InterconnectMacsecOrBuilder

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

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

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 Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.

optional string noc_contact_email = 14072832;

Returns
Type Description
String

The nocContactEmail.

getNocContactEmailBytes()

public ByteString getNocContactEmailBytes()

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.

optional string noc_contact_email = 14072832;

Returns
Type Description
ByteString

The bytes for nocContactEmail.

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. Check the OperationalStatus enum for the list of possible values.

optional string operational_status = 201070847;

Returns
Type Description
String

The operationalStatus.

getOperationalStatusBytes()

public ByteString getOperationalStatusBytes()

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

optional string operational_status = 201070847;

Returns
Type Description
ByteString

The bytes for operationalStatus.

getParserForType()

public Parser<Interconnect> getParserForType()
Returns
Type Description
Parser<Interconnect>
Overrides

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.

optional string peer_ip_address = 207735769;

Returns
Type Description
String

The peerIpAddress.

getPeerIpAddressBytes()

public ByteString getPeerIpAddressBytes()

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

optional string peer_ip_address = 207735769;

Returns
Type Description
ByteString

The bytes for peerIpAddress.

getProvisionedLinkCount()

public int getProvisionedLinkCount()

[Output Only] Number of links actually provisioned in this interconnect.

optional int32 provisioned_link_count = 410888565;

Returns
Type Description
int

The provisionedLinkCount.

getRemoteLocation()

public String 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.

optional string remote_location = 324388750;

Returns
Type Description
String

The remoteLocation.

getRemoteLocationBytes()

public ByteString getRemoteLocationBytes()

Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.

optional string remote_location = 324388750;

Returns
Type Description
ByteString

The bytes for remoteLocation.

getRequestedFeatures(int index)

public String getRequestedFeatures(int index)

Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. Check the RequestedFeatures enum for the list of possible values.

repeated string requested_features = 461240814;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The requestedFeatures at the given index.

getRequestedFeaturesBytes(int index)

public ByteString getRequestedFeaturesBytes(int index)

Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. Check the RequestedFeatures enum for the list of possible values.

repeated string requested_features = 461240814;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the requestedFeatures at the given index.

getRequestedFeaturesCount()

public int getRequestedFeaturesCount()

Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. Check the RequestedFeatures enum for the list of possible values.

repeated string requested_features = 461240814;

Returns
Type Description
int

The count of requestedFeatures.

getRequestedFeaturesList()

public ProtocolStringList getRequestedFeaturesList()

Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. Check the RequestedFeatures enum for the list of possible values.

repeated string requested_features = 461240814;

Returns
Type Description
ProtocolStringList

A list containing the requestedFeatures.

getRequestedLinkCount()

public int getRequestedLinkCount()

Target number of physical links in the link bundle, as requested by the customer.

optional int32 requested_link_count = 45051387;

Returns
Type Description
int

The requestedLinkCount.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

The satisfiesPzs.

public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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. Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
String

The state.

getStateBytes()

public ByteString getStateBytes()

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

optional string state = 109757585;

Returns
Type Description
ByteString

The bytes for state.

hasAdminEnabled()

public boolean hasAdminEnabled()

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.

optional bool admin_enabled = 445675089;

Returns
Type Description
boolean

Whether the adminEnabled field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasCustomerName()

public boolean hasCustomerName()

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

optional string customer_name = 3665484;

Returns
Type Description
boolean

Whether the customerName field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasGoogleIpAddress()

public boolean hasGoogleIpAddress()

[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

optional string google_ip_address = 443105954;

Returns
Type Description
boolean

Whether the googleIpAddress field is set.

hasGoogleReferenceId()

public boolean hasGoogleReferenceId()

[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

optional string google_reference_id = 534944469;

Returns
Type Description
boolean

Whether the googleReferenceId field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasInterconnectType()

public boolean hasInterconnectType()

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.

optional string interconnect_type = 515165259;

Returns
Type Description
boolean

Whether the interconnectType field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#interconnect for interconnects.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasLabelFingerprint()

public boolean hasLabelFingerprint()

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
boolean

Whether the labelFingerprint field is set.

hasLinkType()

public boolean hasLinkType()

Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. Check the LinkType enum for the list of possible values.

optional string link_type = 523207775;

Returns
Type Description
boolean

Whether the linkType field is set.

hasLocation()

public boolean hasLocation()

URL of the InterconnectLocation object that represents where this connection is to be provisioned.

optional string location = 290430901;

Returns
Type Description
boolean

Whether the location field is set.

hasMacsec()

public boolean hasMacsec()

Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.

optional .google.cloud.compute.v1.InterconnectMacsec macsec = 528867490;

Returns
Type Description
boolean

Whether the macsec field is set.

hasMacsecEnabled()

public boolean hasMacsecEnabled()

Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.

optional bool macsec_enabled = 194203812;

Returns
Type Description
boolean

Whether the macsecEnabled field is set.

hasName()

public boolean hasName()

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

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasNocContactEmail()

public boolean hasNocContactEmail()

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.

optional string noc_contact_email = 14072832;

Returns
Type Description
boolean

Whether the nocContactEmail field is set.

hasOperationalStatus()

public boolean hasOperationalStatus()

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

optional string operational_status = 201070847;

Returns
Type Description
boolean

Whether the operationalStatus field is set.

hasPeerIpAddress()

public boolean hasPeerIpAddress()

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

optional string peer_ip_address = 207735769;

Returns
Type Description
boolean

Whether the peerIpAddress field is set.

hasProvisionedLinkCount()

public boolean hasProvisionedLinkCount()

[Output Only] Number of links actually provisioned in this interconnect.

optional int32 provisioned_link_count = 410888565;

Returns
Type Description
boolean

Whether the provisionedLinkCount field is set.

hasRemoteLocation()

public boolean hasRemoteLocation()

Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.

optional string remote_location = 324388750;

Returns
Type Description
boolean

Whether the remoteLocation field is set.

hasRequestedLinkCount()

public boolean hasRequestedLinkCount()

Target number of physical links in the link bundle, as requested by the customer.

optional int32 requested_link_count = 45051387;

Returns
Type Description
boolean

Whether the requestedLinkCount field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasState()

public boolean hasState()

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

optional string state = 109757585;

Returns
Type Description
boolean

Whether the state field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Interconnect.Builder newBuilderForType()
Returns
Type Description
Interconnect.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Interconnect.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Interconnect.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Interconnect.Builder toBuilder()
Returns
Type Description
Interconnect.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException