compute  v1
Public Member Functions | Static Public Member Functions | List of all members
google_compute_api::NetworkPeering Class Reference

#include <network_peering.h>

Inheritance diagram for google_compute_api::NetworkPeering:

Public Member Functions

 NetworkPeering (const Json::Value &storage)
 
 NetworkPeering (Json::Value *storage)
 
virtual ~NetworkPeering ()
 
const StringPiece GetTypeName () const
 
bool has_auto_create_routes () const
 
void clear_auto_create_routes ()
 
bool get_auto_create_routes () const
 
void set_auto_create_routes (bool value)
 
bool has_exchange_subnet_routes () const
 
void clear_exchange_subnet_routes ()
 
bool get_exchange_subnet_routes () const
 
void set_exchange_subnet_routes (bool value)
 
bool has_name () const
 
void clear_name ()
 
const StringPiece get_name () const
 
void set_name (const StringPiece &value)
 
bool has_network () const
 
void clear_network ()
 
const StringPiece get_network () const
 
void set_network (const StringPiece &value)
 
bool has_state () const
 
void clear_state ()
 
const StringPiece get_state () const
 
void set_state (const StringPiece &value)
 
bool has_state_details () const
 
void clear_state_details ()
 
const StringPiece get_state_details () const
 
void set_state_details (const StringPiece &value)
 

Static Public Member Functions

static NetworkPeeringNew ()
 

Detailed Description

A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.

Constructor & Destructor Documentation

◆ NetworkPeering() [1/2]

google_compute_api::NetworkPeering::NetworkPeering ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ NetworkPeering() [2/2]

google_compute_api::NetworkPeering::NetworkPeering ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~NetworkPeering()

google_compute_api::NetworkPeering::~NetworkPeering ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_auto_create_routes()

void google_compute_api::NetworkPeering::clear_auto_create_routes ( )
inline

Clears the 'autoCreateRoutes' attribute.

◆ clear_exchange_subnet_routes()

void google_compute_api::NetworkPeering::clear_exchange_subnet_routes ( )
inline

Clears the 'exchangeSubnetRoutes' attribute.

◆ clear_name()

void google_compute_api::NetworkPeering::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_network()

void google_compute_api::NetworkPeering::clear_network ( )
inline

Clears the 'network' attribute.

◆ clear_state()

void google_compute_api::NetworkPeering::clear_state ( )
inline

Clears the 'state' attribute.

◆ clear_state_details()

void google_compute_api::NetworkPeering::clear_state_details ( )
inline

Clears the 'stateDetails' attribute.

◆ get_auto_create_routes()

bool google_compute_api::NetworkPeering::get_auto_create_routes ( ) const
inline

Get the value of the 'autoCreateRoutes' attribute.

◆ get_exchange_subnet_routes()

bool google_compute_api::NetworkPeering::get_exchange_subnet_routes ( ) const
inline

Get the value of the 'exchangeSubnetRoutes' attribute.

◆ get_name()

const StringPiece google_compute_api::NetworkPeering::get_name ( ) const
inline

Get the value of the 'name' attribute.

◆ get_network()

const StringPiece google_compute_api::NetworkPeering::get_network ( ) const
inline

Get the value of the 'network' attribute.

◆ get_state()

const StringPiece google_compute_api::NetworkPeering::get_state ( ) const
inline

Get the value of the 'state' attribute.

◆ get_state_details()

const StringPiece google_compute_api::NetworkPeering::get_state_details ( ) const
inline

Get the value of the 'stateDetails' attribute.

◆ GetTypeName()

const StringPiece google_compute_api::NetworkPeering::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_compute_api::NetworkPeering

◆ has_auto_create_routes()

bool google_compute_api::NetworkPeering::has_auto_create_routes ( ) const
inline

Determine if the 'autoCreateRoutes' attribute was set.

Returns
true if the 'autoCreateRoutes' attribute was set.

◆ has_exchange_subnet_routes()

bool google_compute_api::NetworkPeering::has_exchange_subnet_routes ( ) const
inline

Determine if the 'exchangeSubnetRoutes' attribute was set.

Returns
true if the 'exchangeSubnetRoutes' attribute was set.

◆ has_name()

bool google_compute_api::NetworkPeering::has_name ( ) const
inline

Determine if the 'name' attribute was set.

Returns
true if the 'name' attribute was set.

◆ has_network()

bool google_compute_api::NetworkPeering::has_network ( ) const
inline

Determine if the 'network' attribute was set.

Returns
true if the 'network' attribute was set.

◆ has_state()

bool google_compute_api::NetworkPeering::has_state ( ) const
inline

Determine if the 'state' attribute was set.

Returns
true if the 'state' attribute was set.

◆ has_state_details()

bool google_compute_api::NetworkPeering::has_state_details ( ) const
inline

Determine if the 'stateDetails' attribute was set.

Returns
true if the 'stateDetails' attribute was set.

◆ New()

NetworkPeering * google_compute_api::NetworkPeering::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_auto_create_routes()

void google_compute_api::NetworkPeering::set_auto_create_routes ( bool  value)
inline

Change the 'autoCreateRoutes' attribute.

This field will be deprecated soon. Prefer using exchange_subnet_routes instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network.

Parameters
[in]valueThe new value.

◆ set_exchange_subnet_routes()

void google_compute_api::NetworkPeering::set_exchange_subnet_routes ( bool  value)
inline

Change the 'exchangeSubnetRoutes' attribute.

Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network.

Parameters
[in]valueThe new value.

◆ set_name()

void google_compute_api::NetworkPeering::set_name ( const StringPiece &  value)
inline

Change the 'name' attribute.

Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameters
[in]valueThe new value.

◆ set_network()

void google_compute_api::NetworkPeering::set_network ( const StringPiece &  value)
inline

Change the 'network' attribute.

The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.

Parameters
[in]valueThe new value.

◆ set_state()

void google_compute_api::NetworkPeering::set_state ( const StringPiece &  value)
inline

Change the 'state' attribute.

[Output Only] State for the peering.

Parameters
[in]valueThe new value.

◆ set_state_details()

void google_compute_api::NetworkPeering::set_state_details ( const StringPiece &  value)
inline

Change the 'stateDetails' attribute.

[Output Only] Details about the current state of the peering.

Parameters
[in]valueThe new value.

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