#include <route.h>

Inheritance diagram for google_compute_api::Route:

Classes
class	RouteWarnings

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

	Route (Json::Value *storage)

virtual	~Route ()

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_dest_range () const

void	clear_dest_range ()

const StringPiece	get_dest_range () const

void	set_dest_range (const StringPiece &value)

bool	has_id () const

void	clear_id ()

uint64	get_id () const

void	set_id (uint64 value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &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_next_hop_gateway () const

void	clear_next_hop_gateway ()

const StringPiece	get_next_hop_gateway () const

void	set_next_hop_gateway (const StringPiece &value)

bool	has_next_hop_instance () const

void	clear_next_hop_instance ()

const StringPiece	get_next_hop_instance () const

void	set_next_hop_instance (const StringPiece &value)

bool	has_next_hop_ip () const

void	clear_next_hop_ip ()

const StringPiece	get_next_hop_ip () const

void	set_next_hop_ip (const StringPiece &value)

bool	has_next_hop_network () const

void	clear_next_hop_network ()

const StringPiece	get_next_hop_network () const

void	set_next_hop_network (const StringPiece &value)

bool	has_next_hop_peering () const

void	clear_next_hop_peering ()

const StringPiece	get_next_hop_peering () const

void	set_next_hop_peering (const StringPiece &value)

bool	has_next_hop_vpn_tunnel () const

void	clear_next_hop_vpn_tunnel ()

const StringPiece	get_next_hop_vpn_tunnel () const

void	set_next_hop_vpn_tunnel (const StringPiece &value)

bool	has_priority () const

void	clear_priority ()

uint32	get_priority () const

void	set_priority (uint32 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_tags () const

void	clear_tags ()

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

client::JsonCppArray< string >	mutable_tags ()

bool	has_warnings () const

void	clear_warnings ()

const client::JsonCppArray< RouteWarnings >	get_warnings () const

client::JsonCppArray< RouteWarnings >	mutable_warnings ()

Static Public Member Functions
static Route *	New ()

Detailed Description

Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.

For each packet leaving an instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, an instance gateway, or a Google Compute Engine-operated gateway.

Packets that do not match any route in the sending instance's routing table are dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==).

Constructor & Destructor Documentation

◆ Route() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Route() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Route()

google_compute_api::Route::~Route ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_creation_timestamp()

void google_compute_api::Route::clear_creation_timestamp ( )

inline

Clears the 'creationTimestamp' attribute.

◆ clear_description()

void google_compute_api::Route::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_dest_range()

void google_compute_api::Route::clear_dest_range ( )

inline

Clears the 'destRange' attribute.

◆ clear_id()

void google_compute_api::Route::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_kind()

void google_compute_api::Route::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_name()

void google_compute_api::Route::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_network()

void google_compute_api::Route::clear_network ( )

inline

Clears the 'network' attribute.

◆ clear_next_hop_gateway()

void google_compute_api::Route::clear_next_hop_gateway ( )

inline

Clears the 'nextHopGateway' attribute.

◆ clear_next_hop_instance()

void google_compute_api::Route::clear_next_hop_instance ( )

inline

Clears the 'nextHopInstance' attribute.

◆ clear_next_hop_ip()

void google_compute_api::Route::clear_next_hop_ip ( )

inline

Clears the 'nextHopIp' attribute.

◆ clear_next_hop_network()

void google_compute_api::Route::clear_next_hop_network ( )

inline

Clears the 'nextHopNetwork' attribute.

◆ clear_next_hop_peering()

void google_compute_api::Route::clear_next_hop_peering ( )

inline

Clears the 'nextHopPeering' attribute.

◆ clear_next_hop_vpn_tunnel()

void google_compute_api::Route::clear_next_hop_vpn_tunnel ( )

inline

Clears the 'nextHopVpnTunnel' attribute.

◆ clear_priority()

void google_compute_api::Route::clear_priority ( )

inline

Clears the 'priority' attribute.

◆ clear_self_link()

void google_compute_api::Route::clear_self_link ( )

inline

Clears the 'selfLink' attribute.

◆ clear_tags()

void google_compute_api::Route::clear_tags ( )

inline

Clears the 'tags' attribute.

◆ clear_warnings()

void google_compute_api::Route::clear_warnings ( )

inline

Clears the 'warnings' attribute.

◆ get_creation_timestamp()

const StringPiece google_compute_api::Route::get_creation_timestamp ( ) const

inline

Get the value of the 'creationTimestamp' attribute.

◆ get_description()

const StringPiece google_compute_api::Route::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_dest_range()

const StringPiece google_compute_api::Route::get_dest_range ( ) const

inline

Get the value of the 'destRange' attribute.

◆ get_id()

uint64 google_compute_api::Route::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_compute_api::Route::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_compute_api::Route::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_network()

const StringPiece google_compute_api::Route::get_network ( ) const

inline

Get the value of the 'network' attribute.

◆ get_next_hop_gateway()

const StringPiece google_compute_api::Route::get_next_hop_gateway ( ) const

inline

Get the value of the 'nextHopGateway' attribute.

◆ get_next_hop_instance()

const StringPiece google_compute_api::Route::get_next_hop_instance ( ) const

inline

Get the value of the 'nextHopInstance' attribute.

◆ get_next_hop_ip()

const StringPiece google_compute_api::Route::get_next_hop_ip ( ) const

inline

Get the value of the 'nextHopIp' attribute.

◆ get_next_hop_network()

const StringPiece google_compute_api::Route::get_next_hop_network ( ) const

inline

Get the value of the 'nextHopNetwork' attribute.

◆ get_next_hop_peering()

const StringPiece google_compute_api::Route::get_next_hop_peering ( ) const

inline

Get the value of the 'nextHopPeering' attribute.

◆ get_next_hop_vpn_tunnel()

const StringPiece google_compute_api::Route::get_next_hop_vpn_tunnel ( ) const

inline

Get the value of the 'nextHopVpnTunnel' attribute.

◆ get_priority()

uint32 google_compute_api::Route::get_priority ( ) const

inline

Get the value of the 'priority' attribute.

◆ get_self_link()

const StringPiece google_compute_api::Route::get_self_link ( ) const

inline

Get the value of the 'selfLink' attribute.

◆ get_tags()

const client::JsonCppArray<string > google_compute_api::Route::get_tags ( ) const

inline

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

◆ get_warnings()

const client::JsonCppArray<RouteWarnings > google_compute_api::Route::get_warnings ( ) const

inline

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

◆ GetTypeName()

const StringPiece google_compute_api::Route::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_compute_api::Route

◆ has_creation_timestamp()

bool google_compute_api::Route::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::Route::has_description ( ) const

inline

Determine if the 'description' attribute was set.

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

◆ has_dest_range()

bool google_compute_api::Route::has_dest_range ( ) const

inline

Determine if the 'destRange' attribute was set.

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

◆ has_id()

bool google_compute_api::Route::has_id ( ) const

inline

Determine if the 'id' attribute was set.

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

◆ has_kind()

bool google_compute_api::Route::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

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

◆ has_name()

bool google_compute_api::Route::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::Route::has_network ( ) const

inline

Determine if the 'network' attribute was set.

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

◆ has_next_hop_gateway()

bool google_compute_api::Route::has_next_hop_gateway ( ) const

inline

Determine if the 'nextHopGateway' attribute was set.

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

◆ has_next_hop_instance()

bool google_compute_api::Route::has_next_hop_instance ( ) const

inline

Determine if the 'nextHopInstance' attribute was set.

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

◆ has_next_hop_ip()

bool google_compute_api::Route::has_next_hop_ip ( ) const

inline

Determine if the 'nextHopIp' attribute was set.

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

◆ has_next_hop_network()

bool google_compute_api::Route::has_next_hop_network ( ) const

inline

Determine if the 'nextHopNetwork' attribute was set.

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

◆ has_next_hop_peering()

bool google_compute_api::Route::has_next_hop_peering ( ) const

inline

Determine if the 'nextHopPeering' attribute was set.

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

◆ has_next_hop_vpn_tunnel()

bool google_compute_api::Route::has_next_hop_vpn_tunnel ( ) const

inline

Determine if the 'nextHopVpnTunnel' attribute was set.

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

◆ has_priority()

bool google_compute_api::Route::has_priority ( ) const

inline

Determine if the 'priority' attribute was set.

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

◆ has_self_link()

bool google_compute_api::Route::has_self_link ( ) const

inline

Determine if the 'selfLink' attribute was set.

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

◆ has_tags()

bool google_compute_api::Route::has_tags ( ) const

inline

Determine if the 'tags' attribute was set.

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

◆ has_warnings()

bool google_compute_api::Route::has_warnings ( ) const

inline

Determine if the 'warnings' attribute was set.

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

◆ mutable_tags()

client::JsonCppArray<string > google_compute_api::Route::mutable_tags ( )

inline

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

A list of instance tags to which this route applies.

Returns: The result can be modified to change the attribute value.

◆ mutable_warnings()

client::JsonCppArray<RouteWarnings > google_compute_api::Route::mutable_warnings ( )

inline

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

[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Returns: The result can be modified to change the attribute value.

◆ New()

Route * google_compute_api::Route::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_creation_timestamp()

void google_compute_api::Route::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::Route::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_dest_range()

void google_compute_api::Route::set_dest_range ( const StringPiece & value )

inline

Change the 'destRange' attribute.

The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

Parameters

[in] value The new value.

◆ set_id()

void google_compute_api::Route::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_kind()

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

inline

Change the 'kind' attribute.

[Output Only] Type of this resource. Always compute::routes for Route resources.

Parameters

[in] value The new value.

◆ set_name()

void google_compute_api::Route::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_network()

void google_compute_api::Route::set_network ( const StringPiece & value )

inline

Change the 'network' attribute.

Fully-qualified URL of the network that this route applies to.

Parameters

[in] value The new value.

◆ set_next_hop_gateway()

void google_compute_api::Route::set_next_hop_gateway ( const StringPiece & value )

inline

Change the 'nextHopGateway' attribute.

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects//global/gateways/default-internet-gateway.

Parameters

[in] value The new value.

◆ set_next_hop_instance()

void google_compute_api::Route::set_next_hop_instance ( const StringPiece & value )

inline

Change the 'nextHopInstance' attribute.

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances /.

Parameters

[in] value The new value.

◆ set_next_hop_ip()

void google_compute_api::Route::set_next_hop_ip ( const StringPiece & value )

inline

Change the 'nextHopIp' attribute.

The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

Parameters

[in] value The new value.

◆ set_next_hop_network()

void google_compute_api::Route::set_next_hop_network ( const StringPiece & value )

inline

Change the 'nextHopNetwork' attribute.

The URL of the local network if it should handle matching packets.

Parameters

[in] value The new value.

◆ set_next_hop_peering()

void google_compute_api::Route::set_next_hop_peering ( const StringPiece & value )

inline

Change the 'nextHopPeering' attribute.

[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

Parameters

[in] value The new value.

◆ set_next_hop_vpn_tunnel()

void google_compute_api::Route::set_next_hop_vpn_tunnel ( const StringPiece & value )

inline

Change the 'nextHopVpnTunnel' attribute.

The URL to a VpnTunnel that should handle matching packets.

Parameters

[in] value The new value.

◆ set_priority()

void google_compute_api::Route::set_priority ( uint32 value )

inline

Change the 'priority' attribute.

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.

Parameters

[in] value The new value.

◆ set_self_link()

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

inline

Change the 'selfLink' attribute.

[Output Only] Server-defined fully-qualified URL for this resource.

Parameters

[in] value The new value.

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

google/compute_api/route.h
google/compute_api/route.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Route() [1/2]

◆ Route() [2/2]

◆ ~Route()

Member Function Documentation

◆ clear_creation_timestamp()

◆ clear_description()

◆ clear_dest_range()

◆ clear_id()

◆ clear_kind()

◆ clear_name()

◆ clear_network()

◆ clear_next_hop_gateway()

◆ clear_next_hop_instance()

◆ clear_next_hop_ip()

◆ clear_next_hop_network()

◆ clear_next_hop_peering()

◆ clear_next_hop_vpn_tunnel()

◆ clear_priority()

◆ clear_self_link()

◆ clear_tags()

◆ clear_warnings()

◆ get_creation_timestamp()

◆ get_description()

◆ get_dest_range()

◆ get_id()

◆ get_kind()

◆ get_name()

◆ get_network()

◆ get_next_hop_gateway()

◆ get_next_hop_instance()

◆ get_next_hop_ip()

◆ get_next_hop_network()

◆ get_next_hop_peering()

◆ get_next_hop_vpn_tunnel()

◆ get_priority()

◆ get_self_link()

◆ get_tags()

◆ get_warnings()

◆ GetTypeName()

◆ has_creation_timestamp()

◆ has_description()

◆ has_dest_range()

◆ has_id()

◆ has_kind()

◆ has_name()

◆ has_network()

◆ has_next_hop_gateway()

◆ has_next_hop_instance()

◆ has_next_hop_ip()

◆ has_next_hop_network()

◆ has_next_hop_peering()

◆ has_next_hop_vpn_tunnel()

◆ has_priority()

◆ has_self_link()

◆ has_tags()

◆ has_warnings()

◆ mutable_tags()

◆ mutable_warnings()

◆ New()

◆ set_creation_timestamp()

◆ set_description()

◆ set_dest_range()

◆ set_id()

◆ set_kind()

◆ set_name()

◆ set_network()

◆ set_next_hop_gateway()

◆ set_next_hop_instance()

◆ set_next_hop_ip()

◆ set_next_hop_network()

◆ set_next_hop_peering()

◆ set_next_hop_vpn_tunnel()

◆ set_priority()

◆ set_self_link()