Compute V1 Client - Class VpnTunnel (1.9.1)

Reference documentation and code samples for the Compute V1 Client class VpnTunnel.

Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.

Generated from protobuf message google.cloud.compute.v1.VpnTunnel

Namespace

Google \ Cloud \ Compute \ V1

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.
`↳ detailed_status`	`string` [Output Only] Detailed status message for the VPN tunnel.
`↳ id`	`int\|string` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`↳ ike_version`	`int` IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
`↳ kind`	`string` [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
`↳ local_traffic_selector`	`array` Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
`↳ 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.
`↳ peer_external_gateway`	`string` URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
`↳ peer_external_gateway_interface`	`int` The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type.
`↳ peer_gcp_gateway`	`string` URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway.
`↳ peer_ip`	`string` IP address of the peer VPN gateway. Only IPv4 is supported.
`↳ region`	`string` [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`↳ remote_traffic_selector`	`array` Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
`↳ router`	`string` URL of the router resource to be used for dynamic routing.
`↳ self_link`	`string` [Output Only] Server-defined URL for the resource.
`↳ shared_secret`	`string` Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
`↳ shared_secret_hash`	`string` Hash of the shared secret.
`↳ status`	`string` [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. Check the Status enum for the list of possible values.
`↳ target_vpn_gateway`	`string` URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
`↳ vpn_gateway`	`string` URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
`↳ vpn_gateway_interface`	`int` The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`.

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`

getDetailedStatus

[Output Only] Detailed status message for the VPN tunnel.

Returns
Type	Description
`string`

hasDetailedStatus

clearDetailedStatus

setDetailedStatus

[Output Only] Detailed status message for the VPN tunnel.

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`

getIkeVersion

IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.

Returns
Type	Description
`int`

hasIkeVersion

clearIkeVersion

setIkeVersion

IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getKind

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

Returns
Type	Description
`string`

hasKind

clearKind

setKind

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLocalTrafficSelector

Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.

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

setLocalTrafficSelector

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPeerExternalGateway

URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.

Returns
Type	Description
`string`

hasPeerExternalGateway

clearPeerExternalGateway

setPeerExternalGateway

URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPeerExternalGatewayInterface

The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type.

Returns
Type	Description
`int`

hasPeerExternalGatewayInterface

clearPeerExternalGatewayInterface

setPeerExternalGatewayInterface

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPeerGcpGateway

URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway.

Returns
Type	Description
`string`

hasPeerGcpGateway

clearPeerGcpGateway

setPeerGcpGateway

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPeerIp

IP address of the peer VPN gateway. Only IPv4 is supported.

Returns
Type	Description
`string`

hasPeerIp

clearPeerIp

setPeerIp

IP address of the peer VPN gateway. Only IPv4 is supported.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRegion

[Output Only] URL of the region where the VPN tunnel 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 VPN tunnel 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`

getRemoteTrafficSelector

Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.

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

setRemoteTrafficSelector

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getRouter

URL of the router resource to be used for dynamic routing.

Returns
Type	Description
`string`

hasRouter

clearRouter

setRouter

URL of the router resource to be used for dynamic routing.

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`

getSharedSecret

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

Returns
Type	Description
`string`

hasSharedSecret

clearSharedSecret

setSharedSecret

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSharedSecretHash

Hash of the shared secret.

Returns
Type	Description
`string`

hasSharedSecretHash

clearSharedSecretHash

setSharedSecretHash

Hash of the shared secret.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStatus

[Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.

Check the Status enum for the list of possible values.

Returns
Type	Description
`string`

hasStatus

clearStatus

setStatus

Check the Status enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTargetVpnGateway

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

Returns
Type	Description
`string`

hasTargetVpnGateway

clearTargetVpnGateway

setTargetVpnGateway

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVpnGateway

URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.

Returns
Type	Description
`string`

hasVpnGateway

clearVpnGateway

setVpnGateway

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVpnGatewayInterface

The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

Returns
Type	Description
`int`

hasVpnGatewayInterface

clearVpnGatewayInterface

setVpnGatewayInterface

The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`