Class InterconnectAttachment.Builder (1.53.0) 

public static final class InterconnectAttachment.Builder extends GeneratedMessageV3.Builder<InterconnectAttachment.Builder> implements InterconnectAttachmentOrBuilder

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.

Protobuf type google.cloud.compute.v1.InterconnectAttachment

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > InterconnectAttachment.Builder

Static Methods

getDescriptor()

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

Methods

addAllCandidateIpv6Subnets(Iterable<String> values)

public InterconnectAttachment.Builder addAllCandidateIpv6Subnets(Iterable<String> values)

This field is not available.

repeated string candidate_ipv6_subnets = 70682522;

Parameter
Name Description
values Iterable<String>

The candidateIpv6Subnets to add.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

addAllCandidateSubnets(Iterable<String> values)

public InterconnectAttachment.Builder addAllCandidateSubnets(Iterable<String> values)

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.

repeated string candidate_subnets = 237842938;

Parameter
Name Description
values Iterable<String>

The candidateSubnets to add.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

addAllIpsecInternalAddresses(Iterable<String> values)

public InterconnectAttachment.Builder addAllIpsecInternalAddresses(Iterable<String> values)

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.

repeated string ipsec_internal_addresses = 407648565;

Parameter
Name Description
values Iterable<String>

The ipsecInternalAddresses to add.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

addCandidateIpv6Subnets(String value)

public InterconnectAttachment.Builder addCandidateIpv6Subnets(String value)

This field is not available.

repeated string candidate_ipv6_subnets = 70682522;

Parameter
Name Description
value String

The candidateIpv6Subnets to add.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

addCandidateIpv6SubnetsBytes(ByteString value)

public InterconnectAttachment.Builder addCandidateIpv6SubnetsBytes(ByteString value)

This field is not available.

repeated string candidate_ipv6_subnets = 70682522;

Parameter
Name Description
value ByteString

The bytes of the candidateIpv6Subnets to add.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

addCandidateSubnets(String value)

public InterconnectAttachment.Builder addCandidateSubnets(String value)

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.

repeated string candidate_subnets = 237842938;

Parameter
Name Description
value String

The candidateSubnets to add.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

addCandidateSubnetsBytes(ByteString value)

public InterconnectAttachment.Builder addCandidateSubnetsBytes(ByteString value)

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.

repeated string candidate_subnets = 237842938;

Parameter
Name Description
value ByteString

The bytes of the candidateSubnets to add.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

addIpsecInternalAddresses(String value)

public InterconnectAttachment.Builder addIpsecInternalAddresses(String value)

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.

repeated string ipsec_internal_addresses = 407648565;

Parameter
Name Description
value String

The ipsecInternalAddresses to add.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

addIpsecInternalAddressesBytes(ByteString value)

public InterconnectAttachment.Builder addIpsecInternalAddressesBytes(ByteString value)

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.

repeated string ipsec_internal_addresses = 407648565;

Parameter
Name Description
value ByteString

The bytes of the ipsecInternalAddresses to add.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InterconnectAttachment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InterconnectAttachment.Builder
Overrides

build()

public InterconnectAttachment build()
Returns
Type Description
InterconnectAttachment

buildPartial()

public InterconnectAttachment buildPartial()
Returns
Type Description
InterconnectAttachment

clear()

public InterconnectAttachment.Builder clear()
Returns
Type Description
InterconnectAttachment.Builder
Overrides

clearAdminEnabled()

public InterconnectAttachment.Builder clearAdminEnabled()

Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

optional bool admin_enabled = 445675089;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearBandwidth()

public InterconnectAttachment.Builder clearBandwidth()

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

optional string bandwidth = 181715121;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearCandidateIpv6Subnets()

public InterconnectAttachment.Builder clearCandidateIpv6Subnets()

This field is not available.

repeated string candidate_ipv6_subnets = 70682522;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearCandidateSubnets()

public InterconnectAttachment.Builder clearCandidateSubnets()

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.

repeated string candidate_subnets = 237842938;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearCloudRouterIpAddress()

public InterconnectAttachment.Builder clearCloudRouterIpAddress()

[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ip_address = 287392776;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearCloudRouterIpv6Address()

public InterconnectAttachment.Builder clearCloudRouterIpv6Address()

[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ipv6_address = 451922376;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearCloudRouterIpv6InterfaceId()

public InterconnectAttachment.Builder clearCloudRouterIpv6InterfaceId()

This field is not available.

optional string cloud_router_ipv6_interface_id = 521282701;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearConfigurationConstraints()

public InterconnectAttachment.Builder clearConfigurationConstraints()

[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

optional .google.cloud.compute.v1.InterconnectAttachmentConfigurationConstraints configuration_constraints = 179681389;

Returns
Type Description
InterconnectAttachment.Builder

clearCreationTimestamp()

public InterconnectAttachment.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearCustomerRouterIpAddress()

public InterconnectAttachment.Builder clearCustomerRouterIpAddress()

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ip_address = 332475761;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearCustomerRouterIpv6Address()

public InterconnectAttachment.Builder clearCustomerRouterIpv6Address()

[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ipv6_address = 290127089;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearCustomerRouterIpv6InterfaceId()

public InterconnectAttachment.Builder clearCustomerRouterIpv6InterfaceId()

This field is not available.

optional string customer_router_ipv6_interface_id = 380994308;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearDataplaneVersion()

public InterconnectAttachment.Builder clearDataplaneVersion()

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

optional int32 dataplane_version = 34920075;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearDescription()

public InterconnectAttachment.Builder clearDescription()

An optional description of this resource.

optional string description = 422937596;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearEdgeAvailabilityDomain()

public InterconnectAttachment.Builder clearEdgeAvailabilityDomain()

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

optional string edge_availability_domain = 71289510;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearEncryption()

public InterconnectAttachment.Builder clearEncryption()

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

optional string encryption = 97980291;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public InterconnectAttachment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
InterconnectAttachment.Builder
Overrides

clearGoogleReferenceId()

public InterconnectAttachment.Builder clearGoogleReferenceId()

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

optional string google_reference_id = 534944469;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearId()

public InterconnectAttachment.Builder clearId()

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

optional uint64 id = 3355;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearInterconnect()

public InterconnectAttachment.Builder clearInterconnect()

URL of the underlying Interconnect object that this attachment's traffic will traverse through.

optional string interconnect = 224601230;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearIpsecInternalAddresses()

public InterconnectAttachment.Builder clearIpsecInternalAddresses()

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.

repeated string ipsec_internal_addresses = 407648565;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearKind()

public InterconnectAttachment.Builder clearKind()

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

optional string kind = 3292052;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearLabelFingerprint()

public InterconnectAttachment.Builder clearLabelFingerprint()

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearLabels()

public InterconnectAttachment.Builder clearLabels()
Returns
Type Description
InterconnectAttachment.Builder

clearMtu()

public InterconnectAttachment.Builder clearMtu()

Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

optional int32 mtu = 108462;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearName()

public InterconnectAttachment.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public InterconnectAttachment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
InterconnectAttachment.Builder
Overrides

clearOperationalStatus()

public InterconnectAttachment.Builder clearOperationalStatus()

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

optional string operational_status = 201070847;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearPairingKey()

public InterconnectAttachment.Builder clearPairingKey()

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

optional string pairing_key = 439695464;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearPartnerAsn()

public InterconnectAttachment.Builder clearPartnerAsn()

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.

optional int64 partner_asn = 438166149;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearPartnerMetadata()

public InterconnectAttachment.Builder clearPartnerMetadata()

Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPartnerMetadata partner_metadata = 65908934;

Returns
Type Description
InterconnectAttachment.Builder

clearPrivateInterconnectInfo()

public InterconnectAttachment.Builder clearPrivateInterconnectInfo()

[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPrivateInfo private_interconnect_info = 237270531;

Returns
Type Description
InterconnectAttachment.Builder

clearRegion()

public InterconnectAttachment.Builder clearRegion()

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

optional string region = 138946292;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearRemoteService()

public InterconnectAttachment.Builder clearRemoteService()

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

optional string remote_service = 391954364;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearRouter()

public InterconnectAttachment.Builder clearRouter()

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.

optional string router = 148608841;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearSatisfiesPzs()

public InterconnectAttachment.Builder clearSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearSelfLink()

public InterconnectAttachment.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearStackType()

public InterconnectAttachment.Builder clearStackType()

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

optional string stack_type = 425908881;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearState()

public InterconnectAttachment.Builder clearState()

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

optional string state = 109757585;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearSubnetLength()

public InterconnectAttachment.Builder clearSubnetLength()

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.

optional int32 subnet_length = 279831048;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearType()

public InterconnectAttachment.Builder clearType()

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

optional string type = 3575610;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clearVlanTag8021Q()

public InterconnectAttachment.Builder clearVlanTag8021Q()

The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

optional int32 vlan_tag8021q = 119927836;

Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

clone()

public InterconnectAttachment.Builder clone()
Returns
Type Description
InterconnectAttachment.Builder
Overrides

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

getAdminEnabled()

public boolean getAdminEnabled()

Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

optional bool admin_enabled = 445675089;

Returns
Type Description
boolean

The adminEnabled.

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

optional string bandwidth = 181715121;

Returns
Type Description
String

The bandwidth.

getBandwidthBytes()

public ByteString getBandwidthBytes()

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

optional string bandwidth = 181715121;

Returns
Type Description
ByteString

The bytes for bandwidth.

getCandidateIpv6Subnets(int index)

public String getCandidateIpv6Subnets(int index)

This field is not available.

repeated string candidate_ipv6_subnets = 70682522;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The candidateIpv6Subnets at the given index.

getCandidateIpv6SubnetsBytes(int index)

public ByteString getCandidateIpv6SubnetsBytes(int index)

This field is not available.

repeated string candidate_ipv6_subnets = 70682522;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the candidateIpv6Subnets at the given index.

getCandidateIpv6SubnetsCount()

public int getCandidateIpv6SubnetsCount()

This field is not available.

repeated string candidate_ipv6_subnets = 70682522;

Returns
Type Description
int

The count of candidateIpv6Subnets.

getCandidateIpv6SubnetsList()

public ProtocolStringList getCandidateIpv6SubnetsList()

This field is not available.

repeated string candidate_ipv6_subnets = 70682522;

Returns
Type Description
ProtocolStringList

A list containing the candidateIpv6Subnets.

getCandidateSubnets(int index)

public String getCandidateSubnets(int index)

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.

repeated string candidate_subnets = 237842938;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The candidateSubnets at the given index.

getCandidateSubnetsBytes(int index)

public ByteString getCandidateSubnetsBytes(int index)

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.

repeated string candidate_subnets = 237842938;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the candidateSubnets at the given index.

getCandidateSubnetsCount()

public int getCandidateSubnetsCount()

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.

repeated string candidate_subnets = 237842938;

Returns
Type Description
int

The count of candidateSubnets.

getCandidateSubnetsList()

public ProtocolStringList getCandidateSubnetsList()

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.

repeated string candidate_subnets = 237842938;

Returns
Type Description
ProtocolStringList

A list containing the candidateSubnets.

getCloudRouterIpAddress()

public String getCloudRouterIpAddress()

[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ip_address = 287392776;

Returns
Type Description
String

The cloudRouterIpAddress.

getCloudRouterIpAddressBytes()

public ByteString getCloudRouterIpAddressBytes()

[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ip_address = 287392776;

Returns
Type Description
ByteString

The bytes for cloudRouterIpAddress.

getCloudRouterIpv6Address()

public String getCloudRouterIpv6Address()

[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ipv6_address = 451922376;

Returns
Type Description
String

The cloudRouterIpv6Address.

getCloudRouterIpv6AddressBytes()

public ByteString getCloudRouterIpv6AddressBytes()

[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ipv6_address = 451922376;

Returns
Type Description
ByteString

The bytes for cloudRouterIpv6Address.

getCloudRouterIpv6InterfaceId()

public String getCloudRouterIpv6InterfaceId()

This field is not available.

optional string cloud_router_ipv6_interface_id = 521282701;

Returns
Type Description
String

The cloudRouterIpv6InterfaceId.

getCloudRouterIpv6InterfaceIdBytes()

public ByteString getCloudRouterIpv6InterfaceIdBytes()

This field is not available.

optional string cloud_router_ipv6_interface_id = 521282701;

Returns
Type Description
ByteString

The bytes for cloudRouterIpv6InterfaceId.

getConfigurationConstraints()

public InterconnectAttachmentConfigurationConstraints getConfigurationConstraints()

[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

optional .google.cloud.compute.v1.InterconnectAttachmentConfigurationConstraints configuration_constraints = 179681389;

Returns
Type Description
InterconnectAttachmentConfigurationConstraints

The configurationConstraints.

getConfigurationConstraintsBuilder()

public InterconnectAttachmentConfigurationConstraints.Builder getConfigurationConstraintsBuilder()

[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

optional .google.cloud.compute.v1.InterconnectAttachmentConfigurationConstraints configuration_constraints = 179681389;

Returns
Type Description
InterconnectAttachmentConfigurationConstraints.Builder

getConfigurationConstraintsOrBuilder()

public InterconnectAttachmentConfigurationConstraintsOrBuilder getConfigurationConstraintsOrBuilder()

[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

optional .google.cloud.compute.v1.InterconnectAttachmentConfigurationConstraints configuration_constraints = 179681389;

Returns
Type Description
InterconnectAttachmentConfigurationConstraintsOrBuilder

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.

getCustomerRouterIpAddress()

public String getCustomerRouterIpAddress()

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ip_address = 332475761;

Returns
Type Description
String

The customerRouterIpAddress.

getCustomerRouterIpAddressBytes()

public ByteString getCustomerRouterIpAddressBytes()

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ip_address = 332475761;

Returns
Type Description
ByteString

The bytes for customerRouterIpAddress.

getCustomerRouterIpv6Address()

public String getCustomerRouterIpv6Address()

[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ipv6_address = 290127089;

Returns
Type Description
String

The customerRouterIpv6Address.

getCustomerRouterIpv6AddressBytes()

public ByteString getCustomerRouterIpv6AddressBytes()

[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ipv6_address = 290127089;

Returns
Type Description
ByteString

The bytes for customerRouterIpv6Address.

getCustomerRouterIpv6InterfaceId()

public String getCustomerRouterIpv6InterfaceId()

This field is not available.

optional string customer_router_ipv6_interface_id = 380994308;

Returns
Type Description
String

The customerRouterIpv6InterfaceId.

getCustomerRouterIpv6InterfaceIdBytes()

public ByteString getCustomerRouterIpv6InterfaceIdBytes()

This field is not available.

optional string customer_router_ipv6_interface_id = 380994308;

Returns
Type Description
ByteString

The bytes for customerRouterIpv6InterfaceId.

getDataplaneVersion()

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

optional int32 dataplane_version = 34920075;

Returns
Type Description
int

The dataplaneVersion.

getDefaultInstanceForType()

public InterconnectAttachment getDefaultInstanceForType()
Returns
Type Description
InterconnectAttachment

getDescription()

public String getDescription()

An optional description of this resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEdgeAvailabilityDomain()

public String getEdgeAvailabilityDomain()

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

optional string edge_availability_domain = 71289510;

Returns
Type Description
String

The edgeAvailabilityDomain.

getEdgeAvailabilityDomainBytes()

public ByteString getEdgeAvailabilityDomainBytes()

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

optional string edge_availability_domain = 71289510;

Returns
Type Description
ByteString

The bytes for edgeAvailabilityDomain.

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

optional string encryption = 97980291;

Returns
Type Description
String

The encryption.

getEncryptionBytes()

public ByteString getEncryptionBytes()

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

optional string encryption = 97980291;

Returns
Type Description
ByteString

The bytes for encryption.

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.

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. [Deprecated] This field is not used.

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.

getInterconnect()

public String getInterconnect()

URL of the underlying Interconnect object that this attachment's traffic will traverse through.

optional string interconnect = 224601230;

Returns
Type Description
String

The interconnect.

getInterconnectBytes()

public ByteString getInterconnectBytes()

URL of the underlying Interconnect object that this attachment's traffic will traverse through.

optional string interconnect = 224601230;

Returns
Type Description
ByteString

The bytes for interconnect.

getIpsecInternalAddresses(int index)

public String getIpsecInternalAddresses(int index)

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.

repeated string ipsec_internal_addresses = 407648565;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The ipsecInternalAddresses at the given index.

getIpsecInternalAddressesBytes(int index)

public ByteString getIpsecInternalAddressesBytes(int index)

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.

repeated string ipsec_internal_addresses = 407648565;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the ipsecInternalAddresses at the given index.

getIpsecInternalAddressesCount()

public int getIpsecInternalAddressesCount()

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.

repeated string ipsec_internal_addresses = 407648565;

Returns
Type Description
int

The count of ipsecInternalAddresses.

getIpsecInternalAddressesList()

public ProtocolStringList getIpsecInternalAddressesList()

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.

repeated string ipsec_internal_addresses = 407648565;

Returns
Type Description
ProtocolStringList

A list containing the ipsecInternalAddresses.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

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

optional string label_fingerprint = 178124825;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

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.

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

getMtu()

public int getMtu()

Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

optional int32 mtu = 108462;

Returns
Type Description
int

The mtu.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

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

optional string operational_status = 201070847;

Returns
Type Description
ByteString

The bytes for operationalStatus.

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"

optional string pairing_key = 439695464;

Returns
Type Description
String

The pairingKey.

getPairingKeyBytes()

public ByteString getPairingKeyBytes()

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

optional string pairing_key = 439695464;

Returns
Type Description
ByteString

The bytes for pairingKey.

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.

optional int64 partner_asn = 438166149;

Returns
Type Description
long

The partnerAsn.

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.

optional .google.cloud.compute.v1.InterconnectAttachmentPartnerMetadata partner_metadata = 65908934;

Returns
Type Description
InterconnectAttachmentPartnerMetadata

The partnerMetadata.

getPartnerMetadataBuilder()

public InterconnectAttachmentPartnerMetadata.Builder getPartnerMetadataBuilder()

Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPartnerMetadata partner_metadata = 65908934;

Returns
Type Description
InterconnectAttachmentPartnerMetadata.Builder

getPartnerMetadataOrBuilder()

public InterconnectAttachmentPartnerMetadataOrBuilder getPartnerMetadataOrBuilder()

Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPartnerMetadata partner_metadata = 65908934;

Returns
Type Description
InterconnectAttachmentPartnerMetadataOrBuilder

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.

optional .google.cloud.compute.v1.InterconnectAttachmentPrivateInfo private_interconnect_info = 237270531;

Returns
Type Description
InterconnectAttachmentPrivateInfo

The privateInterconnectInfo.

getPrivateInterconnectInfoBuilder()

public InterconnectAttachmentPrivateInfo.Builder getPrivateInterconnectInfoBuilder()

[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPrivateInfo private_interconnect_info = 237270531;

Returns
Type Description
InterconnectAttachmentPrivateInfo.Builder

getPrivateInterconnectInfoOrBuilder()

public InterconnectAttachmentPrivateInfoOrBuilder getPrivateInterconnectInfoOrBuilder()

[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPrivateInfo private_interconnect_info = 237270531;

Returns
Type Description
InterconnectAttachmentPrivateInfoOrBuilder

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.

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

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.

optional string remote_service = 391954364;

Returns
Type Description
String

The remoteService.

getRemoteServiceBytes()

public ByteString getRemoteServiceBytes()

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

optional string remote_service = 391954364;

Returns
Type Description
ByteString

The bytes for remoteService.

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.

optional string router = 148608841;

Returns
Type Description
String

The router.

getRouterBytes()

public ByteString getRouterBytes()

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.

optional string router = 148608841;

Returns
Type Description
ByteString

The bytes for router.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

The satisfiesPzs.

getSelfLink()

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.

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

optional string stack_type = 425908881;

Returns
Type Description
String

The stackType.

getStackTypeBytes()

public ByteString getStackTypeBytes()

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

optional string stack_type = 425908881;

Returns
Type Description
ByteString

The bytes for stackType.

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

optional string state = 109757585;

Returns
Type Description
ByteString

The bytes for state.

getSubnetLength()

public int getSubnetLength()

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.

optional int32 subnet_length = 279831048;

Returns
Type Description
int

The subnetLength.

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

optional string type = 3575610;

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

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

optional string type = 3575610;

Returns
Type Description
ByteString

The bytes for type.

getVlanTag8021Q()

public int getVlanTag8021Q()

The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

optional int32 vlan_tag8021q = 119927836;

Returns
Type Description
int

The vlanTag8021q.

hasAdminEnabled()

public boolean hasAdminEnabled()

Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

optional bool admin_enabled = 445675089;

Returns
Type Description
boolean

Whether the adminEnabled field is set.

hasBandwidth()

public boolean hasBandwidth()

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

optional string bandwidth = 181715121;

Returns
Type Description
boolean

Whether the bandwidth field is set.

hasCloudRouterIpAddress()

public boolean hasCloudRouterIpAddress()

[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ip_address = 287392776;

Returns
Type Description
boolean

Whether the cloudRouterIpAddress field is set.

hasCloudRouterIpv6Address()

public boolean hasCloudRouterIpv6Address()

[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ipv6_address = 451922376;

Returns
Type Description
boolean

Whether the cloudRouterIpv6Address field is set.

hasCloudRouterIpv6InterfaceId()

public boolean hasCloudRouterIpv6InterfaceId()

This field is not available.

optional string cloud_router_ipv6_interface_id = 521282701;

Returns
Type Description
boolean

Whether the cloudRouterIpv6InterfaceId field is set.

hasConfigurationConstraints()

public boolean hasConfigurationConstraints()

[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

optional .google.cloud.compute.v1.InterconnectAttachmentConfigurationConstraints configuration_constraints = 179681389;

Returns
Type Description
boolean

Whether the configurationConstraints 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.

hasCustomerRouterIpAddress()

public boolean hasCustomerRouterIpAddress()

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ip_address = 332475761;

Returns
Type Description
boolean

Whether the customerRouterIpAddress field is set.

hasCustomerRouterIpv6Address()

public boolean hasCustomerRouterIpv6Address()

[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ipv6_address = 290127089;

Returns
Type Description
boolean

Whether the customerRouterIpv6Address field is set.

hasCustomerRouterIpv6InterfaceId()

public boolean hasCustomerRouterIpv6InterfaceId()

This field is not available.

optional string customer_router_ipv6_interface_id = 380994308;

Returns
Type Description
boolean

Whether the customerRouterIpv6InterfaceId field is set.

hasDataplaneVersion()

public boolean hasDataplaneVersion()

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

optional int32 dataplane_version = 34920075;

Returns
Type Description
boolean

Whether the dataplaneVersion field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasEdgeAvailabilityDomain()

public boolean hasEdgeAvailabilityDomain()

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

optional string edge_availability_domain = 71289510;

Returns
Type Description
boolean

Whether the edgeAvailabilityDomain field is set.

hasEncryption()

public boolean hasEncryption()

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

optional string encryption = 97980291;

Returns
Type Description
boolean

Whether the encryption 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. [Deprecated] This field is not used.

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.

hasInterconnect()

public boolean hasInterconnect()

URL of the underlying Interconnect object that this attachment's traffic will traverse through.

optional string interconnect = 224601230;

Returns
Type Description
boolean

Whether the interconnect field is set.

hasKind()

public boolean hasKind()

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

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

optional string label_fingerprint = 178124825;

Returns
Type Description
boolean

Whether the labelFingerprint field is set.

hasMtu()

public boolean hasMtu()

Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

optional int32 mtu = 108462;

Returns
Type Description
boolean

Whether the mtu 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.

hasOperationalStatus()

public boolean hasOperationalStatus()

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

hasPairingKey()

public boolean hasPairingKey()

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

optional string pairing_key = 439695464;

Returns
Type Description
boolean

Whether the pairingKey field is set.

hasPartnerAsn()

public boolean hasPartnerAsn()

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.

optional int64 partner_asn = 438166149;

Returns
Type Description
boolean

Whether the partnerAsn field is set.

hasPartnerMetadata()

public boolean hasPartnerMetadata()

Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPartnerMetadata partner_metadata = 65908934;

Returns
Type Description
boolean

Whether the partnerMetadata field is set.

hasPrivateInterconnectInfo()

public boolean hasPrivateInterconnectInfo()

[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPrivateInfo private_interconnect_info = 237270531;

Returns
Type Description
boolean

Whether the privateInterconnectInfo field is set.

hasRegion()

public boolean hasRegion()

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

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

hasRemoteService()

public boolean hasRemoteService()

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

optional string remote_service = 391954364;

Returns
Type Description
boolean

Whether the remoteService field is set.

hasRouter()

public boolean hasRouter()

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.

optional string router = 148608841;

Returns
Type Description
boolean

Whether the router 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.

hasSelfLink()

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.

hasStackType()

public boolean hasStackType()

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

optional string stack_type = 425908881;

Returns
Type Description
boolean

Whether the stackType field is set.

hasState()

public boolean hasState()

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

optional string state = 109757585;

Returns
Type Description
boolean

Whether the state field is set.

hasSubnetLength()

public boolean hasSubnetLength()

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.

optional int32 subnet_length = 279831048;

Returns
Type Description
boolean

Whether the subnetLength field is set.

hasType()

public boolean hasType()

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

optional string type = 3575610;

Returns
Type Description
boolean

Whether the type field is set.

hasVlanTag8021Q()

public boolean hasVlanTag8021Q()

The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

optional int32 vlan_tag8021q = 119927836;

Returns
Type Description
boolean

Whether the vlanTag8021q field is set.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConfigurationConstraints(InterconnectAttachmentConfigurationConstraints value)

public InterconnectAttachment.Builder mergeConfigurationConstraints(InterconnectAttachmentConfigurationConstraints value)

[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

optional .google.cloud.compute.v1.InterconnectAttachmentConfigurationConstraints configuration_constraints = 179681389;

Parameter
Name Description
value InterconnectAttachmentConfigurationConstraints
Returns
Type Description
InterconnectAttachment.Builder

mergeFrom(InterconnectAttachment other)

public InterconnectAttachment.Builder mergeFrom(InterconnectAttachment other)
Parameter
Name Description
other InterconnectAttachment
Returns
Type Description
InterconnectAttachment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InterconnectAttachment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InterconnectAttachment.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public InterconnectAttachment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
InterconnectAttachment.Builder
Overrides

mergePartnerMetadata(InterconnectAttachmentPartnerMetadata value)

public InterconnectAttachment.Builder mergePartnerMetadata(InterconnectAttachmentPartnerMetadata value)

Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPartnerMetadata partner_metadata = 65908934;

Parameter
Name Description
value InterconnectAttachmentPartnerMetadata
Returns
Type Description
InterconnectAttachment.Builder

mergePrivateInterconnectInfo(InterconnectAttachmentPrivateInfo value)

public InterconnectAttachment.Builder mergePrivateInterconnectInfo(InterconnectAttachmentPrivateInfo value)

[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPrivateInfo private_interconnect_info = 237270531;

Parameter
Name Description
value InterconnectAttachmentPrivateInfo
Returns
Type Description
InterconnectAttachment.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final InterconnectAttachment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
InterconnectAttachment.Builder
Overrides

putAllLabels(Map<String,String> values)

public InterconnectAttachment.Builder putAllLabels(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
InterconnectAttachment.Builder

putLabels(String key, String value)

public InterconnectAttachment.Builder putLabels(String key, String value)

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
value String
Returns
Type Description
InterconnectAttachment.Builder

removeLabels(String key)

public InterconnectAttachment.Builder removeLabels(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
InterconnectAttachment.Builder

setAdminEnabled(boolean value)

public InterconnectAttachment.Builder setAdminEnabled(boolean value)

Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

optional bool admin_enabled = 445675089;

Parameter
Name Description
value boolean

The adminEnabled to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setBandwidth(String value)

public InterconnectAttachment.Builder setBandwidth(String value)

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

optional string bandwidth = 181715121;

Parameter
Name Description
value String

The bandwidth to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setBandwidthBytes(ByteString value)

public InterconnectAttachment.Builder setBandwidthBytes(ByteString value)

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

optional string bandwidth = 181715121;

Parameter
Name Description
value ByteString

The bytes for bandwidth to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCandidateIpv6Subnets(int index, String value)

public InterconnectAttachment.Builder setCandidateIpv6Subnets(int index, String value)

This field is not available.

repeated string candidate_ipv6_subnets = 70682522;

Parameters
Name Description
index int

The index to set the value at.
value String

The candidateIpv6Subnets to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCandidateSubnets(int index, String value)

public InterconnectAttachment.Builder setCandidateSubnets(int index, String value)

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.

repeated string candidate_subnets = 237842938;

Parameters
Name Description
index int

The index to set the value at.
value String

The candidateSubnets to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCloudRouterIpAddress(String value)

public InterconnectAttachment.Builder setCloudRouterIpAddress(String value)

[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ip_address = 287392776;

Parameter
Name Description
value String

The cloudRouterIpAddress to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCloudRouterIpAddressBytes(ByteString value)

public InterconnectAttachment.Builder setCloudRouterIpAddressBytes(ByteString value)

[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ip_address = 287392776;

Parameter
Name Description
value ByteString

The bytes for cloudRouterIpAddress to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCloudRouterIpv6Address(String value)

public InterconnectAttachment.Builder setCloudRouterIpv6Address(String value)

[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ipv6_address = 451922376;

Parameter
Name Description
value String

The cloudRouterIpv6Address to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCloudRouterIpv6AddressBytes(ByteString value)

public InterconnectAttachment.Builder setCloudRouterIpv6AddressBytes(ByteString value)

[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

optional string cloud_router_ipv6_address = 451922376;

Parameter
Name Description
value ByteString

The bytes for cloudRouterIpv6Address to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCloudRouterIpv6InterfaceId(String value)

public InterconnectAttachment.Builder setCloudRouterIpv6InterfaceId(String value)

This field is not available.

optional string cloud_router_ipv6_interface_id = 521282701;

Parameter
Name Description
value String

The cloudRouterIpv6InterfaceId to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCloudRouterIpv6InterfaceIdBytes(ByteString value)

public InterconnectAttachment.Builder setCloudRouterIpv6InterfaceIdBytes(ByteString value)

This field is not available.

optional string cloud_router_ipv6_interface_id = 521282701;

Parameter
Name Description
value ByteString

The bytes for cloudRouterIpv6InterfaceId to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setConfigurationConstraints(InterconnectAttachmentConfigurationConstraints value)

public InterconnectAttachment.Builder setConfigurationConstraints(InterconnectAttachmentConfigurationConstraints value)

[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

optional .google.cloud.compute.v1.InterconnectAttachmentConfigurationConstraints configuration_constraints = 179681389;

Parameter
Name Description
value InterconnectAttachmentConfigurationConstraints
Returns
Type Description
InterconnectAttachment.Builder

setConfigurationConstraints(InterconnectAttachmentConfigurationConstraints.Builder builderForValue)

public InterconnectAttachment.Builder setConfigurationConstraints(InterconnectAttachmentConfigurationConstraints.Builder builderForValue)

[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

optional .google.cloud.compute.v1.InterconnectAttachmentConfigurationConstraints configuration_constraints = 179681389;

Parameter
Name Description
builderForValue InterconnectAttachmentConfigurationConstraints.Builder
Returns
Type Description
InterconnectAttachment.Builder

setCreationTimestamp(String value)

public InterconnectAttachment.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public InterconnectAttachment.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCustomerRouterIpAddress(String value)

public InterconnectAttachment.Builder setCustomerRouterIpAddress(String value)

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ip_address = 332475761;

Parameter
Name Description
value String

The customerRouterIpAddress to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCustomerRouterIpAddressBytes(ByteString value)

public InterconnectAttachment.Builder setCustomerRouterIpAddressBytes(ByteString value)

[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ip_address = 332475761;

Parameter
Name Description
value ByteString

The bytes for customerRouterIpAddress to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCustomerRouterIpv6Address(String value)

public InterconnectAttachment.Builder setCustomerRouterIpv6Address(String value)

[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ipv6_address = 290127089;

Parameter
Name Description
value String

The customerRouterIpv6Address to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCustomerRouterIpv6AddressBytes(ByteString value)

public InterconnectAttachment.Builder setCustomerRouterIpv6AddressBytes(ByteString value)

[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

optional string customer_router_ipv6_address = 290127089;

Parameter
Name Description
value ByteString

The bytes for customerRouterIpv6Address to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCustomerRouterIpv6InterfaceId(String value)

public InterconnectAttachment.Builder setCustomerRouterIpv6InterfaceId(String value)

This field is not available.

optional string customer_router_ipv6_interface_id = 380994308;

Parameter
Name Description
value String

The customerRouterIpv6InterfaceId to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setCustomerRouterIpv6InterfaceIdBytes(ByteString value)

public InterconnectAttachment.Builder setCustomerRouterIpv6InterfaceIdBytes(ByteString value)

This field is not available.

optional string customer_router_ipv6_interface_id = 380994308;

Parameter
Name Description
value ByteString

The bytes for customerRouterIpv6InterfaceId to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setDataplaneVersion(int value)

public InterconnectAttachment.Builder setDataplaneVersion(int value)

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

optional int32 dataplane_version = 34920075;

Parameter
Name Description
value int

The dataplaneVersion to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setDescription(String value)

public InterconnectAttachment.Builder setDescription(String value)

An optional description of this resource.

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public InterconnectAttachment.Builder setDescriptionBytes(ByteString value)

An optional description of this resource.

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setEdgeAvailabilityDomain(String value)

public InterconnectAttachment.Builder setEdgeAvailabilityDomain(String value)

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

optional string edge_availability_domain = 71289510;

Parameter
Name Description
value String

The edgeAvailabilityDomain to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setEdgeAvailabilityDomainBytes(ByteString value)

public InterconnectAttachment.Builder setEdgeAvailabilityDomainBytes(ByteString value)

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

optional string edge_availability_domain = 71289510;

Parameter
Name Description
value ByteString

The bytes for edgeAvailabilityDomain to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setEncryption(String value)

public InterconnectAttachment.Builder setEncryption(String value)

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

optional string encryption = 97980291;

Parameter
Name Description
value String

The encryption to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setEncryptionBytes(ByteString value)

public InterconnectAttachment.Builder setEncryptionBytes(ByteString value)

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

optional string encryption = 97980291;

Parameter
Name Description
value ByteString

The bytes for encryption to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public InterconnectAttachment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InterconnectAttachment.Builder
Overrides

setGoogleReferenceId(String value)

public InterconnectAttachment.Builder setGoogleReferenceId(String value)

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

optional string google_reference_id = 534944469;

Parameter
Name Description
value String

The googleReferenceId to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setGoogleReferenceIdBytes(ByteString value)

public InterconnectAttachment.Builder setGoogleReferenceIdBytes(ByteString value)

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

optional string google_reference_id = 534944469;

Parameter
Name Description
value ByteString

The bytes for googleReferenceId to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setId(long value)

public InterconnectAttachment.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setInterconnect(String value)

public InterconnectAttachment.Builder setInterconnect(String value)

URL of the underlying Interconnect object that this attachment's traffic will traverse through.

optional string interconnect = 224601230;

Parameter
Name Description
value String

The interconnect to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setInterconnectBytes(ByteString value)

public InterconnectAttachment.Builder setInterconnectBytes(ByteString value)

URL of the underlying Interconnect object that this attachment's traffic will traverse through.

optional string interconnect = 224601230;

Parameter
Name Description
value ByteString

The bytes for interconnect to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setIpsecInternalAddresses(int index, String value)

public InterconnectAttachment.Builder setIpsecInternalAddresses(int index, String value)

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.

repeated string ipsec_internal_addresses = 407648565;

Parameters
Name Description
index int

The index to set the value at.
value String

The ipsecInternalAddresses to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setKind(String value)

public InterconnectAttachment.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setKindBytes(ByteString value)

public InterconnectAttachment.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setLabelFingerprint(String value)

public InterconnectAttachment.Builder setLabelFingerprint(String value)

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.

optional string label_fingerprint = 178124825;

Parameter
Name Description
value String

The labelFingerprint to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setLabelFingerprintBytes(ByteString value)

public InterconnectAttachment.Builder setLabelFingerprintBytes(ByteString value)

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.

optional string label_fingerprint = 178124825;

Parameter
Name Description
value ByteString

The bytes for labelFingerprint to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setMtu(int value)

public InterconnectAttachment.Builder setMtu(int value)

Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

optional int32 mtu = 108462;

Parameter
Name Description
value int

The mtu to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setName(String value)

public InterconnectAttachment.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public InterconnectAttachment.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setOperationalStatus(String value)

public InterconnectAttachment.Builder setOperationalStatus(String value)

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

optional string operational_status = 201070847;

Parameter
Name Description
value String

The operationalStatus to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setOperationalStatusBytes(ByteString value)

public InterconnectAttachment.Builder setOperationalStatusBytes(ByteString value)

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

optional string operational_status = 201070847;

Parameter
Name Description
value ByteString

The bytes for operationalStatus to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setPairingKey(String value)

public InterconnectAttachment.Builder setPairingKey(String value)

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

optional string pairing_key = 439695464;

Parameter
Name Description
value String

The pairingKey to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setPairingKeyBytes(ByteString value)

public InterconnectAttachment.Builder setPairingKeyBytes(ByteString value)

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

optional string pairing_key = 439695464;

Parameter
Name Description
value ByteString

The bytes for pairingKey to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setPartnerAsn(long value)

public InterconnectAttachment.Builder setPartnerAsn(long value)

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.

optional int64 partner_asn = 438166149;

Parameter
Name Description
value long

The partnerAsn to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setPartnerMetadata(InterconnectAttachmentPartnerMetadata value)

public InterconnectAttachment.Builder setPartnerMetadata(InterconnectAttachmentPartnerMetadata value)

Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPartnerMetadata partner_metadata = 65908934;

Parameter
Name Description
value InterconnectAttachmentPartnerMetadata
Returns
Type Description
InterconnectAttachment.Builder

setPartnerMetadata(InterconnectAttachmentPartnerMetadata.Builder builderForValue)

public InterconnectAttachment.Builder setPartnerMetadata(InterconnectAttachmentPartnerMetadata.Builder builderForValue)

Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPartnerMetadata partner_metadata = 65908934;

Parameter
Name Description
builderForValue InterconnectAttachmentPartnerMetadata.Builder
Returns
Type Description
InterconnectAttachment.Builder

setPrivateInterconnectInfo(InterconnectAttachmentPrivateInfo value)

public InterconnectAttachment.Builder setPrivateInterconnectInfo(InterconnectAttachmentPrivateInfo value)

[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPrivateInfo private_interconnect_info = 237270531;

Parameter
Name Description
value InterconnectAttachmentPrivateInfo
Returns
Type Description
InterconnectAttachment.Builder

setPrivateInterconnectInfo(InterconnectAttachmentPrivateInfo.Builder builderForValue)

public InterconnectAttachment.Builder setPrivateInterconnectInfo(InterconnectAttachmentPrivateInfo.Builder builderForValue)

[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

optional .google.cloud.compute.v1.InterconnectAttachmentPrivateInfo private_interconnect_info = 237270531;

Parameter
Name Description
builderForValue InterconnectAttachmentPrivateInfo.Builder
Returns
Type Description
InterconnectAttachment.Builder

setRegion(String value)

public InterconnectAttachment.Builder setRegion(String value)

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

optional string region = 138946292;

Parameter
Name Description
value String

The region to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public InterconnectAttachment.Builder setRegionBytes(ByteString value)

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

optional string region = 138946292;

Parameter
Name Description
value ByteString

The bytes for region to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setRemoteService(String value)

public InterconnectAttachment.Builder setRemoteService(String value)

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

optional string remote_service = 391954364;

Parameter
Name Description
value String

The remoteService to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setRemoteServiceBytes(ByteString value)

public InterconnectAttachment.Builder setRemoteServiceBytes(ByteString value)

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

optional string remote_service = 391954364;

Parameter
Name Description
value ByteString

The bytes for remoteService to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public InterconnectAttachment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
InterconnectAttachment.Builder
Overrides

setRouter(String value)

public InterconnectAttachment.Builder setRouter(String value)

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.

optional string router = 148608841;

Parameter
Name Description
value String

The router to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setRouterBytes(ByteString value)

public InterconnectAttachment.Builder setRouterBytes(ByteString value)

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.

optional string router = 148608841;

Parameter
Name Description
value ByteString

The bytes for router to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setSatisfiesPzs(boolean value)

public InterconnectAttachment.Builder setSatisfiesPzs(boolean value)

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Parameter
Name Description
value boolean

The satisfiesPzs to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setSelfLink(String value)

public InterconnectAttachment.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public InterconnectAttachment.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setStackType(String value)

public InterconnectAttachment.Builder setStackType(String value)

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

optional string stack_type = 425908881;

Parameter
Name Description
value String

The stackType to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setStackTypeBytes(ByteString value)

public InterconnectAttachment.Builder setStackTypeBytes(ByteString value)

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

optional string stack_type = 425908881;

Parameter
Name Description
value ByteString

The bytes for stackType to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setState(String value)

public InterconnectAttachment.Builder setState(String value)

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

optional string state = 109757585;

Parameter
Name Description
value String

The state to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setStateBytes(ByteString value)

public InterconnectAttachment.Builder setStateBytes(ByteString value)

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

optional string state = 109757585;

Parameter
Name Description
value ByteString

The bytes for state to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setSubnetLength(int value)

public InterconnectAttachment.Builder setSubnetLength(int value)

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.

optional int32 subnet_length = 279831048;

Parameter
Name Description
value int

The subnetLength to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setType(String value)

public InterconnectAttachment.Builder setType(String value)

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

optional string type = 3575610;

Parameter
Name Description
value String

The type to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public InterconnectAttachment.Builder setTypeBytes(ByteString value)

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

optional string type = 3575610;

Parameter
Name Description
value ByteString

The bytes for type to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final InterconnectAttachment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
InterconnectAttachment.Builder
Overrides

setVlanTag8021Q(int value)

public InterconnectAttachment.Builder setVlanTag8021Q(int value)

The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

optional int32 vlan_tag8021q = 119927836;

Parameter
Name Description
value int

The vlanTag8021q to set.
Returns
Type Description
InterconnectAttachment.Builder

This builder for chaining.