#include <vpn_tunnel.h>

Inheritance diagram for google_compute_api::VpnTunnel:

Public Member Functions
	VpnTunnel (const Json::Value &storage)

	VpnTunnel (Json::Value *storage)

virtual	~VpnTunnel ()

const StringPiece	GetTypeName () const

bool	has_creation_timestamp () const

void	clear_creation_timestamp ()

const StringPiece	get_creation_timestamp () const

void	set_creation_timestamp (const StringPiece &value)

bool	has_description () const

void	clear_description ()

const StringPiece	get_description () const

void	set_description (const StringPiece &value)

bool	has_detailed_status () const

void	clear_detailed_status ()

const StringPiece	get_detailed_status () const

void	set_detailed_status (const StringPiece &value)

bool	has_id () const

void	clear_id ()

uint64	get_id () const

void	set_id (uint64 value)

bool	has_ike_version () const

void	clear_ike_version ()

int32	get_ike_version () const

void	set_ike_version (int32 value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_local_traffic_selector () const

void	clear_local_traffic_selector ()

const client::JsonCppArray< string >	get_local_traffic_selector () const

client::JsonCppArray< string >	mutable_localTrafficSelector ()

bool	has_name () const

void	clear_name ()

const StringPiece	get_name () const

void	set_name (const StringPiece &value)

bool	has_peer_ip () const

void	clear_peer_ip ()

const StringPiece	get_peer_ip () const

void	set_peer_ip (const StringPiece &value)

bool	has_region () const

void	clear_region ()

const StringPiece	get_region () const

void	set_region (const StringPiece &value)

bool	has_remote_traffic_selector () const

void	clear_remote_traffic_selector ()

const client::JsonCppArray< string >	get_remote_traffic_selector () const

client::JsonCppArray< string >	mutable_remoteTrafficSelector ()

bool	has_router () const

void	clear_router ()

const StringPiece	get_router () const

void	set_router (const StringPiece &value)

bool	has_self_link () const

void	clear_self_link ()

const StringPiece	get_self_link () const

void	set_self_link (const StringPiece &value)

bool	has_shared_secret () const

void	clear_shared_secret ()

const StringPiece	get_shared_secret () const

void	set_shared_secret (const StringPiece &value)

bool	has_shared_secret_hash () const

void	clear_shared_secret_hash ()

const StringPiece	get_shared_secret_hash () const

void	set_shared_secret_hash (const StringPiece &value)

bool	has_status () const

void	clear_status ()

const StringPiece	get_status () const

void	set_status (const StringPiece &value)

bool	has_target_vpn_gateway () const

void	clear_target_vpn_gateway ()

const StringPiece	get_target_vpn_gateway () const

void	set_target_vpn_gateway (const StringPiece &value)

Static Public Member Functions
static VpnTunnel *	New ()

Detailed Description

VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==).

Constructor & Destructor Documentation

◆ VpnTunnel() [1/2]

google_compute_api::VpnTunnel::VpnTunnel ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ VpnTunnel() [2/2]

google_compute_api::VpnTunnel::VpnTunnel ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~VpnTunnel()

google_compute_api::VpnTunnel::~VpnTunnel ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_creation_timestamp()

void google_compute_api::VpnTunnel::clear_creation_timestamp ( )

inline

Clears the 'creationTimestamp' attribute.

◆ clear_description()

void google_compute_api::VpnTunnel::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_detailed_status()

void google_compute_api::VpnTunnel::clear_detailed_status ( )

inline

Clears the 'detailedStatus' attribute.

◆ clear_id()

void google_compute_api::VpnTunnel::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_ike_version()

void google_compute_api::VpnTunnel::clear_ike_version ( )

inline

Clears the 'ikeVersion' attribute.

◆ clear_kind()

void google_compute_api::VpnTunnel::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_local_traffic_selector()

void google_compute_api::VpnTunnel::clear_local_traffic_selector ( )

inline

Clears the 'localTrafficSelector' attribute.

◆ clear_name()

void google_compute_api::VpnTunnel::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_peer_ip()

void google_compute_api::VpnTunnel::clear_peer_ip ( )

inline

Clears the 'peerIp' attribute.

◆ clear_region()

void google_compute_api::VpnTunnel::clear_region ( )

inline

Clears the 'region' attribute.

◆ clear_remote_traffic_selector()

void google_compute_api::VpnTunnel::clear_remote_traffic_selector ( )

inline

Clears the 'remoteTrafficSelector' attribute.

◆ clear_router()

void google_compute_api::VpnTunnel::clear_router ( )

inline

Clears the 'router' attribute.

◆ clear_self_link()

void google_compute_api::VpnTunnel::clear_self_link ( )

inline

Clears the 'selfLink' attribute.

◆ clear_shared_secret()

void google_compute_api::VpnTunnel::clear_shared_secret ( )

inline

Clears the 'sharedSecret' attribute.

◆ clear_shared_secret_hash()

void google_compute_api::VpnTunnel::clear_shared_secret_hash ( )

inline

Clears the 'sharedSecretHash' attribute.

◆ clear_status()

void google_compute_api::VpnTunnel::clear_status ( )

inline

Clears the 'status' attribute.

◆ clear_target_vpn_gateway()

void google_compute_api::VpnTunnel::clear_target_vpn_gateway ( )

inline

Clears the 'targetVpnGateway' attribute.

◆ get_creation_timestamp()

const StringPiece google_compute_api::VpnTunnel::get_creation_timestamp ( ) const

inline

Get the value of the 'creationTimestamp' attribute.

◆ get_description()

const StringPiece google_compute_api::VpnTunnel::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_detailed_status()

const StringPiece google_compute_api::VpnTunnel::get_detailed_status ( ) const

inline

Get the value of the 'detailedStatus' attribute.

◆ get_id()

uint64 google_compute_api::VpnTunnel::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_ike_version()

int32 google_compute_api::VpnTunnel::get_ike_version ( ) const

inline

Get the value of the 'ikeVersion' attribute.

◆ get_kind()

const StringPiece google_compute_api::VpnTunnel::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_local_traffic_selector()

const client::JsonCppArray<string > google_compute_api::VpnTunnel::get_local_traffic_selector ( ) const

inline

Get a reference to the value of the 'localTrafficSelector' attribute.

◆ get_name()

const StringPiece google_compute_api::VpnTunnel::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_peer_ip()

const StringPiece google_compute_api::VpnTunnel::get_peer_ip ( ) const

inline

Get the value of the 'peerIp' attribute.

◆ get_region()

const StringPiece google_compute_api::VpnTunnel::get_region ( ) const

inline

Get the value of the 'region' attribute.

◆ get_remote_traffic_selector()

const client::JsonCppArray<string > google_compute_api::VpnTunnel::get_remote_traffic_selector ( ) const

inline

Get a reference to the value of the 'remoteTrafficSelector' attribute.

◆ get_router()

const StringPiece google_compute_api::VpnTunnel::get_router ( ) const

inline

Get the value of the 'router' attribute.

◆ get_self_link()

const StringPiece google_compute_api::VpnTunnel::get_self_link ( ) const

inline

Get the value of the 'selfLink' attribute.

◆ get_shared_secret()

const StringPiece google_compute_api::VpnTunnel::get_shared_secret ( ) const

inline

Get the value of the 'sharedSecret' attribute.

◆ get_shared_secret_hash()

const StringPiece google_compute_api::VpnTunnel::get_shared_secret_hash ( ) const

inline

Get the value of the 'sharedSecretHash' attribute.

◆ get_status()

const StringPiece google_compute_api::VpnTunnel::get_status ( ) const

inline

Get the value of the 'status' attribute.

◆ get_target_vpn_gateway()

const StringPiece google_compute_api::VpnTunnel::get_target_vpn_gateway ( ) const

inline

Get the value of the 'targetVpnGateway' attribute.

◆ GetTypeName()

const StringPiece google_compute_api::VpnTunnel::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_compute_api::VpnTunnel

◆ has_creation_timestamp()

bool google_compute_api::VpnTunnel::has_creation_timestamp ( ) const

inline

Determine if the 'creationTimestamp' attribute was set.

Returns: true if the 'creationTimestamp' attribute was set.

◆ has_description()

bool google_compute_api::VpnTunnel::has_description ( ) const

inline

Determine if the 'description' attribute was set.

Returns: true if the 'description' attribute was set.

◆ has_detailed_status()

bool google_compute_api::VpnTunnel::has_detailed_status ( ) const

inline

Determine if the 'detailedStatus' attribute was set.

Returns: true if the 'detailedStatus' attribute was set.

◆ has_id()

bool google_compute_api::VpnTunnel::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_ike_version()

bool google_compute_api::VpnTunnel::has_ike_version ( ) const

inline

Determine if the 'ikeVersion' attribute was set.

Returns: true if the 'ikeVersion' attribute was set.

◆ has_kind()

bool google_compute_api::VpnTunnel::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_local_traffic_selector()

bool google_compute_api::VpnTunnel::has_local_traffic_selector ( ) const

inline

Determine if the 'localTrafficSelector' attribute was set.

Returns: true if the 'localTrafficSelector' attribute was set.

◆ has_name()

bool google_compute_api::VpnTunnel::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns: true if the 'name' attribute was set.

◆ has_peer_ip()

bool google_compute_api::VpnTunnel::has_peer_ip ( ) const

inline

Determine if the 'peerIp' attribute was set.

Returns: true if the 'peerIp' attribute was set.

◆ has_region()

bool google_compute_api::VpnTunnel::has_region ( ) const

inline

Determine if the 'region' attribute was set.

Returns: true if the 'region' attribute was set.

◆ has_remote_traffic_selector()

bool google_compute_api::VpnTunnel::has_remote_traffic_selector ( ) const

inline

Determine if the 'remoteTrafficSelector' attribute was set.

Returns: true if the 'remoteTrafficSelector' attribute was set.

◆ has_router()

bool google_compute_api::VpnTunnel::has_router ( ) const

inline

Determine if the 'router' attribute was set.

Returns: true if the 'router' attribute was set.

◆ has_self_link()

bool google_compute_api::VpnTunnel::has_self_link ( ) const

inline

Determine if the 'selfLink' attribute was set.

Returns: true if the 'selfLink' attribute was set.

◆ has_shared_secret()

bool google_compute_api::VpnTunnel::has_shared_secret ( ) const

inline

Determine if the 'sharedSecret' attribute was set.

Returns: true if the 'sharedSecret' attribute was set.

◆ has_shared_secret_hash()

bool google_compute_api::VpnTunnel::has_shared_secret_hash ( ) const

inline

Determine if the 'sharedSecretHash' attribute was set.

Returns: true if the 'sharedSecretHash' attribute was set.

◆ has_status()

bool google_compute_api::VpnTunnel::has_status ( ) const

inline

Determine if the 'status' attribute was set.

Returns: true if the 'status' attribute was set.

◆ has_target_vpn_gateway()

bool google_compute_api::VpnTunnel::has_target_vpn_gateway ( ) const

inline

Determine if the 'targetVpnGateway' attribute was set.

Returns: true if the 'targetVpnGateway' attribute was set.

◆ mutable_localTrafficSelector()

client::JsonCppArray<string > google_compute_api::VpnTunnel::mutable_localTrafficSelector ( )

inline

Gets a reference to a mutable value of the 'localTrafficSelector' property.

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: The result can be modified to change the attribute value.

◆ mutable_remoteTrafficSelector()

client::JsonCppArray<string > google_compute_api::VpnTunnel::mutable_remoteTrafficSelector ( )

inline

Gets a reference to a mutable value of the 'remoteTrafficSelector' property.

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: The result can be modified to change the attribute value.

◆ New()

VpnTunnel * google_compute_api::VpnTunnel::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_creation_timestamp()

void google_compute_api::VpnTunnel::set_creation_timestamp ( const StringPiece & value )

inline

Change the 'creationTimestamp' attribute.

[Output Only] Creation timestamp in RFC3339 text format.

Parameters

[in] value The new value.

◆ set_description()

void google_compute_api::VpnTunnel::set_description ( const StringPiece & value )

inline

Change the 'description' attribute.

An optional description of this resource. Provide this property when you create the resource.

Parameters

[in] value The new value.

◆ set_detailed_status()

void google_compute_api::VpnTunnel::set_detailed_status ( const StringPiece & value )

inline

Change the 'detailedStatus' attribute.

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

Parameters

[in] value The new value.

◆ set_id()

void google_compute_api::VpnTunnel::set_id ( uint64 value )

inline

Change the 'id' attribute.

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters

[in] value The new value.

◆ set_ike_version()

void google_compute_api::VpnTunnel::set_ike_version ( int32 value )

inline

Change the 'ikeVersion' attribute.

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.

Parameters

[in] value The new value.

◆ set_kind()

void google_compute_api::VpnTunnel::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

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

Parameters

[in] value The new value.

◆ set_name()

void google_compute_api::VpnTunnel::set_name ( const StringPiece & value )

inline

Change the 'name' attribute.

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.

Parameters

[in] value The new value.

◆ set_peer_ip()

void google_compute_api::VpnTunnel::set_peer_ip ( const StringPiece & value )

inline

Change the 'peerIp' attribute.

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

Parameters

[in] value The new value.

◆ set_region()

void google_compute_api::VpnTunnel::set_region ( const StringPiece & value )

inline

Change the 'region' attribute.

[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.

Parameters

[in] value The new value.

◆ set_router()

void google_compute_api::VpnTunnel::set_router ( const StringPiece & value )

inline

Change the 'router' attribute.

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

Parameters

[in] value The new value.

◆ set_self_link()

void google_compute_api::VpnTunnel::set_self_link ( const StringPiece & value )

inline

Change the 'selfLink' attribute.

[Output Only] Server-defined URL for the resource.

Parameters

[in] value The new value.

◆ set_shared_secret()

void google_compute_api::VpnTunnel::set_shared_secret ( const StringPiece & value )

inline

Change the 'sharedSecret' attribute.

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

Parameters

[in] value The new value.

◆ set_shared_secret_hash()

void google_compute_api::VpnTunnel::set_shared_secret_hash ( const StringPiece & value )

inline

Change the 'sharedSecretHash' attribute.

Hash of the shared secret.

Parameters

[in] value The new value.

◆ set_status()

void google_compute_api::VpnTunnel::set_status ( const StringPiece & value )

inline

Change the 'status' attribute.

[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.

Parameters

[in] value The new value.

◆ set_target_vpn_gateway()

void google_compute_api::VpnTunnel::set_target_vpn_gateway ( const StringPiece & value )

inline

Change the 'targetVpnGateway' attribute.

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

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/compute_api/vpn_tunnel.h
google/compute_api/vpn_tunnel.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VpnTunnel() [1/2]

◆ VpnTunnel() [2/2]

◆ ~VpnTunnel()

Member Function Documentation

◆ clear_creation_timestamp()

◆ clear_description()

◆ clear_detailed_status()

◆ clear_id()

◆ clear_ike_version()

◆ clear_kind()

◆ clear_local_traffic_selector()

◆ clear_name()

◆ clear_peer_ip()

◆ clear_region()

◆ clear_remote_traffic_selector()

◆ clear_router()

◆ clear_self_link()

◆ clear_shared_secret()

◆ clear_shared_secret_hash()

◆ clear_status()

◆ clear_target_vpn_gateway()

◆ get_creation_timestamp()

◆ get_description()

◆ get_detailed_status()

◆ get_id()

◆ get_ike_version()

◆ get_kind()

◆ get_local_traffic_selector()

◆ get_name()

◆ get_peer_ip()

◆ get_region()

◆ get_remote_traffic_selector()

◆ get_router()

◆ get_self_link()

◆ get_shared_secret()

◆ get_shared_secret_hash()

◆ get_status()

◆ get_target_vpn_gateway()

◆ GetTypeName()

◆ has_creation_timestamp()

◆ has_description()

◆ has_detailed_status()

◆ has_id()

◆ has_ike_version()

◆ has_kind()

◆ has_local_traffic_selector()

◆ has_name()

◆ has_peer_ip()

◆ has_region()

◆ has_remote_traffic_selector()

◆ has_router()

◆ has_self_link()

◆ has_shared_secret()

◆ has_shared_secret_hash()

◆ has_status()

◆ has_target_vpn_gateway()

◆ mutable_localTrafficSelector()

◆ mutable_remoteTrafficSelector()

◆ New()

◆ set_creation_timestamp()

◆ set_description()

◆ set_detailed_status()

◆ set_id()

◆ set_ike_version()

◆ set_kind()

◆ set_name()

◆ set_peer_ip()

◆ set_region()

◆ set_router()

◆ set_self_link()

◆ set_shared_secret()

◆ set_shared_secret_hash()

◆ set_status()

◆ set_target_vpn_gateway()