Reference documentation and code samples for the Compute V1 Client class VpnGateway.
Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies .
Generated from protobuf message google.cloud.compute.v1.VpnGateway
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
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.
↳ gateway_ip_version
string
The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used. Check the GatewayIpVersion enum for the list of possible values.
↳ id
int|string
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ kind
string
[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
↳ label_fingerprint
string
A fingerprint for the labels being applied to this VpnGateway, 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 a VpnGateway.
↳ labels
array| Google\Protobuf\Internal\MapField
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.
↳ network
string
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
↳ region
string
[Output Only] URL of the region where the VPN gateway resides.
↳ self_link
string
[Output Only] Server-defined URL for the resource.
↳ stack_type
string
The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. Check the StackType enum for the list of possible values.
↳ vpn_interfaces
array< Google\Cloud\Compute\V1\VpnGatewayVpnGatewayInterface
>
The list of VPN interfaces associated with this VPN gateway.
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
var
string
$this
getGatewayIpVersion
The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used.
Check the GatewayIpVersion enum for the list of possible values.
string
hasGatewayIpVersion
clearGatewayIpVersion
setGatewayIpVersion
The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used.
Check the GatewayIpVersion enum for the list of possible values.
var
string
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
var
int|string
$this
getKind
[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
string
hasKind
clearKind
setKind
[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
var
string
$this
getLabelFingerprint
A fingerprint for the labels being applied to this VpnGateway, 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 a VpnGateway.
string
hasLabelFingerprint
clearLabelFingerprint
setLabelFingerprint
A fingerprint for the labels being applied to this VpnGateway, 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 a VpnGateway.
var
string
$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.
setLabels
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.
$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.
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.
var
string
$this
getNetwork
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
string
hasNetwork
clearNetwork
setNetwork
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
var
string
$this
getRegion
[Output Only] URL of the region where the VPN gateway resides.
string
hasRegion
clearRegion
setRegion
[Output Only] URL of the region where the VPN gateway resides.
var
string
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
var
string
$this
getStackType
The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.
Check the StackType enum for the list of possible values.
string
hasStackType
clearStackType
setStackType
The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.
Check the StackType enum for the list of possible values.
var
string
$this
getVpnInterfaces
The list of VPN interfaces associated with this VPN gateway.
setVpnInterfaces
The list of VPN interfaces associated with this VPN gateway.
$this
