Compute V1 Client - Class InterconnectAttachment (1.19.0)

Reference documentation and code samples for the Compute V1 Client class InterconnectAttachment.

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.

Generated from protobuf message google.cloud.compute.v1.InterconnectAttachment

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ admin_enabled`	`bool` Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
`↳ bandwidth`	`string` 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.
`↳ candidate_ipv6_subnets`	`array` This field is not available.
`↳ candidate_subnets`	`array` 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.
`↳ cloud_router_ip_address`	`string` [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
`↳ cloud_router_ipv6_address`	`string` [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
`↳ cloud_router_ipv6_interface_id`	`string` This field is not available.
`↳ configuration_constraints`	`Google\Cloud\Compute\V1\InterconnectAttachmentConfigurationConstraints` [Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.
`↳ creation_timestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`↳ customer_router_ip_address`	`string` [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
`↳ customer_router_ipv6_address`	`string` [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
`↳ customer_router_ipv6_interface_id`	`string` This field is not available.
`↳ dataplane_version`	`int` [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.
`↳ description`	`string` An optional description of this resource.
`↳ edge_availability_domain`	`string` 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.
`↳ encryption`	`string` 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.
`↳ google_reference_id`	`string` [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.
`↳ id`	`int\|string` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`↳ interconnect`	`string` URL of the underlying Interconnect object that this attachment's traffic will traverse through.
`↳ ipsec_internal_addresses`	`array` 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.
`↳ kind`	`string` [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
`↳ label_fingerprint`	`string` 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.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` 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.
`↳ mtu`	`int` 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.
`↳ name`	`string` Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
`↳ operational_status`	`string` [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.
`↳ pairing_key`	`string` [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"
`↳ partner_asn`	`int\|string` 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.
`↳ partner_metadata`	`Google\Cloud\Compute\V1\InterconnectAttachmentPartnerMetadata` Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
`↳ private_interconnect_info`	`Google\Cloud\Compute\V1\InterconnectAttachmentPrivateInfo` [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
`↳ region`	`string` [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.
`↳ remote_service`	`string` [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.
`↳ router`	`string` 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.
`↳ satisfies_pzs`	`bool` [Output Only] Reserved for future use.
`↳ self_link`	`string` [Output Only] Server-defined URL for the resource.
`↳ stack_type`	`string` 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.
`↳ state`	`string` [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.
`↳ subnet_length`	`int` 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.
`↳ type`	`string` 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.
`↳ vlan_tag8021q`	`int` The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

getAdminEnabled

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

Returns
Type	Description
`bool`

hasAdminEnabled

clearAdminEnabled

setAdminEnabled

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasBandwidth

clearBandwidth

setBandwidth

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCandidateIpv6Subnets

This field is not available.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCandidateIpv6Subnets

This field is not available.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getCandidateSubnets

Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCandidateSubnets

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getCloudRouterIpAddress

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

Returns
Type	Description
`string`

hasCloudRouterIpAddress

clearCloudRouterIpAddress

setCloudRouterIpAddress

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCloudRouterIpv6Address

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

Returns
Type	Description
`string`

hasCloudRouterIpv6Address

clearCloudRouterIpv6Address

setCloudRouterIpv6Address

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCloudRouterIpv6InterfaceId

This field is not available.

Returns
Type	Description
`string`

hasCloudRouterIpv6InterfaceId

clearCloudRouterIpv6InterfaceId

setCloudRouterIpv6InterfaceId

This field is not available.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getConfigurationConstraints

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

Returns
Type	Description
`Google\Cloud\Compute\V1\InterconnectAttachmentConfigurationConstraints\|null`

hasConfigurationConstraints

clearConfigurationConstraints

setConfigurationConstraints

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

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\InterconnectAttachmentConfigurationConstraints`

Returns
Type	Description
`$this`

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomerRouterIpAddress

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

Returns
Type	Description
`string`

hasCustomerRouterIpAddress

clearCustomerRouterIpAddress

setCustomerRouterIpAddress

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomerRouterIpv6Address

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

Returns
Type	Description
`string`

hasCustomerRouterIpv6Address

clearCustomerRouterIpv6Address

setCustomerRouterIpv6Address

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomerRouterIpv6InterfaceId

This field is not available.

Returns
Type	Description
`string`

hasCustomerRouterIpv6InterfaceId

clearCustomerRouterIpv6InterfaceId

setCustomerRouterIpv6InterfaceId

This field is not available.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDataplaneVersion

[Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.

Returns
Type	Description
`int`

hasDataplaneVersion

clearDataplaneVersion

setDataplaneVersion

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getDescription

An optional description of this resource.

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

An optional description of this resource.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasEdgeAvailabilityDomain

clearEdgeAvailabilityDomain

setEdgeAvailabilityDomain

Check the EdgeAvailabilityDomain enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasEncryption

clearEncryption

setEncryption

Check the Encryption enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGoogleReferenceId

[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.

Returns
Type	Description
`string`

hasGoogleReferenceId

clearGoogleReferenceId

setGoogleReferenceId

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getId

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

Returns
Type	Description
`int\|string`

hasId

clearId

setId

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

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getInterconnect

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

Returns
Type	Description
`string`

hasInterconnect

clearInterconnect

setInterconnect

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIpsecInternalAddresses

A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setIpsecInternalAddresses

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getKind

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

Returns
Type	Description
`string`

hasKind

clearKind

setKind

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabelFingerprint

A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.

Returns
Type	Description
`string`

hasLabelFingerprint

clearLabelFingerprint

setLabelFingerprint

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabels

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

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.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`int`

hasMtu

clearMtu

setMtu

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.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type	Description
`string`

hasName

clearName

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasOperationalStatus

clearOperationalStatus

setOperationalStatus

Check the OperationalStatus enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPairingKey

[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"

Returns
Type	Description
`string`

hasPairingKey

clearPairingKey

setPairingKey

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPartnerAsn

Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.

Returns
Type	Description
`int\|string`

hasPartnerAsn

clearPartnerAsn

setPartnerAsn

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getPartnerMetadata

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

Returns
Type	Description
`Google\Cloud\Compute\V1\InterconnectAttachmentPartnerMetadata\|null`

hasPartnerMetadata

clearPartnerMetadata

setPartnerMetadata

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

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\InterconnectAttachmentPartnerMetadata`

Returns
Type	Description
`$this`

getPrivateInterconnectInfo

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

Returns
Type	Description
`Google\Cloud\Compute\V1\InterconnectAttachmentPrivateInfo\|null`

hasPrivateInterconnectInfo

clearPrivateInterconnectInfo

setPrivateInterconnectInfo

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

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\InterconnectAttachmentPrivateInfo`

Returns
Type	Description
`$this`

getRegion

[Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns
Type	Description
`string`

hasRegion

clearRegion

setRegion

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRemoteService

[Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: "Amazon Web Services" "Microsoft Azure". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field.

Returns
Type	Description
`string`

hasRemoteService

clearRemoteService

setRemoteService

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRouter

URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.

Returns
Type	Description
`string`

hasRouter

clearRouter

setRouter

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSatisfiesPzs

[Output Only] Reserved for future use.

Returns
Type	Description
`bool`

hasSatisfiesPzs

clearSatisfiesPzs

setSatisfiesPzs

[Output Only] Reserved for future use.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSelfLink

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

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasStackType

clearStackType

setStackType

Check the StackType enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasState

clearState

setState

Check the State enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`int`

hasSubnetLength

clearSubnetLength

setSubnetLength

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasType

clearType

setType

Check the Type enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVlanTag8021Q

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

Returns
Type	Description
`int`

hasVlanTag8021Q

clearVlanTag8021Q

setVlanTag8021Q

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`