VpnTunnel

google.cloud.compute.v1. VpnTunnel

Represents a VpnTunnel.

Constructor

new VpnTunnel(propertiesopt)

Constructs a new VpnTunnel.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IVpnTunnel <optional>

Properties to set

Implements:
  • IVpnTunnel

Members

_creationTimestamp

VpnTunnel _creationTimestamp.

_description

VpnTunnel _description.

_detailedStatus

VpnTunnel _detailedStatus.

_id

VpnTunnel _id.

_ikeVersion

VpnTunnel _ikeVersion.

_kind

VpnTunnel _kind.

_name

VpnTunnel _name.

_peerExternalGateway

VpnTunnel _peerExternalGateway.

_peerExternalGatewayInterface

VpnTunnel _peerExternalGatewayInterface.

_peerGcpGateway

VpnTunnel _peerGcpGateway.

_peerIp

VpnTunnel _peerIp.

_region

VpnTunnel _region.

_router

VpnTunnel _router.

VpnTunnel _selfLink.

_sharedSecret

VpnTunnel _sharedSecret.

_sharedSecretHash

VpnTunnel _sharedSecretHash.

_status

VpnTunnel _status.

_targetVpnGateway

VpnTunnel _targetVpnGateway.

_vpnGateway

VpnTunnel _vpnGateway.

_vpnGatewayInterface

VpnTunnel _vpnGatewayInterface.

creationTimestamp

VpnTunnel creationTimestamp.

description

VpnTunnel description.

detailedStatus

VpnTunnel detailedStatus.

id

VpnTunnel id.

ikeVersion

VpnTunnel ikeVersion.

kind

VpnTunnel kind.

localTrafficSelector

VpnTunnel localTrafficSelector.

name

VpnTunnel name.

peerExternalGateway

VpnTunnel peerExternalGateway.

peerExternalGatewayInterface

VpnTunnel peerExternalGatewayInterface.

peerGcpGateway

VpnTunnel peerGcpGateway.

peerIp

VpnTunnel peerIp.

region

VpnTunnel region.

remoteTrafficSelector

VpnTunnel remoteTrafficSelector.

router

VpnTunnel router.

VpnTunnel selfLink.

sharedSecret

VpnTunnel sharedSecret.

sharedSecretHash

VpnTunnel sharedSecretHash.

status

VpnTunnel status.

targetVpnGateway

VpnTunnel targetVpnGateway.

vpnGateway

VpnTunnel vpnGateway.

vpnGatewayInterface

VpnTunnel vpnGatewayInterface.

Status

Status enum.

Properties:
Name Type Description
UNDEFINED_STATUS number

UNDEFINED_STATUS value

ALLOCATING_RESOURCES number

ALLOCATING_RESOURCES value

AUTHORIZATION_ERROR number

AUTHORIZATION_ERROR value

DEPROVISIONING number

DEPROVISIONING value

ESTABLISHED number

ESTABLISHED value

FAILED number

FAILED value

FIRST_HANDSHAKE number

FIRST_HANDSHAKE value

NEGOTIATION_FAILURE number

NEGOTIATION_FAILURE value

NETWORK_ERROR number

NETWORK_ERROR value

NO_INCOMING_PACKETS number

NO_INCOMING_PACKETS value

PROVISIONING number

PROVISIONING value

REJECTED number

REJECTED value

STOPPED number

STOPPED value

WAITING_FOR_FULL_CONFIG number

WAITING_FOR_FULL_CONFIG value

Methods

toJSON() → {Object.<string, *>}

Converts this VpnTunnel to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.compute.v1.VpnTunnel}

Creates a new VpnTunnel instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IVpnTunnel <optional>

Properties to set

Returns:
Type Description
google.cloud.compute.v1.VpnTunnel

VpnTunnel instance

(static) decode(reader, lengthopt) → {google.cloud.compute.v1.VpnTunnel}

Decodes a VpnTunnel message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.compute.v1.VpnTunnel

VpnTunnel

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.compute.v1.VpnTunnel}

Decodes a VpnTunnel message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.compute.v1.VpnTunnel

VpnTunnel

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified VpnTunnel message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IVpnTunnel

VpnTunnel message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified VpnTunnel message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IVpnTunnel

VpnTunnel message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.compute.v1.VpnTunnel}

Creates a VpnTunnel message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.compute.v1.VpnTunnel

VpnTunnel

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for VpnTunnel

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a VpnTunnel message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.VpnTunnel

VpnTunnel

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a VpnTunnel message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not