Compute V1 Client - Class InterconnectAttachment (1.5.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

Methods

__construct

Constructor.

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

↳ 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. Not currently available publicly.

↳ kind string

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

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

↳ 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] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present.

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

↳ 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-4094. Only specified at creation time.

getAdminEnabled

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

Generated from protobuf field optional bool admin_enabled = 445675089;

Returns
TypeDescription
bool

hasAdminEnabled

clearAdminEnabled

setAdminEnabled

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

Generated from protobuf field optional bool admin_enabled = 445675089;

Parameter
NameDescription
var bool
Returns
TypeDescription
$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.

Generated from protobuf field optional string bandwidth = 181715121;

Returns
TypeDescription
string

hasBandwidth

clearBandwidth

setBandwidth

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.

Generated from protobuf field optional string bandwidth = 181715121;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCandidateIpv6Subnets

This field is not available.

Generated from protobuf field repeated string candidate_ipv6_subnets = 70682522;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setCandidateIpv6Subnets

This field is not available.

Generated from protobuf field repeated string candidate_ipv6_subnets = 70682522;

Parameter
NameDescription
var string[]
Returns
TypeDescription
$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.

Generated from protobuf field repeated string candidate_subnets = 237842938;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setCandidateSubnets

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.

Generated from protobuf field repeated string candidate_subnets = 237842938;

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getCloudRouterIpAddress

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

Generated from protobuf field optional string cloud_router_ip_address = 287392776;

Returns
TypeDescription
string

hasCloudRouterIpAddress

clearCloudRouterIpAddress

setCloudRouterIpAddress

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

Generated from protobuf field optional string cloud_router_ip_address = 287392776;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCloudRouterIpv6Address

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

Generated from protobuf field optional string cloud_router_ipv6_address = 451922376;

Returns
TypeDescription
string

hasCloudRouterIpv6Address

clearCloudRouterIpv6Address

setCloudRouterIpv6Address

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

Generated from protobuf field optional string cloud_router_ipv6_address = 451922376;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCloudRouterIpv6InterfaceId

This field is not available.

Generated from protobuf field optional string cloud_router_ipv6_interface_id = 521282701;

Returns
TypeDescription
string

hasCloudRouterIpv6InterfaceId

clearCloudRouterIpv6InterfaceId

setCloudRouterIpv6InterfaceId

This field is not available.

Generated from protobuf field optional string cloud_router_ipv6_interface_id = 521282701;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
TypeDescription
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCustomerRouterIpAddress

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

Generated from protobuf field optional string customer_router_ip_address = 332475761;

Returns
TypeDescription
string

hasCustomerRouterIpAddress

clearCustomerRouterIpAddress

setCustomerRouterIpAddress

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

Generated from protobuf field optional string customer_router_ip_address = 332475761;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCustomerRouterIpv6Address

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

Generated from protobuf field optional string customer_router_ipv6_address = 290127089;

Returns
TypeDescription
string

hasCustomerRouterIpv6Address

clearCustomerRouterIpv6Address

setCustomerRouterIpv6Address

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

Generated from protobuf field optional string customer_router_ipv6_address = 290127089;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCustomerRouterIpv6InterfaceId

This field is not available.

Generated from protobuf field optional string customer_router_ipv6_interface_id = 380994308;

Returns
TypeDescription
string

hasCustomerRouterIpv6InterfaceId

clearCustomerRouterIpv6InterfaceId

setCustomerRouterIpv6InterfaceId

This field is not available.

Generated from protobuf field optional string customer_router_ipv6_interface_id = 380994308;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional int32 dataplane_version = 34920075;

Returns
TypeDescription
int

hasDataplaneVersion

clearDataplaneVersion

setDataplaneVersion

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

Generated from protobuf field optional int32 dataplane_version = 34920075;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDescription

An optional description of this resource.

Generated from protobuf field optional string description = 422937596;

Returns
TypeDescription
string

hasDescription

clearDescription

setDescription

An optional description of this resource.

Generated from protobuf field optional string description = 422937596;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional string edge_availability_domain = 71289510;

Returns
TypeDescription
string

hasEdgeAvailabilityDomain

clearEdgeAvailabilityDomain

setEdgeAvailabilityDomain

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.

Generated from protobuf field optional string edge_availability_domain = 71289510;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional string encryption = 97980291;

Returns
TypeDescription
string

hasEncryption

clearEncryption

setEncryption

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.

Generated from protobuf field optional string encryption = 97980291;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional string google_reference_id = 534944469;

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

Generated from protobuf field optional string google_reference_id = 534944469;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

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

Generated from protobuf field optional uint64 id = 3355;

Returns
TypeDescription
int|string

hasId

clearId

setId

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

Generated from protobuf field optional uint64 id = 3355;

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getInterconnect

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

Generated from protobuf field optional string interconnect = 224601230;

Returns
TypeDescription
string

hasInterconnect

clearInterconnect

setInterconnect

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

Generated from protobuf field optional string interconnect = 224601230;

Parameter
NameDescription
var string
Returns
TypeDescription
$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. Not currently available publicly.

Generated from protobuf field repeated string ipsec_internal_addresses = 407648565;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIpsecInternalAddresses

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. Not currently available publicly.

Generated from protobuf field repeated string ipsec_internal_addresses = 407648565;

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getKind

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

Generated from protobuf field optional string kind = 3292052;

Returns
TypeDescription
string

hasKind

clearKind

setKind

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

Generated from protobuf field optional string kind = 3292052;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional int32 mtu = 108462;

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

Generated from protobuf field optional int32 mtu = 108462;

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Generated from protobuf field optional string name = 3373707;

Returns
TypeDescription
string

hasName

clearName

setName

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.

Generated from protobuf field optional string name = 3373707;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional string operational_status = 201070847;

Returns
TypeDescription
string

hasOperationalStatus

clearOperationalStatus

setOperationalStatus

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

Generated from protobuf field optional string operational_status = 201070847;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPairingKey

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

Generated from protobuf field optional string pairing_key = 439695464;

Returns
TypeDescription
string

hasPairingKey

clearPairingKey

setPairingKey

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

Generated from protobuf field optional string pairing_key = 439695464;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional int64 partner_asn = 438166149;

Returns
TypeDescription
int|string

hasPartnerAsn

clearPartnerAsn

setPartnerAsn

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.

Generated from protobuf field optional int64 partner_asn = 438166149;

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getPartnerMetadata

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

Generated from protobuf field optional .google.cloud.compute.v1.InterconnectAttachmentPartnerMetadata partner_metadata = 65908934;

Returns
TypeDescription
Google\Cloud\Compute\V1\InterconnectAttachmentPartnerMetadata|null

hasPartnerMetadata

clearPartnerMetadata

setPartnerMetadata

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

Generated from protobuf field optional .google.cloud.compute.v1.InterconnectAttachmentPartnerMetadata partner_metadata = 65908934;

Parameter
NameDescription
var Google\Cloud\Compute\V1\InterconnectAttachmentPartnerMetadata
Returns
TypeDescription
$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.

Generated from protobuf field optional .google.cloud.compute.v1.InterconnectAttachmentPrivateInfo private_interconnect_info = 237270531;

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

Generated from protobuf field optional .google.cloud.compute.v1.InterconnectAttachmentPrivateInfo private_interconnect_info = 237270531;

Parameter
NameDescription
var Google\Cloud\Compute\V1\InterconnectAttachmentPrivateInfo
Returns
TypeDescription
$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.

Generated from protobuf field optional string region = 138946292;

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

Generated from protobuf field optional string region = 138946292;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional string router = 148608841;

Returns
TypeDescription
string

hasRouter

clearRouter

setRouter

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.

Generated from protobuf field optional string router = 148608841;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSatisfiesPzs

[Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present.

Generated from protobuf field optional bool satisfies_pzs = 480964267;

Returns
TypeDescription
bool

hasSatisfiesPzs

clearSatisfiesPzs

setSatisfiesPzs

[Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present.

Generated from protobuf field optional bool satisfies_pzs = 480964267;

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

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

Generated from protobuf field optional string self_link = 456214797;

Returns
TypeDescription
string

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

Generated from protobuf field optional string self_link = 456214797;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional string stack_type = 425908881;

Returns
TypeDescription
string

hasStackType

clearStackType

setStackType

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.

Generated from protobuf field optional string stack_type = 425908881;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional string state = 109757585;

Returns
TypeDescription
string

hasState

clearState

setState

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

Generated from protobuf field optional string state = 109757585;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional string type = 3575610;

Returns
TypeDescription
string

hasType

clearType

setType

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.

Generated from protobuf field optional string type = 3575610;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVlanTag8021Q

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

Generated from protobuf field optional int32 vlan_tag8021q = 119927836;

Returns
TypeDescription
int

hasVlanTag8021Q

clearVlanTag8021Q

setVlanTag8021Q

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

Generated from protobuf field optional int32 vlan_tag8021q = 119927836;

Parameter
NameDescription
var int
Returns
TypeDescription
$this