Reference documentation and code samples for the Compute V1 Client class ExternalVpnGatewayInterface.
The interface for the external VPN gateway.
Generated from protobuf messagegoogle.cloud.compute.v1.ExternalVpnGatewayInterface
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ id
int
The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
↳ ip_address
string
IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.
↳ ipv6_address
string
IPv6 address of the interface in the external VPN gateway. This IPv6 address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. Must specify an IPv6 address (not IPV4-mapped) using any format described in RFC 4291 (e.g. 2001:db8:0:0:2d9:51:0:0). The output format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
getId
The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
Returns
Type
Description
int
hasId
clearId
setId
The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getIpAddress
IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.
Returns
Type
Description
string
hasIpAddress
clearIpAddress
setIpAddress
IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getIpv6Address
IPv6 address of the interface in the external VPN gateway. This IPv6 address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. Must specify an IPv6 address (not IPV4-mapped) using any format described in RFC 4291 (e.g. 2001:db8:0:0:2d9:51:0:0). The output format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).
Returns
Type
Description
string
hasIpv6Address
clearIpv6Address
setIpv6Address
IPv6 address of the interface in the external VPN gateway. This IPv6 address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. Must specify an IPv6 address (not IPV4-mapped) using any format described in RFC 4291 (e.g. 2001:db8:0:0:2d9:51:0:0). The output 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-09-04 UTC."],[],[],null,["# Compute V1 Client - Class ExternalVpnGatewayInterface (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.ExternalVpnGatewayInterface)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.ExternalVpnGatewayInterface)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.ExternalVpnGatewayInterface)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.ExternalVpnGatewayInterface)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.ExternalVpnGatewayInterface)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.ExternalVpnGatewayInterface)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.ExternalVpnGatewayInterface)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.ExternalVpnGatewayInterface)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.ExternalVpnGatewayInterface)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.ExternalVpnGatewayInterface)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.ExternalVpnGatewayInterface)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.ExternalVpnGatewayInterface)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.ExternalVpnGatewayInterface)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.ExternalVpnGatewayInterface)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.ExternalVpnGatewayInterface)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.ExternalVpnGatewayInterface)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.ExternalVpnGatewayInterface)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.ExternalVpnGatewayInterface)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.ExternalVpnGatewayInterface)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.ExternalVpnGatewayInterface)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.ExternalVpnGatewayInterface)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.ExternalVpnGatewayInterface)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.ExternalVpnGatewayInterface)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.ExternalVpnGatewayInterface)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.ExternalVpnGatewayInterface)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.ExternalVpnGatewayInterface)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.ExternalVpnGatewayInterface)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.ExternalVpnGatewayInterface)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.ExternalVpnGatewayInterface)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.ExternalVpnGatewayInterface) \nReference documentation and code samples for the Compute V1 Client class ExternalVpnGatewayInterface.\n\nThe interface for the external VPN gateway.\n\nGenerated from protobuf message `google.cloud.compute.v1.ExternalVpnGatewayInterface`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getId\n\nThe numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3\n\n### hasId\n\n### clearId\n\n### setId\n\nThe numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3\n\n### getIpAddress\n\nIP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.\n\n### hasIpAddress\n\n### clearIpAddress\n\n### setIpAddress\n\nIP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.\n\n### getIpv6Address\n\nIPv6 address of the interface in the external VPN gateway. This IPv6 address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. Must specify an IPv6 address (not IPV4-mapped) using any format described in RFC 4291 (e.g. 2001:db8:0:0:2d9:51:0:0). The output format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).\n\n### hasIpv6Address\n\n### clearIpv6Address\n\n### setIpv6Address\n\nIPv6 address of the interface in the external VPN gateway. This IPv6 address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. Must specify an IPv6 address (not IPV4-mapped) using any format described in RFC 4291 (e.g. 2001:db8:0:0:2d9:51:0:0). The output format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0)."]]
