Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::InterconnectAttachment (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#admin_enabled

def admin_enabled() -> ::Boolean
Returns
  • (::Boolean) — Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

#admin_enabled=

def admin_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
Returns
  • (::Boolean) — Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

#attachment_group

def attachment_group() -> ::String
Returns
  • (::String) — Output only. [Output Only] URL of the AttachmentGroup that includes this Attachment.

#attachment_group=

def attachment_group=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] URL of the AttachmentGroup that includes this Attachment.
Returns
  • (::String) — Output only. [Output Only] URL of the AttachmentGroup that includes this Attachment.

#bandwidth

def bandwidth() -> ::String
Returns
  • (::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
    • BPS_100G: 100 Gbit/s
    • BPS_400G: 400 Gbit/s Check the Bandwidth enum for the list of possible values.

#bandwidth=

def bandwidth=(value) -> ::String
Parameter
  • value (::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
    • BPS_100G: 100 Gbit/s
    • BPS_400G: 400 Gbit/s Check the Bandwidth enum for the list of possible values.
Returns
  • (::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
    • BPS_100G: 100 Gbit/s
    • BPS_400G: 400 Gbit/s Check the Bandwidth enum for the list of possible values.

#candidate_cloud_router_ip_address

def candidate_cloud_router_ip_address() -> ::String
Returns
  • (::String) —

    Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment.

    • Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset.
    • Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same.
    • Max prefix length is 31.

#candidate_cloud_router_ip_address=

def candidate_cloud_router_ip_address=(value) -> ::String
Parameter
  • value (::String) —

    Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment.

    • Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset.
    • Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same.
    • Max prefix length is 31.
Returns
  • (::String) —

    Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment.

    • Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset.
    • Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same.
    • Max prefix length is 31.

#candidate_cloud_router_ipv6_address

def candidate_cloud_router_ipv6_address() -> ::String
Returns
  • (::String) —

    Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment.

    • Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset.
    • Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same.
    • Max prefix length is 126.

#candidate_cloud_router_ipv6_address=

def candidate_cloud_router_ipv6_address=(value) -> ::String
Parameter
  • value (::String) —

    Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment.

    • Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset.
    • Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same.
    • Max prefix length is 126.
Returns
  • (::String) —

    Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment.

    • Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset.
    • Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same.
    • Max prefix length is 126.

#candidate_customer_router_ip_address

def candidate_customer_router_ip_address() -> ::String
Returns
  • (::String) — Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.

#candidate_customer_router_ip_address=

def candidate_customer_router_ip_address=(value) -> ::String
Parameter
  • value (::String) — Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.
Returns
  • (::String) — Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.

#candidate_customer_router_ipv6_address

def candidate_customer_router_ipv6_address() -> ::String
Returns
  • (::String) — Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.

#candidate_customer_router_ipv6_address=

def candidate_customer_router_ipv6_address=(value) -> ::String
Parameter
  • value (::String) — Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.
Returns
  • (::String) — Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.

#candidate_ipv6_subnets

def candidate_ipv6_subnets() -> ::Array<::String>
Returns
  • (::Array<::String>) — This field is not available.

#candidate_ipv6_subnets=

def candidate_ipv6_subnets=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — This field is not available.
Returns
  • (::Array<::String>) — This field is not available.

#candidate_subnets

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

#candidate_subnets=

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

#cloud_router_ip_address

def cloud_router_ip_address() -> ::String
Returns
  • (::String) — Output only. [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

#cloud_router_ip_address=

def cloud_router_ip_address=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
Returns
  • (::String) — Output only. [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

#cloud_router_ipv6_address

def cloud_router_ipv6_address() -> ::String
Returns
  • (::String) — Output only. [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

#cloud_router_ipv6_address=

def cloud_router_ipv6_address=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
Returns
  • (::String) — Output only. [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

#cloud_router_ipv6_interface_id

def cloud_router_ipv6_interface_id() -> ::String
Returns
  • (::String) — This field is not available.

#cloud_router_ipv6_interface_id=

def cloud_router_ipv6_interface_id=(value) -> ::String
Parameter
  • value (::String) — This field is not available.
Returns
  • (::String) — This field is not available.

#configuration_constraints

def configuration_constraints() -> ::Google::Cloud::Compute::V1::InterconnectAttachmentConfigurationConstraints
Returns

#configuration_constraints=

def configuration_constraints=(value) -> ::Google::Cloud::Compute::V1::InterconnectAttachmentConfigurationConstraints
Parameter
Returns

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
Returns
  • (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

#customer_router_ip_address

def customer_router_ip_address() -> ::String
Returns
  • (::String) — Output only. [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

#customer_router_ip_address=

def customer_router_ip_address=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
Returns
  • (::String) — Output only. [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

#customer_router_ipv6_address

def customer_router_ipv6_address() -> ::String
Returns
  • (::String) — Output only. [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

#customer_router_ipv6_address=

def customer_router_ipv6_address=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
Returns
  • (::String) — Output only. [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

#customer_router_ipv6_interface_id

def customer_router_ipv6_interface_id() -> ::String
Returns
  • (::String) — This field is not available.

#customer_router_ipv6_interface_id=

def customer_router_ipv6_interface_id=(value) -> ::String
Parameter
  • value (::String) — This field is not available.
Returns
  • (::String) — This field is not available.

#dataplane_version

def dataplane_version() -> ::Integer
Returns
  • (::Integer) — Output only. [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.

#dataplane_version=

def dataplane_version=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. [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
  • (::Integer) — Output only. [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

def description() -> ::String
Returns
  • (::String) — An optional description of this resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource.
Returns
  • (::String) — An optional description of this resource.

#edge_availability_domain

def edge_availability_domain() -> ::String
Returns
  • (::String) — Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:

    • AVAILABILITY_DOMAIN_ANY
    • AVAILABILITY_DOMAIN_1
    • AVAILABILITY_DOMAIN_2

    For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. Check the EdgeAvailabilityDomain enum for the list of possible values.

#edge_availability_domain=

def edge_availability_domain=(value) -> ::String
Parameter
  • value (::String) — Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:

    • AVAILABILITY_DOMAIN_ANY
    • AVAILABILITY_DOMAIN_1
    • AVAILABILITY_DOMAIN_2

    For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. Check the EdgeAvailabilityDomain enum for the list of possible values.

Returns
  • (::String) — Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:

    • AVAILABILITY_DOMAIN_ANY
    • AVAILABILITY_DOMAIN_1
    • AVAILABILITY_DOMAIN_2

    For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. Check the EdgeAvailabilityDomain enum for the list of possible values.

#encryption

def encryption() -> ::String
Returns
  • (::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.

#encryption=

def encryption=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def google_reference_id() -> ::String
Returns
  • (::String) — Output only. [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.

#google_reference_id=

def google_reference_id=(value) -> ::String
Parameter
  • value (::String) — Output only. [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
  • (::String) — Output only. [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

def id() -> ::Integer
Returns
  • (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#interconnect

def interconnect() -> ::String
Returns
  • (::String) — URL of the underlying Interconnect object that this attachment's traffic will traverse through.

#interconnect=

def interconnect=(value) -> ::String
Parameter
  • value (::String) — URL of the underlying Interconnect object that this attachment's traffic will traverse through.
Returns
  • (::String) — URL of the underlying Interconnect object that this attachment's traffic will traverse through.

#ipsec_internal_addresses

def ipsec_internal_addresses() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#ipsec_internal_addresses=

def ipsec_internal_addresses=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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
  • (::Array<::String>) — 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

def kind() -> ::String
Returns
  • (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
Returns
  • (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.

#l2_forwarding

def l2_forwarding() -> ::Google::Cloud::Compute::V1::InterconnectAttachmentL2Forwarding
Returns
  • (::Google::Cloud::Compute::V1::InterconnectAttachmentL2Forwarding) — L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED.

    The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance.

#l2_forwarding=

def l2_forwarding=(value) -> ::Google::Cloud::Compute::V1::InterconnectAttachmentL2Forwarding
Parameter
  • value (::Google::Cloud::Compute::V1::InterconnectAttachmentL2Forwarding) — L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED.

    The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance.

Returns
  • (::Google::Cloud::Compute::V1::InterconnectAttachmentL2Forwarding) — L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED.

    The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance.

#label_fingerprint

def label_fingerprint() -> ::String
Returns
  • (::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 error412 conditionNotMet.

    To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.

#label_fingerprint=

def label_fingerprint=(value) -> ::String
Parameter
  • value (::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 error412 conditionNotMet.

    To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.

Returns
  • (::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 error412 conditionNotMet.

    To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.

#mtu

def mtu() -> ::Integer
Returns
  • (::Integer) — Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.

#mtu=

def mtu=(value) -> ::Integer
Parameter
  • value (::Integer) — Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.
Returns
  • (::Integer) — Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.

#name

def name() -> ::String
Returns
  • (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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
  • (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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

def operational_status() -> ::String
Returns
  • (::String) —

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

#operational_status=

def operational_status=(value) -> ::String
Parameter
  • value (::String) —

    Output only. [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
  • (::String) —

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

def pairing_key() -> ::String
Returns
  • (::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"

#pairing_key=

def pairing_key=(value) -> ::String
Parameter
  • value (::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"
Returns
  • (::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"

#params

def params() -> ::Google::Cloud::Compute::V1::InterconnectAttachmentParams
Returns

#params=

def params=(value) -> ::Google::Cloud::Compute::V1::InterconnectAttachmentParams
Parameter
Returns

#partner_asn

def partner_asn() -> ::Integer
Returns
  • (::Integer) — 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_asn=

def partner_asn=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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

def partner_metadata() -> ::Google::Cloud::Compute::V1::InterconnectAttachmentPartnerMetadata
Returns

#partner_metadata=

def partner_metadata=(value) -> ::Google::Cloud::Compute::V1::InterconnectAttachmentPartnerMetadata
Parameter
Returns

#private_interconnect_info

def private_interconnect_info() -> ::Google::Cloud::Compute::V1::InterconnectAttachmentPrivateInfo
Returns

#private_interconnect_info=

def private_interconnect_info=(value) -> ::Google::Cloud::Compute::V1::InterconnectAttachmentPrivateInfo
Parameter
Returns

#region

def region() -> ::String
Returns
  • (::String) — Output only. [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.

#region=

def region=(value) -> ::String
Parameter
  • value (::String) — Output only. [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
  • (::String) — Output only. [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

def remote_service() -> ::String
Returns
  • (::String) — Output only. [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.

#remote_service=

def remote_service=(value) -> ::String
Parameter
  • value (::String) — Output only. [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
  • (::String) — Output only. [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

def router() -> ::String
Returns
  • (::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.

#router=

def router=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. [Output Only] Reserved for future use.

#satisfies_pzs=

def satisfies_pzs=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Output only. [Output Only] Reserved for future use.
Returns
  • (::Boolean) — Output only. [Output Only] Reserved for future use.

#self_link

def self_link() -> ::String
Returns
  • (::String) — Output only. [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Server-defined URL for the resource.
Returns
  • (::String) — Output only. [Output Only] Server-defined URL for the resource.

#stack_type

def stack_type() -> ::String
Returns
  • (::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.

#stack_type=

def stack_type=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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

def state() -> ::String
Returns
  • (::String) —

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

#state=

def state=(value) -> ::String
Parameter
  • value (::String) —

    Output only. [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
  • (::String) —

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

def subnet_length() -> ::Integer
Returns
  • (::Integer) — Input only. Length of the IPv4 subnet mask. Allowed values:

    - 29 (default)
- 30

    The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error.

    Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.

#subnet_length=

def subnet_length=(value) -> ::Integer
Parameter
  • value (::Integer) — Input only. Length of the IPv4 subnet mask. Allowed values:

    - 29 (default)
- 30

    The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error.

    Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.

Returns
  • (::Integer) — Input only. Length of the IPv4 subnet mask. Allowed values:

    - 29 (default)
- 30

    The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error.

    Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.

#type

def type() -> ::String
Returns
  • (::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.

      • L2_DEDICATED: a L2 attachment to a Dedicated Interconnect. Check the Type enum for the list of possible values.

#type=

def type=(value) -> ::String
Parameter
  • value (::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.

      • L2_DEDICATED: a L2 attachment to a Dedicated Interconnect. Check the Type enum for the list of possible values.
Returns
  • (::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.

      • L2_DEDICATED: a L2 attachment to a Dedicated Interconnect. Check the Type enum for the list of possible values.

#vlan_tag8021q

def vlan_tag8021q() -> ::Integer
Returns
  • (::Integer) — The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

#vlan_tag8021q=

def vlan_tag8021q=(value) -> ::Integer
Parameter
  • value (::Integer) — The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.
Returns
  • (::Integer) — The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.