InterconnectAttachment (Compute Engine API v1-rev20250810-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class InterconnectAttachment
extends com.google.api.client.json.GenericJson
```
Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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

Constructor Summary

Constructors
Constructor and Description

InterconnectAttachment()

Constructors
Constructor and Description
`InterconnectAttachment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InterconnectAttachment`	`clone()`
`byte[]`	`decodeLabelFingerprint()` A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking.
`InterconnectAttachment`	`encodeLabelFingerprint(byte[] labelFingerprint)` A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking.
`Boolean`	`getAdminEnabled()` Determines whether this Attachment will carry packets.
`String`	`getAttachmentGroup()` [Output Only] URL of the AttachmentGroup that includes this Attachment.
`String`	`getBandwidth()` Provisioned bandwidth capacity for the interconnect attachment.
`List<String>`	`getCandidateIpv6Subnets()` This field is not available.
`List<String>`	`getCandidateSubnets()` Input only.
`String`	`getCloudRouterIpAddress()` [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
`String`	`getCloudRouterIpv6Address()` [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
`String`	`getCloudRouterIpv6InterfaceId()` This field is not available.
`InterconnectAttachmentConfigurationConstraints`	`getConfigurationConstraints()` [Output Only] Constraints for this attachment, if any.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getCustomerRouterIpAddress()` [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
`String`	`getCustomerRouterIpv6Address()` [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
`String`	`getCustomerRouterIpv6InterfaceId()` This field is not available.
`Integer`	`getDataplaneVersion()` [Output Only] Dataplane version for this InterconnectAttachment.
`String`	`getDescription()` An optional description of this resource.
`String`	`getEdgeAvailabilityDomain()` Input only.
`String`	`getEncryption()` Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment).
`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.
`String`	`getInterconnect()` URL of the underlying Interconnect object that this attachment's traffic will traverse through.
`List<String>`	`getIpsecInternalAddresses()` A list of URLs of addresses that have been reserved for the VLAN attachment.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getLabelFingerprint()` A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking.
`Map<String,String>`	`getLabels()` Labels for this resource.
`Integer`	`getMtu()` Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment.
`String`	`getName()` Name of the resource.
`String`	`getOperationalStatus()` [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use.
`String`	`getPairingKey()` [Output only for type PARTNER.
`Long`	`getPartnerAsn()` Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer.
`InterconnectAttachmentPartnerMetadata`	`getPartnerMetadata()` Informational metadata about Partner attachments from Partners to display to customers.
`InterconnectAttachmentPrivateInfo`	`getPrivateInterconnectInfo()` [Output Only] Information specific to an InterconnectAttachment.
`String`	`getRegion()` [Output Only] URL of the region where the regional interconnect attachment resides.
`String`	`getRemoteService()` [Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider.
`String`	`getRouter()` URL of the Cloud Router to be used for dynamic routing.
`Boolean`	`getSatisfiesPzs()` [Output Only] Reserved for future use.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getStackType()` The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not.
`String`	`getState()` [Output Only] The current state of this attachment's functionality.
`Integer`	`getSubnetLength()` Input only.
`String`	`getType()` The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect.
`Integer`	`getVlanTag8021q()` The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
`InterconnectAttachment`	`set(String fieldName, Object value)`
`InterconnectAttachment`	`setAdminEnabled(Boolean adminEnabled)` Determines whether this Attachment will carry packets.
`InterconnectAttachment`	`setAttachmentGroup(String attachmentGroup)` [Output Only] URL of the AttachmentGroup that includes this Attachment.
`InterconnectAttachment`	`setBandwidth(String bandwidth)` Provisioned bandwidth capacity for the interconnect attachment.
`InterconnectAttachment`	`setCandidateIpv6Subnets(List<String> candidateIpv6Subnets)` This field is not available.
`InterconnectAttachment`	`setCandidateSubnets(List<String> candidateSubnets)` Input only.
`InterconnectAttachment`	`setCloudRouterIpAddress(String cloudRouterIpAddress)` [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
`InterconnectAttachment`	`setCloudRouterIpv6Address(String cloudRouterIpv6Address)` [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
`InterconnectAttachment`	`setCloudRouterIpv6InterfaceId(String cloudRouterIpv6InterfaceId)` This field is not available.
`InterconnectAttachment`	`setConfigurationConstraints(InterconnectAttachmentConfigurationConstraints configurationConstraints)` [Output Only] Constraints for this attachment, if any.
`InterconnectAttachment`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`InterconnectAttachment`	`setCustomerRouterIpAddress(String customerRouterIpAddress)` [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
`InterconnectAttachment`	`setCustomerRouterIpv6Address(String customerRouterIpv6Address)` [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
`InterconnectAttachment`	`setCustomerRouterIpv6InterfaceId(String customerRouterIpv6InterfaceId)` This field is not available.
`InterconnectAttachment`	`setDataplaneVersion(Integer dataplaneVersion)` [Output Only] Dataplane version for this InterconnectAttachment.
`InterconnectAttachment`	`setDescription(String description)` An optional description of this resource.
`InterconnectAttachment`	`setEdgeAvailabilityDomain(String edgeAvailabilityDomain)` Input only.
`InterconnectAttachment`	`setEncryption(String encryption)` Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment).
`InterconnectAttachment`	`setGoogleReferenceId(String googleReferenceId)` [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
`InterconnectAttachment`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`InterconnectAttachment`	`setInterconnect(String interconnect)` URL of the underlying Interconnect object that this attachment's traffic will traverse through.
`InterconnectAttachment`	`setIpsecInternalAddresses(List<String> ipsecInternalAddresses)` A list of URLs of addresses that have been reserved for the VLAN attachment.
`InterconnectAttachment`	`setKind(String kind)` [Output Only] Type of the resource.
`InterconnectAttachment`	`setLabelFingerprint(String labelFingerprint)` A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking.
`InterconnectAttachment`	`setLabels(Map<String,String> labels)` Labels for this resource.
`InterconnectAttachment`	`setMtu(Integer mtu)` Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment.
`InterconnectAttachment`	`setName(String name)` Name of the resource.
`InterconnectAttachment`	`setOperationalStatus(String operationalStatus)` [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use.
`InterconnectAttachment`	`setPairingKey(String pairingKey)` [Output only for type PARTNER.
`InterconnectAttachment`	`setPartnerAsn(Long partnerAsn)` Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer.
`InterconnectAttachment`	`setPartnerMetadata(InterconnectAttachmentPartnerMetadata partnerMetadata)` Informational metadata about Partner attachments from Partners to display to customers.
`InterconnectAttachment`	`setPrivateInterconnectInfo(InterconnectAttachmentPrivateInfo privateInterconnectInfo)` [Output Only] Information specific to an InterconnectAttachment.
`InterconnectAttachment`	`setRegion(String region)` [Output Only] URL of the region where the regional interconnect attachment resides.
`InterconnectAttachment`	`setRemoteService(String remoteService)` [Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider.
`InterconnectAttachment`	`setRouter(String router)` URL of the Cloud Router to be used for dynamic routing.
`InterconnectAttachment`	`setSatisfiesPzs(Boolean satisfiesPzs)` [Output Only] Reserved for future use.
`InterconnectAttachment`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`InterconnectAttachment`	`setStackType(String stackType)` The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not.
`InterconnectAttachment`	`setState(String state)` [Output Only] The current state of this attachment's functionality.
`InterconnectAttachment`	`setSubnetLength(Integer subnetLength)` Input only.
`InterconnectAttachment`	`setType(String type)` The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect.
`InterconnectAttachment`	`setVlanTag8021q(Integer vlanTag8021q)` The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.

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

- Constructor Detail
  - InterconnectAttachment
```
public InterconnectAttachment()
```
- Method Detail
  - getAdminEnabled
```
public Boolean getAdminEnabled()
```
    Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
    
    Returns:
    
    value or null for none
  - setAdminEnabled
```
public InterconnectAttachment setAdminEnabled(Boolean adminEnabled)
```
    Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
    
    Parameters:
    
    adminEnabled - adminEnabled or null for none
  - getAttachmentGroup
```
public String getAttachmentGroup()
```
    [Output Only] URL of the AttachmentGroup that includes this Attachment.
    
    Returns:
    
    value or null for none
  - setAttachmentGroup
```
public InterconnectAttachment setAttachmentGroup(String attachmentGroup)
```
    [Output Only] URL of the AttachmentGroup that includes this Attachment.
    
    Parameters:
    
    attachmentGroup - attachmentGroup or null for none
  - getBandwidth
```
public String getBandwidth()
```
    Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s
    
    Returns:
    
    value or null for none
  - setBandwidth
```
public InterconnectAttachment setBandwidth(String bandwidth)
```
    Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s
    
    Parameters:
    
    bandwidth - bandwidth or null for none
  - getCandidateIpv6Subnets
```
public List<String> getCandidateIpv6Subnets()
```
    This field is not available.
    
    Returns:
    
    value or null for none
  - setCandidateIpv6Subnets
```
public InterconnectAttachment setCandidateIpv6Subnets(List<String> candidateIpv6Subnets)
```
    This field is not available.
    
    Parameters:
    
    candidateIpv6Subnets - candidateIpv6Subnets or null for none
  - getCandidateSubnets
```
public List<String> getCandidateSubnets()
```
    Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
    
    Returns:
    
    value or null for none
  - setCandidateSubnets
```
public InterconnectAttachment setCandidateSubnets(List<String> candidateSubnets)
```
    Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
    
    Parameters:
    
    candidateSubnets - candidateSubnets or null for none
  - getCloudRouterIpAddress
```
public String getCloudRouterIpAddress()
```
    [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
    
    Returns:
    
    value or null for none
  - setCloudRouterIpAddress
```
public InterconnectAttachment setCloudRouterIpAddress(String cloudRouterIpAddress)
```
    [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
    
    Parameters:
    
    cloudRouterIpAddress - cloudRouterIpAddress or null for none
  - getCloudRouterIpv6Address
```
public String getCloudRouterIpv6Address()
```
    [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
    
    Returns:
    
    value or null for none
  - setCloudRouterIpv6Address
```
public InterconnectAttachment setCloudRouterIpv6Address(String cloudRouterIpv6Address)
```
    [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
    
    Parameters:
    
    cloudRouterIpv6Address - cloudRouterIpv6Address or null for none
  - getCloudRouterIpv6InterfaceId
```
public String getCloudRouterIpv6InterfaceId()
```
    This field is not available.
    
    Returns:
    
    value or null for none
  - setCloudRouterIpv6InterfaceId
```
public InterconnectAttachment setCloudRouterIpv6InterfaceId(String cloudRouterIpv6InterfaceId)
```
    This field is not available.
    
    Parameters:
    
    cloudRouterIpv6InterfaceId - cloudRouterIpv6InterfaceId or null for none
  - getConfigurationConstraints
```
public InterconnectAttachmentConfigurationConstraints getConfigurationConstraints()
```
    [Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.
    
    Returns:
    
    value or null for none
  - setConfigurationConstraints
```
public InterconnectAttachment setConfigurationConstraints(InterconnectAttachmentConfigurationConstraints configurationConstraints)
```
    [Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.
    
    Parameters:
    
    configurationConstraints - configurationConstraints or null for none
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public InterconnectAttachment setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getCustomerRouterIpAddress
```
public String getCustomerRouterIpAddress()
```
    [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
    
    Returns:
    
    value or null for none
  - setCustomerRouterIpAddress
```
public InterconnectAttachment setCustomerRouterIpAddress(String customerRouterIpAddress)
```
    [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
    
    Parameters:
    
    customerRouterIpAddress - customerRouterIpAddress or null for none
  - getCustomerRouterIpv6Address
```
public String getCustomerRouterIpv6Address()
```
    [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
    
    Returns:
    
    value or null for none
  - setCustomerRouterIpv6Address
```
public InterconnectAttachment setCustomerRouterIpv6Address(String customerRouterIpv6Address)
```
    [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
    
    Parameters:
    
    customerRouterIpv6Address - customerRouterIpv6Address or null for none
  - getCustomerRouterIpv6InterfaceId
```
public String getCustomerRouterIpv6InterfaceId()
```
    This field is not available.
    
    Returns:
    
    value or null for none
  - setCustomerRouterIpv6InterfaceId
```
public InterconnectAttachment setCustomerRouterIpv6InterfaceId(String customerRouterIpv6InterfaceId)
```
    This field is not available.
    
    Parameters:
    
    customerRouterIpv6InterfaceId - customerRouterIpv6InterfaceId or null for none
  - getDataplaneVersion
```
public Integer getDataplaneVersion()
```
    [Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.
    
    Returns:
    
    value or null for none
  - setDataplaneVersion
```
public InterconnectAttachment setDataplaneVersion(Integer dataplaneVersion)
```
    [Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.
    
    Parameters:
    
    dataplaneVersion - dataplaneVersion or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public InterconnectAttachment setDescription(String description)
```
    An optional description of this resource.
    
    Parameters:
    
    description - description or null for none
  - getEdgeAvailabilityDomain
```
public String getEdgeAvailabilityDomain()
```
    Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
    
    Returns:
    
    value or null for none
  - setEdgeAvailabilityDomain
```
public InterconnectAttachment setEdgeAvailabilityDomain(String edgeAvailabilityDomain)
```
    Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
    
    Parameters:
    
    edgeAvailabilityDomain - edgeAvailabilityDomain or null for none
  - getEncryption
```
public String getEncryption()
```
    Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option.
    
    Returns:
    
    value or null for none
  - setEncryption
```
public InterconnectAttachment setEncryption(String encryption)
```
    Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option.
    
    Parameters:
    
    encryption - encryption 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. [Deprecated] This field is not used.
    
    Returns:
    
    value or null for none
  - setGoogleReferenceId
```
public InterconnectAttachment setGoogleReferenceId(String googleReferenceId)
```
    [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
    
    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 InterconnectAttachment 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
  - getInterconnect
```
public String getInterconnect()
```
    URL of the underlying Interconnect object that this attachment's traffic will traverse through.
    
    Returns:
    
    value or null for none
  - setInterconnect
```
public InterconnectAttachment setInterconnect(String interconnect)
```
    URL of the underlying Interconnect object that this attachment's traffic will traverse through.
    
    Parameters:
    
    interconnect - interconnect or null for none
  - getIpsecInternalAddresses
```
public List<String> getIpsecInternalAddresses()
```
    A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.
    
    Returns:
    
    value or null for none
  - setIpsecInternalAddresses
```
public InterconnectAttachment setIpsecInternalAddresses(List<String> ipsecInternalAddresses)
```
    A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.
    
    Parameters:
    
    ipsecInternalAddresses - ipsecInternalAddresses or null for none
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
    
    Returns:
    
    value or null for none
  - setKind
```
public InterconnectAttachment setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
    
    Parameters:
    
    kind - kind or null for none
  - getLabelFingerprint
```
public String getLabelFingerprint()
```
    A fingerprint for the labels being applied to this InterconnectAttachment, 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 InterconnectAttachment.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeLabelFingerprint()
  - decodeLabelFingerprint
```
public byte[] decodeLabelFingerprint()
```
    A fingerprint for the labels being applied to this InterconnectAttachment, 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 InterconnectAttachment.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getLabelFingerprint()
  - setLabelFingerprint
```
public InterconnectAttachment setLabelFingerprint(String labelFingerprint)
```
    A fingerprint for the labels being applied to this InterconnectAttachment, 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 InterconnectAttachment.
    
    Parameters:
    
    labelFingerprint - labelFingerprint or null for none
    
    See Also:
    
    #encodeLabelFingerprint()
  - encodeLabelFingerprint
```
public InterconnectAttachment encodeLabelFingerprint(byte[] labelFingerprint)
```
    A fingerprint for the labels being applied to this InterconnectAttachment, 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 InterconnectAttachment.
    
    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 InterconnectAttachment 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
  - getMtu
```
public Integer getMtu()
```
    Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.
    
    Returns:
    
    value or null for none
  - setMtu
```
public InterconnectAttachment setMtu(Integer mtu)
```
    Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.
    
    Parameters:
    
    mtu - mtu 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 InterconnectAttachment 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
  - getOperationalStatus
```
public String getOperationalStatus()
```
    [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
    
    Returns:
    
    value or null for none
  - setOperationalStatus
```
public InterconnectAttachment setOperationalStatus(String operationalStatus)
```
    [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
    
    Parameters:
    
    operationalStatus - operationalStatus or null for none
  - getPairingKey
```
public String getPairingKey()
```
    [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"
    
    Returns:
    
    value or null for none
  - setPairingKey
```
public InterconnectAttachment setPairingKey(String pairingKey)
```
    [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"
    
    Parameters:
    
    pairingKey - pairingKey or null for none
  - getPartnerAsn
```
public Long getPartnerAsn()
```
    Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
    
    Returns:
    
    value or null for none
  - setPartnerAsn
```
public InterconnectAttachment setPartnerAsn(Long partnerAsn)
```
    Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
    
    Parameters:
    
    partnerAsn - partnerAsn or null for none
  - getPartnerMetadata
```
public InterconnectAttachmentPartnerMetadata getPartnerMetadata()
```
    Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
    
    Returns:
    
    value or null for none
  - setPartnerMetadata
```
public InterconnectAttachment setPartnerMetadata(InterconnectAttachmentPartnerMetadata partnerMetadata)
```
    Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
    
    Parameters:
    
    partnerMetadata - partnerMetadata or null for none
  - getPrivateInterconnectInfo
```
public InterconnectAttachmentPrivateInfo getPrivateInterconnectInfo()
```
    [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
    
    Returns:
    
    value or null for none
  - setPrivateInterconnectInfo
```
public InterconnectAttachment setPrivateInterconnectInfo(InterconnectAttachmentPrivateInfo privateInterconnectInfo)
```
    [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
    
    Parameters:
    
    privateInterconnectInfo - privateInterconnectInfo or null for none
  - getRegion
```
public String getRegion()
```
    [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    
    Returns:
    
    value or null for none
  - setRegion
```
public InterconnectAttachment setRegion(String region)
```
    [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    
    Parameters:
    
    region - region or null for none
  - getRemoteService
```
public String getRemoteService()
```
    [Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: "Amazon Web Services" "Microsoft Azure". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field.
    
    Returns:
    
    value or null for none
  - setRemoteService
```
public InterconnectAttachment setRemoteService(String remoteService)
```
    [Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: "Amazon Web Services" "Microsoft Azure". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field.
    
    Parameters:
    
    remoteService - remoteService or null for none
  - getRouter
```
public String getRouter()
```
    URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.
    
    Returns:
    
    value or null for none
  - setRouter
```
public InterconnectAttachment setRouter(String router)
```
    URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.
    
    Parameters:
    
    router - router or null for none
  - getSatisfiesPzs
```
public Boolean getSatisfiesPzs()
```
    [Output Only] Reserved for future use.
    
    Returns:
    
    value or null for none
  - setSatisfiesPzs
```
public InterconnectAttachment setSatisfiesPzs(Boolean satisfiesPzs)
```
    [Output Only] Reserved for future use.
    
    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 InterconnectAttachment setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getStackType
```
public String getStackType()
```
    The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.
    
    Returns:
    
    value or null for none
  - setStackType
```
public InterconnectAttachment setStackType(String stackType)
```
    The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.
    
    Parameters:
    
    stackType - stackType or null for none
  - getState
```
public String getState()
```
    [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
    
    Returns:
    
    value or null for none
  - setState
```
public InterconnectAttachment setState(String state)
```
    [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
    
    Parameters:
    
    state - state or null for none
  - getSubnetLength
```
public Integer getSubnetLength()
```
    Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.
    
    Returns:
    
    value or null for none
  - setSubnetLength
```
public InterconnectAttachment setSubnetLength(Integer subnetLength)
```
    Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.
    
    Parameters:
    
    subnetLength - subnetLength or null for none
  - getType
```
public String getType()
```
    The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
    
    Returns:
    
    value or null for none
  - setType
```
public InterconnectAttachment setType(String type)
```
    The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
    
    Parameters:
    
    type - type or null for none
  - getVlanTag8021q
```
public Integer getVlanTag8021q()
```
    The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.
    
    Returns:
    
    value or null for none
  - setVlanTag8021q
```
public InterconnectAttachment setVlanTag8021q(Integer vlanTag8021q)
```
    The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.
    
    Parameters:
    
    vlanTag8021q - vlanTag8021q or null for none
  - set
```
public InterconnectAttachment set(String fieldName,
                                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public InterconnectAttachment clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class InterconnectAttachment

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

InterconnectAttachment

Method Detail

getAdminEnabled

setAdminEnabled

getAttachmentGroup

setAttachmentGroup

getBandwidth

setBandwidth

getCandidateIpv6Subnets

setCandidateIpv6Subnets

getCandidateSubnets

setCandidateSubnets

getCloudRouterIpAddress

setCloudRouterIpAddress

getCloudRouterIpv6Address

setCloudRouterIpv6Address

getCloudRouterIpv6InterfaceId

setCloudRouterIpv6InterfaceId

getConfigurationConstraints

setConfigurationConstraints

getCreationTimestamp

setCreationTimestamp

getCustomerRouterIpAddress

setCustomerRouterIpAddress

getCustomerRouterIpv6Address

setCustomerRouterIpv6Address

getCustomerRouterIpv6InterfaceId

setCustomerRouterIpv6InterfaceId

getDataplaneVersion

setDataplaneVersion

getDescription

setDescription

getEdgeAvailabilityDomain

setEdgeAvailabilityDomain

getEncryption

setEncryption

getGoogleReferenceId

setGoogleReferenceId

getId

setId

getInterconnect

setInterconnect

getIpsecInternalAddresses

setIpsecInternalAddresses

getKind

setKind

getLabelFingerprint

decodeLabelFingerprint

setLabelFingerprint

encodeLabelFingerprint

getLabels

setLabels

getMtu

setMtu

getName

setName

getOperationalStatus

setOperationalStatus

getPairingKey

setPairingKey

getPartnerAsn

setPartnerAsn

getPartnerMetadata

setPartnerMetadata

getPrivateInterconnectInfo

setPrivateInterconnectInfo

getRegion