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.
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 [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 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.
Generated from protobuf field optional string creation_timestamp = 30525366;
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
Generated from protobuf field optional string description = 422937596;
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;
var
string
$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.
Generated from protobuf field repeated string forwarding_rules = 315821365;
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.
Generated from protobuf field repeated string forwarding_rules = 315821365;
var
string[]
$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;
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;
var
int|string
$this
getKind
[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
Generated from protobuf field optional string kind = 3292052;
string
hasKind
clearKind
setKind
[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
Generated from protobuf field optional string kind = 3292052;
var
string
$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;
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.
Generated from protobuf field optional string name = 3373707;
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.
Generated from protobuf field optional string network = 232872494;
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;
var
string
$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.
Generated from protobuf field optional string region = 138946292;
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.
Generated from protobuf field optional string region = 138946292;
var
string
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
var
string
$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.
Generated from protobuf field optional string status = 181260274;
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.
Generated from protobuf field optional string status = 181260274;
var
string
$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.
Generated from protobuf field repeated string tunnels = 104561931;
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.
Generated from protobuf field repeated string tunnels = 104561931;
var
string[]
$this