#include <backend.h>

Inheritance diagram for google_compute_api::Backend:

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

	Backend (Json::Value *storage)

virtual	~Backend ()

const StringPiece	GetTypeName () const

bool	has_balancing_mode () const

void	clear_balancing_mode ()

const StringPiece	get_balancing_mode () const

void	set_balancing_mode (const StringPiece &value)

bool	has_capacity_scaler () const

void	clear_capacity_scaler ()

float	get_capacity_scaler () const

void	set_capacity_scaler (float value)

bool	has_description () const

void	clear_description ()

const StringPiece	get_description () const

void	set_description (const StringPiece &value)

bool	has_group () const

void	clear_group ()

const StringPiece	get_group () const

void	set_group (const StringPiece &value)

bool	has_max_connections () const

void	clear_max_connections ()

int32	get_max_connections () const

void	set_max_connections (int32 value)

bool	has_max_connections_per_endpoint () const

void	clear_max_connections_per_endpoint ()

int32	get_max_connections_per_endpoint () const

void	set_max_connections_per_endpoint (int32 value)

bool	has_max_connections_per_instance () const

void	clear_max_connections_per_instance ()

int32	get_max_connections_per_instance () const

void	set_max_connections_per_instance (int32 value)

bool	has_max_rate () const

void	clear_max_rate ()

int32	get_max_rate () const

void	set_max_rate (int32 value)

bool	has_max_rate_per_endpoint () const

void	clear_max_rate_per_endpoint ()

float	get_max_rate_per_endpoint () const

void	set_max_rate_per_endpoint (float value)

bool	has_max_rate_per_instance () const

void	clear_max_rate_per_instance ()

float	get_max_rate_per_instance () const

void	set_max_rate_per_instance (float value)

bool	has_max_utilization () const

void	clear_max_utilization ()

float	get_max_utilization () const

void	set_max_utilization (float value)

Static Public Member Functions
static Backend *	New ()

Detailed Description

Message containing information of one individual backend.

Constructor & Destructor Documentation

◆ Backend() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Backend() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Backend()

google_compute_api::Backend::~Backend ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_balancing_mode()

void google_compute_api::Backend::clear_balancing_mode ( )

inline

Clears the 'balancingMode' attribute.

◆ clear_capacity_scaler()

void google_compute_api::Backend::clear_capacity_scaler ( )

inline

Clears the 'capacityScaler' attribute.

◆ clear_description()

void google_compute_api::Backend::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_group()

void google_compute_api::Backend::clear_group ( )

inline

Clears the 'group' attribute.

◆ clear_max_connections()

void google_compute_api::Backend::clear_max_connections ( )

inline

Clears the 'maxConnections' attribute.

◆ clear_max_connections_per_endpoint()

void google_compute_api::Backend::clear_max_connections_per_endpoint ( )

inline

Clears the 'maxConnectionsPerEndpoint' attribute.

◆ clear_max_connections_per_instance()

void google_compute_api::Backend::clear_max_connections_per_instance ( )

inline

Clears the 'maxConnectionsPerInstance' attribute.

◆ clear_max_rate()

void google_compute_api::Backend::clear_max_rate ( )

inline

Clears the 'maxRate' attribute.

◆ clear_max_rate_per_endpoint()

void google_compute_api::Backend::clear_max_rate_per_endpoint ( )

inline

Clears the 'maxRatePerEndpoint' attribute.

◆ clear_max_rate_per_instance()

void google_compute_api::Backend::clear_max_rate_per_instance ( )

inline

Clears the 'maxRatePerInstance' attribute.

◆ clear_max_utilization()

void google_compute_api::Backend::clear_max_utilization ( )

inline

Clears the 'maxUtilization' attribute.

◆ get_balancing_mode()

const StringPiece google_compute_api::Backend::get_balancing_mode ( ) const

inline

Get the value of the 'balancingMode' attribute.

◆ get_capacity_scaler()

float google_compute_api::Backend::get_capacity_scaler ( ) const

inline

Get the value of the 'capacityScaler' attribute.

◆ get_description()

const StringPiece google_compute_api::Backend::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_group()

const StringPiece google_compute_api::Backend::get_group ( ) const

inline

Get the value of the 'group' attribute.

◆ get_max_connections()

int32 google_compute_api::Backend::get_max_connections ( ) const

inline

Get the value of the 'maxConnections' attribute.

◆ get_max_connections_per_endpoint()

int32 google_compute_api::Backend::get_max_connections_per_endpoint ( ) const

inline

Get the value of the 'maxConnectionsPerEndpoint' attribute.

◆ get_max_connections_per_instance()

int32 google_compute_api::Backend::get_max_connections_per_instance ( ) const

inline

Get the value of the 'maxConnectionsPerInstance' attribute.

◆ get_max_rate()

int32 google_compute_api::Backend::get_max_rate ( ) const

inline

Get the value of the 'maxRate' attribute.

◆ get_max_rate_per_endpoint()

float google_compute_api::Backend::get_max_rate_per_endpoint ( ) const

inline

Get the value of the 'maxRatePerEndpoint' attribute.

◆ get_max_rate_per_instance()

float google_compute_api::Backend::get_max_rate_per_instance ( ) const

inline

Get the value of the 'maxRatePerInstance' attribute.

◆ get_max_utilization()

float google_compute_api::Backend::get_max_utilization ( ) const

inline

Get the value of the 'maxUtilization' attribute.

◆ GetTypeName()

const StringPiece google_compute_api::Backend::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_compute_api::Backend

◆ has_balancing_mode()

bool google_compute_api::Backend::has_balancing_mode ( ) const

inline

Determine if the 'balancingMode' attribute was set.

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

◆ has_capacity_scaler()

bool google_compute_api::Backend::has_capacity_scaler ( ) const

inline

Determine if the 'capacityScaler' attribute was set.

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

◆ has_description()

bool google_compute_api::Backend::has_description ( ) const

inline

Determine if the 'description' attribute was set.

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

◆ has_group()

bool google_compute_api::Backend::has_group ( ) const

inline

Determine if the 'group' attribute was set.

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

◆ has_max_connections()

bool google_compute_api::Backend::has_max_connections ( ) const

inline

Determine if the 'maxConnections' attribute was set.

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

◆ has_max_connections_per_endpoint()

bool google_compute_api::Backend::has_max_connections_per_endpoint ( ) const

inline

Determine if the 'maxConnectionsPerEndpoint' attribute was set.

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

◆ has_max_connections_per_instance()

bool google_compute_api::Backend::has_max_connections_per_instance ( ) const

inline

Determine if the 'maxConnectionsPerInstance' attribute was set.

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

◆ has_max_rate()

bool google_compute_api::Backend::has_max_rate ( ) const

inline

Determine if the 'maxRate' attribute was set.

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

◆ has_max_rate_per_endpoint()

bool google_compute_api::Backend::has_max_rate_per_endpoint ( ) const

inline

Determine if the 'maxRatePerEndpoint' attribute was set.

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

◆ has_max_rate_per_instance()

bool google_compute_api::Backend::has_max_rate_per_instance ( ) const

inline

Determine if the 'maxRatePerInstance' attribute was set.

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

◆ has_max_utilization()

bool google_compute_api::Backend::has_max_utilization ( ) const

inline

Determine if the 'maxUtilization' attribute was set.

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

◆ New()

Backend * google_compute_api::Backend::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_balancing_mode()

void google_compute_api::Backend::set_balancing_mode ( const StringPiece & value )

inline

Change the 'balancingMode' attribute.

Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).

For Internal Load Balancing, the default and only supported mode is CONNECTION.

Parameters

[in] value The new value.

◆ set_capacity_scaler()

void google_compute_api::Backend::set_capacity_scaler ( float value )

inline

Change the 'capacityScaler' attribute.

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

This cannot be used for internal load balancing.

Parameters

[in] value The new value.

◆ set_description()

void google_compute_api::Backend::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_group()

void google_compute_api::Backend::set_group ( const StringPiece & value )

inline

Change the 'group' attribute.

The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.

For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group.

Backend service can not contain mix of Instance Group and Network Endpoint Group backends.

Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.

When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService. Network Endpoint Groups are not supported for INTERNAL load balancing scheme.

Parameters

[in] value The new value.

◆ set_max_connections()

void google_compute_api::Backend::set_max_connections ( int32 value )

inline

Change the 'maxConnections' attribute.

The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.

Parameters

[in] value The new value.

◆ set_max_connections_per_endpoint()

void google_compute_api::Backend::set_max_connections_per_endpoint ( int32 value )

inline

Change the 'maxConnectionsPerEndpoint' attribute.

The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.

This cannot be used for internal load balancing.

Parameters

[in] value The new value.

◆ set_max_connections_per_instance()

void google_compute_api::Backend::set_max_connections_per_instance ( int32 value )

inline

Change the 'maxConnectionsPerInstance' attribute.

The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.

Parameters

[in] value The new value.

◆ set_max_rate()

void google_compute_api::Backend::set_max_rate ( int32 value )

inline

Change the 'maxRate' attribute.

The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.

This cannot be used for internal load balancing.

Parameters

[in] value The new value.

◆ set_max_rate_per_endpoint()

void google_compute_api::Backend::set_max_rate_per_endpoint ( float value )

inline

Change the 'maxRatePerEndpoint' attribute.

The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set.

This cannot be used for internal load balancing.

Parameters

[in] value The new value.

◆ set_max_rate_per_instance()

void google_compute_api::Backend::set_max_rate_per_instance ( float value )

inline

Change the 'maxRatePerInstance' attribute.

The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.

This cannot be used for internal load balancing.

Parameters

[in] value The new value.

◆ set_max_utilization()

void google_compute_api::Backend::set_max_utilization ( float value )

inline

Change the 'maxUtilization' attribute.

Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].

This cannot be used for internal load balancing.

Parameters

[in] value The new value.

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

google/compute_api/backend.h
google/compute_api/backend.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Backend() [1/2]

◆ Backend() [2/2]

◆ ~Backend()

Member Function Documentation

◆ clear_balancing_mode()

◆ clear_capacity_scaler()

◆ clear_description()

◆ clear_group()

◆ clear_max_connections()

◆ clear_max_connections_per_endpoint()

◆ clear_max_connections_per_instance()

◆ clear_max_rate()

◆ clear_max_rate_per_endpoint()

◆ clear_max_rate_per_instance()

◆ clear_max_utilization()

◆ get_balancing_mode()

◆ get_capacity_scaler()

◆ get_description()

◆ get_group()

◆ get_max_connections()

◆ get_max_connections_per_endpoint()

◆ get_max_connections_per_instance()

◆ get_max_rate()

◆ get_max_rate_per_endpoint()

◆ get_max_rate_per_instance()

◆ get_max_utilization()

◆ GetTypeName()

◆ has_balancing_mode()

◆ has_capacity_scaler()

◆ has_description()

◆ has_group()

◆ has_max_connections()

◆ has_max_connections_per_endpoint()

◆ has_max_connections_per_instance()

◆ has_max_rate()

◆ has_max_rate_per_endpoint()

◆ has_max_rate_per_instance()

◆ has_max_utilization()

◆ New()

◆ set_balancing_mode()

◆ set_capacity_scaler()

◆ set_description()

◆ set_group()

◆ set_max_connections()

◆ set_max_connections_per_endpoint()

◆ set_max_connections_per_instance()

◆ set_max_rate()

◆ set_max_rate_per_endpoint()

◆ set_max_rate_per_instance()

◆ set_max_utilization()