Reference documentation and code samples for the Compute V1 Client class ExternalVpnGateway.
Represents an external VPN gateway. External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.
Generated from protobuf messagegoogle.cloud.compute.v1.ExternalVpnGateway
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ creation_timestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
↳ description
string
An optional description of this resource. Provide this property when you create the resource.
↳ id
int|string
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
↳ kind
string
[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
↳ label_fingerprint
string
A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
↳ 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.
↳ redundancy_type
string
Indicates the user-supplied redundancy type of this external VPN gateway. Check the RedundancyType enum for the list of possible values.
↳ self_link
string
[Output Only] Server-defined URL for the resource.
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Returns
Type
Description
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
Returns
Type
Description
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
Type
Description
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getInterfaces
A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
Returns
Type
Description
string
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLabelFingerprint
A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
Returns
Type
Description
string
hasLabelFingerprint
clearLabelFingerprint
setLabelFingerprint
A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLabels
Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression[a-z]([-a-z0-9]*[a-z0-9])?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Returns
Type
Description
string
hasName
clearName
setName
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRedundancyType
Indicates the user-supplied redundancy type of this external VPN gateway.
Check the RedundancyType enum for the list of possible values.
Returns
Type
Description
string
hasRedundancyType
clearRedundancyType
setRedundancyType
Indicates the user-supplied redundancy type of this external VPN gateway.
Check the RedundancyType enum for the list of possible values.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
Returns
Type
Description
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
[[["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 ExternalVpnGateway (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.ExternalVpnGateway)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.ExternalVpnGateway)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.ExternalVpnGateway)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.ExternalVpnGateway)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.ExternalVpnGateway)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.ExternalVpnGateway)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.ExternalVpnGateway)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.ExternalVpnGateway)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.ExternalVpnGateway)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.ExternalVpnGateway)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.ExternalVpnGateway)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.ExternalVpnGateway)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.ExternalVpnGateway)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.ExternalVpnGateway)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.ExternalVpnGateway)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.ExternalVpnGateway)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.ExternalVpnGateway)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.ExternalVpnGateway)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.ExternalVpnGateway)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.ExternalVpnGateway)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.ExternalVpnGateway)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.ExternalVpnGateway)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.ExternalVpnGateway)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.ExternalVpnGateway)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.ExternalVpnGateway)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.ExternalVpnGateway)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.ExternalVpnGateway)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.ExternalVpnGateway)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.ExternalVpnGateway)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.ExternalVpnGateway) \nReference documentation and code samples for the Compute V1 Client class ExternalVpnGateway.\n\nRepresents an external VPN gateway. External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.\n\nGenerated from protobuf message `google.cloud.compute.v1.ExternalVpnGateway`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCreationTimestamp\n\n\\[Output Only\\] Creation timestamp in RFC3339 text format.\n\n### hasCreationTimestamp\n\n### clearCreationTimestamp\n\n### setCreationTimestamp\n\n\\[Output Only\\] Creation timestamp in RFC3339 text format.\n\n### getDescription\n\nAn optional description of this resource. Provide this property when you create the resource.\n\n### hasDescription\n\n### clearDescription\n\n### setDescription\n\nAn optional description of this resource. Provide this property when you create the resource.\n\n### getId\n\n\\[Output Only\\] The unique identifier for the resource. This identifier is defined by the server.\n\n### hasId\n\n### clearId\n\n### setId\n\n\\[Output Only\\] The unique identifier for the resource. This identifier is defined by the server.\n\n### getInterfaces\n\nA list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.\n\n### setInterfaces\n\nA list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.\n\n### getKind\n\n\\[Output Only\\] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.\n\n### hasKind\n\n### clearKind\n\n### setKind\n\n\\[Output Only\\] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.\n\n### getLabelFingerprint\n\nA fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.\n\n### hasLabelFingerprint\n\n### clearLabelFingerprint\n\n### setLabelFingerprint\n\nA fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.\n\n### getLabels\n\nLabels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.\n\n### setLabels\n\nLabels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.\n\n### getName\n\nName 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.\n\n### hasName\n\n### clearName\n\n### setName\n\nName 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.\n\n### getRedundancyType\n\nIndicates the user-supplied redundancy type of this external VPN gateway.\n\nCheck the RedundancyType enum for the list of possible values.\n\n### hasRedundancyType\n\n### clearRedundancyType\n\n### setRedundancyType\n\nIndicates the user-supplied redundancy type of this external VPN gateway.\n\nCheck the RedundancyType enum for the list of possible values.\n\n### getSelfLink\n\n\\[Output Only\\] Server-defined URL for the resource.\n\n### hasSelfLink\n\n### clearSelfLink\n\n### setSelfLink\n\n\\[Output Only\\] Server-defined URL for the resource."]]
