Reference documentation and code samples for the Compute V1 Client class VpnGatewayVpnGatewayInterface.
A VPN gateway interface.
Generated from protobuf message google.cloud.compute.v1.VpnGatewayVpnGatewayInterface
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ id
int
[Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
↳ interconnect_attachment
string
URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for HA VPN over Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource.
↳ ip_address
string
[Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For HA VPN over Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.
↳ ipv6_address
string
[Output Only] IPv6 address for this VPN interface associated with the VPN gateway. The IPv6 address must be a regional external IPv6 address. The format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
getId
[Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
Returns
Type
Description
int
hasId
clearId
setId
[Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getInterconnectAttachment
URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for HA VPN over Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource.
Returns
Type
Description
string
hasInterconnectAttachment
clearInterconnectAttachment
setInterconnectAttachment
URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for HA VPN over Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getIpAddress
[Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For HA VPN over Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.
Returns
Type
Description
string
hasIpAddress
clearIpAddress
setIpAddress
[Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For HA VPN over Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getIpv6Address
[Output Only] IPv6 address for this VPN interface associated with the VPN gateway. The IPv6 address must be a regional external IPv6 address. The format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
Returns
Type
Description
string
hasIpv6Address
clearIpv6Address
setIpv6Address
[Output Only] IPv6 address for this VPN interface associated with the VPN gateway. The IPv6 address must be a regional external IPv6 address. The format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class VpnGatewayVpnGatewayInterface (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.VpnGatewayVpnGatewayInterface)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.VpnGatewayVpnGatewayInterface)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.VpnGatewayVpnGatewayInterface)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.VpnGatewayVpnGatewayInterface)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.VpnGatewayVpnGatewayInterface)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.VpnGatewayVpnGatewayInterface)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.VpnGatewayVpnGatewayInterface)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.VpnGatewayVpnGatewayInterface)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.VpnGatewayVpnGatewayInterface)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.VpnGatewayVpnGatewayInterface)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.VpnGatewayVpnGatewayInterface)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.VpnGatewayVpnGatewayInterface)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.VpnGatewayVpnGatewayInterface) \nReference documentation and code samples for the Compute V1 Client class VpnGatewayVpnGatewayInterface.\n\nA VPN gateway interface.\n\nGenerated from protobuf message `google.cloud.compute.v1.VpnGatewayVpnGatewayInterface`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getId\n\n\\[Output Only\\] Numeric identifier for this VPN interface associated with the VPN gateway.\n\n### hasId\n\n### clearId\n\n### setId\n\n\\[Output Only\\] Numeric identifier for this VPN interface associated with the VPN gateway.\n\n### getInterconnectAttachment\n\nURL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for HA VPN over Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource.\n\n### hasInterconnectAttachment\n\n### clearInterconnectAttachment\n\n### setInterconnectAttachment\n\nURL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for HA VPN over Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource.\n\n### getIpAddress\n\n\\[Output Only\\] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For HA VPN over Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.\n\n### hasIpAddress\n\n### clearIpAddress\n\n### setIpAddress\n\n\\[Output Only\\] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For HA VPN over Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.\n\n### getIpv6Address\n\n\\[Output Only\\] IPv6 address for this VPN interface associated with the VPN gateway. The IPv6 address must be a regional external IPv6 address. The format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).\n\n### hasIpv6Address\n\n### clearIpv6Address\n\n### setIpv6Address\n\n\\[Output Only\\] IPv6 address for this VPN interface associated with the VPN gateway. The IPv6 address must be a regional external IPv6 address. The format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0)."]]