REST Resource: targetVpnGateways

Resource: TargetVpnGateway

Represents a Target VPN Gateway resource.

The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "network": string,
  "tunnels": [
    string
  ],
  "status": enum (Status),
  "selfLink": string,
  "forwardingRules": [
    string
  ],
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string
}
Fields
kind

string

[Output Only] Type of resource. Always

compute#targetVpnGateway

for target VPN gateways.
id

string (uint64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
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.
description

string

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

string

[Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
network

string

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

string

[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the

compute.vpntunnels.insert

method and associated with a VPN gateway.
status

enum (Status)

[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
forwardingRules[]

string

[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using

compute.forwardingRules.insert

and associated with a VPN gateway.
labels

map (key: string, value: string)

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.
labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this TargetVpnGateway, 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 TargetVpnGateway.

A base64-encoded string.

Status

Enums
CREATING
READY
FAILED
DELETING

Methods

aggregatedList

 The method compute.v1.TargetVpnGatewaysService.AggregatedList is not available in this (s3nsapis.fr) universe.

delete

 The method compute.v1.TargetVpnGatewaysService.Delete is not available in this (s3nsapis.fr) universe.

get

 The method compute.v1.TargetVpnGatewaysService.Get is not available in this (s3nsapis.fr) universe.

insert

 The method compute.v1.TargetVpnGatewaysService.Insert is not available in this (s3nsapis.fr) universe.

list

 The method compute.v1.TargetVpnGatewaysService.List is not available in this (s3nsapis.fr) universe.

setLabels

 The method compute.v1.TargetVpnGatewaysService.SetLabels is not available in this (s3nsapis.fr) universe.