Compute V1 Client - Class VpnGatewayStatusVpnConnection (1.8.3)

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

A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ peer_external_gateway string

URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

↳ peer_gcp_gateway string

URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

↳ state Google\Cloud\Compute\V1\VpnGatewayStatusHighAvailabilityRequirementState

HighAvailabilityRequirementState for the VPN connection.

↳ tunnels array<Google\Cloud\Compute\V1\VpnGatewayStatusTunnel>

List of VPN tunnels that are in this VPN connection.

getPeerExternalGateway

URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

Returns
TypeDescription
string

hasPeerExternalGateway

clearPeerExternalGateway

setPeerExternalGateway

URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPeerGcpGateway

URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

Returns
TypeDescription
string

hasPeerGcpGateway

clearPeerGcpGateway

setPeerGcpGateway

URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

HighAvailabilityRequirementState for the VPN connection.

Returns
TypeDescription
Google\Cloud\Compute\V1\VpnGatewayStatusHighAvailabilityRequirementState|null

hasState

clearState

setState

HighAvailabilityRequirementState for the VPN connection.

Parameter
NameDescription
var Google\Cloud\Compute\V1\VpnGatewayStatusHighAvailabilityRequirementState
Returns
TypeDescription
$this

getTunnels

List of VPN tunnels that are in this VPN connection.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTunnels

List of VPN tunnels that are in this VPN connection.

Parameter
NameDescription
var array<Google\Cloud\Compute\V1\VpnGatewayStatusTunnel>
Returns
TypeDescription
$this