Reference documentation and code samples for the Compute V1 Client class 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.
Generated from protobuf message google.cloud.compute.v1.TargetVpnGateway
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. |
↳ forwarding_rules |
array
[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. |
↳ 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#targetVpnGateway for target VPN gateways. |
↳ 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 |
↳ 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 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. |
↳ self_link |
string
[Output Only] Server-defined URL for the resource. |
↳ status |
string
[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. Check the Status enum for the list of possible values. |
↳ tunnels |
array
[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. |
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 | |
getForwardingRules
[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setForwardingRules
[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
| 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 | |
getKind
[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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.
| 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 | |
getNetwork
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRegion
[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.
| Returns | |
|---|---|
| Type | Description |
string | |
hasRegion
clearRegion
setRegion
[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.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
Check the Status enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasStatus
clearStatus
setStatus
[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
Check the Status enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTunnels
[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setTunnels
[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |