Interface InterconnectOrBuilder (1.34.0)

public interface InterconnectOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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`

getAdminEnabled()

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

getCircuitInfos(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
`String`	The creationTimestamp.

getCreationTimestampBytes()

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

getDescription()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> getInterconnectAttachmentsList()

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

repeated string interconnect_attachments = 425388415;

Returns
Type	Description
`List<String>`	A list containing the interconnectAttachments.

getInterconnectType()

public abstract 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 abstract ByteString getInterconnectTypeBytes()

optional string interconnect_type = 515165259;

Returns
Type	Description
`ByteString`	The bytes for interconnectType.

getKind()

public abstract 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 abstract 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 abstract 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 abstract ByteString getLabelFingerprintBytes()

optional string label_fingerprint = 178124825;

Returns
Type	Description
`ByteString`	The bytes for labelFingerprint.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ByteString getLinkTypeBytes()

optional string link_type = 523207775;

Returns
Type	Description
`ByteString`	The bytes for linkType.

getLocation()

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

getName()

public abstract 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 abstract ByteString getNameBytes()

optional string name = 3373707;

Returns
Type	Description
`ByteString`	The bytes for name.

getNocContactEmail()

public abstract 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 abstract ByteString getNocContactEmailBytes()

optional string noc_contact_email = 14072832;

Returns
Type	Description
`ByteString`	The bytes for nocContactEmail.

getOperationalStatus()

public abstract 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 abstract ByteString getOperationalStatusBytes()

optional string operational_status = 201070847;

Returns
Type	Description
`ByteString`	The bytes for operationalStatus.

getPeerIpAddress()

public abstract 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 abstract ByteString getPeerIpAddressBytes()

optional string peer_ip_address = 207735769;

Returns
Type	Description
`ByteString`	The bytes for peerIpAddress.

getProvisionedLinkCount()

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

getRequestedLinkCount()

public abstract 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 abstract boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type	Description
`boolean`	The satisfiesPzs.

getSelfLink()

public abstract String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type	Description
`String`	The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type	Description
`ByteString`	The bytes for selfLink.

getState()

public abstract 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 abstract ByteString getStateBytes()

optional string state = 109757585;

Returns
Type	Description
`ByteString`	The bytes for state.

hasAdminEnabled()

public abstract boolean hasAdminEnabled()

optional bool admin_enabled = 445675089;

Returns
Type	Description
`boolean`	Whether the adminEnabled field is set.

hasCreationTimestamp()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasInterconnectType()

optional string interconnect_type = 515165259;

Returns
Type	Description
`boolean`	Whether the interconnectType field is set.

hasKind()

public abstract 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 abstract boolean hasLabelFingerprint()

optional string label_fingerprint = 178124825;

Returns
Type	Description
`boolean`	Whether the labelFingerprint field is set.

hasLinkType()

public abstract boolean hasLinkType()

optional string link_type = 523207775;

Returns
Type	Description
`boolean`	Whether the linkType field is set.

hasLocation()

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

hasName()

public abstract boolean hasName()

optional string name = 3373707;

Returns
Type	Description
`boolean`	Whether the name field is set.

hasNocContactEmail()

public abstract boolean hasNocContactEmail()

optional string noc_contact_email = 14072832;

Returns
Type	Description
`boolean`	Whether the nocContactEmail field is set.

hasOperationalStatus()

public abstract boolean hasOperationalStatus()

optional string operational_status = 201070847;

Returns
Type	Description
`boolean`	Whether the operationalStatus field is set.

hasPeerIpAddress()

public abstract boolean hasPeerIpAddress()

optional string peer_ip_address = 207735769;

Returns
Type	Description
`boolean`	Whether the peerIpAddress field is set.

hasProvisionedLinkCount()

public abstract 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 abstract 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 abstract 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 abstract boolean hasSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type	Description
`boolean`	Whether the satisfiesPzs field is set.

hasSelfLink()

public abstract 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 abstract boolean hasState()

optional string state = 109757585;

Returns
Type	Description
`boolean`	Whether the state field is set.