Compute V1 Client - Class VpnGateway (1.5.0)

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

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.
`↳ 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 an 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.

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

An optional description of this resource. Provide this property when you create the resource.

Generated from protobuf field optional string description = 422937596;

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Generated from protobuf field optional string description = 422937596;

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.

Generated from protobuf field optional uint64 id = 3355;

Returns
Type	Description
`int\|string`

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Generated from protobuf field optional uint64 id = 3355;

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getKind

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

Generated from protobuf field optional string kind = 3292052;

Returns
Type	Description
`string`

hasKind

clearKind

setKind

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

Generated from protobuf field optional string kind = 3292052;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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 an VpnGateway.

Generated from protobuf field optional string label_fingerprint = 178124825;

Returns
Type	Description
`string`

hasLabelFingerprint

clearLabelFingerprint

setLabelFingerprint

Generated from protobuf field optional string label_fingerprint = 178124825;

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.

Generated from protobuf field map<string, string> labels = 500195327;

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

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.

Generated from protobuf field map<string, string> labels = 500195327;

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$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.

Generated from protobuf field optional string name = 3373707;

Returns
Type	Description
`string`

hasName

clearName

setName

Generated from protobuf field optional string name = 3373707;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getNetwork

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

Generated from protobuf field optional string network = 232872494;

Returns
Type	Description
`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.

Generated from protobuf field optional string network = 232872494;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRegion

[Output Only] URL of the region where the VPN gateway resides.

Generated from protobuf field optional string region = 138946292;

Returns
Type	Description
`string`

hasRegion

clearRegion

setRegion

[Output Only] URL of the region where the VPN gateway resides.

Generated from protobuf field optional string region = 138946292;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSelfLink

[Output Only] Server-defined URL for the resource.

Generated from protobuf field optional string self_link = 456214797;

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined URL for the resource.

Generated from protobuf field optional string self_link = 456214797;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Generated from protobuf field optional string stack_type = 425908881;

Returns
Type	Description
`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.

Generated from protobuf field optional string stack_type = 425908881;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVpnInterfaces

The list of VPN interfaces associated with this VPN gateway.

Generated from protobuf field repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setVpnInterfaces

The list of VPN interfaces associated with this VPN gateway.

Generated from protobuf field repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\VpnGatewayVpnGatewayInterface>`

Returns
Type	Description
`$this`