#include <target_pool.h>

Inheritance diagram for google_compute_api::TargetPool:

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

	TargetPool (Json::Value *storage)

virtual	~TargetPool ()

const StringPiece	GetTypeName () const

bool	has_backup_pool () const

void	clear_backup_pool ()

const StringPiece	get_backup_pool () const

void	set_backup_pool (const StringPiece &value)

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

void	clear_failover_ratio ()

float	get_failover_ratio () const

void	set_failover_ratio (float value)

bool	has_health_checks () const

void	clear_health_checks ()

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

client::JsonCppArray< string >	mutable_healthChecks ()

bool	has_id () const

void	clear_id ()

uint64	get_id () const

void	set_id (uint64 value)

bool	has_instances () const

void	clear_instances ()

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

client::JsonCppArray< string >	mutable_instances ()

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

void	clear_region ()

const StringPiece	get_region () const

void	set_region (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_session_affinity () const

void	clear_session_affinity ()

const StringPiece	get_session_affinity () const

void	set_session_affinity (const StringPiece &value)

Static Public Member Functions
static TargetPool *	New ()

Detailed Description

A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==).

Constructor & Destructor Documentation

◆ TargetPool() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ TargetPool() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~TargetPool()

google_compute_api::TargetPool::~TargetPool ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_backup_pool()

void google_compute_api::TargetPool::clear_backup_pool ( )

inline

Clears the 'backupPool' attribute.

◆ clear_creation_timestamp()

void google_compute_api::TargetPool::clear_creation_timestamp ( )

inline

Clears the 'creationTimestamp' attribute.

◆ clear_description()

void google_compute_api::TargetPool::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_failover_ratio()

void google_compute_api::TargetPool::clear_failover_ratio ( )

inline

Clears the 'failoverRatio' attribute.

◆ clear_health_checks()

void google_compute_api::TargetPool::clear_health_checks ( )

inline

Clears the 'healthChecks' attribute.

◆ clear_id()

void google_compute_api::TargetPool::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_instances()

void google_compute_api::TargetPool::clear_instances ( )

inline

Clears the 'instances' attribute.

◆ clear_kind()

void google_compute_api::TargetPool::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_name()

void google_compute_api::TargetPool::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_region()

void google_compute_api::TargetPool::clear_region ( )

inline

Clears the 'region' attribute.

◆ clear_self_link()

void google_compute_api::TargetPool::clear_self_link ( )

inline

Clears the 'selfLink' attribute.

◆ clear_session_affinity()

void google_compute_api::TargetPool::clear_session_affinity ( )

inline

Clears the 'sessionAffinity' attribute.

◆ get_backup_pool()

const StringPiece google_compute_api::TargetPool::get_backup_pool ( ) const

inline

Get the value of the 'backupPool' attribute.

◆ get_creation_timestamp()

const StringPiece google_compute_api::TargetPool::get_creation_timestamp ( ) const

inline

Get the value of the 'creationTimestamp' attribute.

◆ get_description()

const StringPiece google_compute_api::TargetPool::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_failover_ratio()

float google_compute_api::TargetPool::get_failover_ratio ( ) const

inline

Get the value of the 'failoverRatio' attribute.

◆ get_health_checks()

const client::JsonCppArray<string > google_compute_api::TargetPool::get_health_checks ( ) const

inline

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

◆ get_id()

uint64 google_compute_api::TargetPool::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_instances()

const client::JsonCppArray<string > google_compute_api::TargetPool::get_instances ( ) const

inline

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

◆ get_kind()

const StringPiece google_compute_api::TargetPool::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_compute_api::TargetPool::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_region()

const StringPiece google_compute_api::TargetPool::get_region ( ) const

inline

Get the value of the 'region' attribute.

◆ get_self_link()

const StringPiece google_compute_api::TargetPool::get_self_link ( ) const

inline

Get the value of the 'selfLink' attribute.

◆ get_session_affinity()

const StringPiece google_compute_api::TargetPool::get_session_affinity ( ) const

inline

Get the value of the 'sessionAffinity' attribute.

◆ GetTypeName()

const StringPiece google_compute_api::TargetPool::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_compute_api::TargetPool

◆ has_backup_pool()

bool google_compute_api::TargetPool::has_backup_pool ( ) const

inline

Determine if the 'backupPool' attribute was set.

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

◆ has_creation_timestamp()

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

inline

Determine if the 'description' attribute was set.

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

◆ has_failover_ratio()

bool google_compute_api::TargetPool::has_failover_ratio ( ) const

inline

Determine if the 'failoverRatio' attribute was set.

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

◆ has_health_checks()

bool google_compute_api::TargetPool::has_health_checks ( ) const

inline

Determine if the 'healthChecks' attribute was set.

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

◆ has_id()

bool google_compute_api::TargetPool::has_id ( ) const

inline

Determine if the 'id' attribute was set.

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

◆ has_instances()

bool google_compute_api::TargetPool::has_instances ( ) const

inline

Determine if the 'instances' attribute was set.

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

◆ has_kind()

bool google_compute_api::TargetPool::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::TargetPool::has_name ( ) const

inline

Determine if the 'name' attribute was set.

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

◆ has_region()

bool google_compute_api::TargetPool::has_region ( ) const

inline

Determine if the 'region' attribute was set.

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

◆ has_self_link()

bool google_compute_api::TargetPool::has_self_link ( ) const

inline

Determine if the 'selfLink' attribute was set.

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

◆ has_session_affinity()

bool google_compute_api::TargetPool::has_session_affinity ( ) const

inline

Determine if the 'sessionAffinity' attribute was set.

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

◆ mutable_healthChecks()

client::JsonCppArray<string > google_compute_api::TargetPool::mutable_healthChecks ( )

inline

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

The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.

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

◆ mutable_instances()

client::JsonCppArray<string > google_compute_api::TargetPool::mutable_instances ( )

inline

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

A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

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

◆ New()

TargetPool * google_compute_api::TargetPool::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_backup_pool()

void google_compute_api::TargetPool::set_backup_pool ( const StringPiece & value )

inline

Change the 'backupPool' attribute.

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].

backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.

In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

Parameters

[in] value The new value.

◆ set_creation_timestamp()

void google_compute_api::TargetPool::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::TargetPool::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_failover_ratio()

void google_compute_api::TargetPool::set_failover_ratio ( float value )

inline

Change the 'failoverRatio' attribute.

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].

If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.

In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

Parameters

[in] value The new value.

◆ set_id()

void google_compute_api::TargetPool::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::TargetPool::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

[Output Only] Type of the resource. Always compute::targetPool for target pools.

Parameters

[in] value The new value.

◆ set_name()

void google_compute_api::TargetPool::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_region()

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

inline

Change the 'region' attribute.

[Output Only] URL of the region where the target pool resides.

Parameters

[in] value The new value.

◆ set_self_link()

void google_compute_api::TargetPool::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_session_affinity()

void google_compute_api::TargetPool::set_session_affinity ( const StringPiece & value )

inline

Change the 'sessionAffinity' attribute.

Session affinity option, must be one of the following values:

NONE: Connections from the same client IP may go to any instance in the pool.
CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

Parameters

[in] value The new value.

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

google/compute_api/target_pool.h
google/compute_api/target_pool.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TargetPool() [1/2]

◆ TargetPool() [2/2]

◆ ~TargetPool()

Member Function Documentation

◆ clear_backup_pool()

◆ clear_creation_timestamp()

◆ clear_description()

◆ clear_failover_ratio()

◆ clear_health_checks()

◆ clear_id()

◆ clear_instances()

◆ clear_kind()

◆ clear_name()

◆ clear_region()

◆ clear_self_link()

◆ clear_session_affinity()

◆ get_backup_pool()

◆ get_creation_timestamp()

◆ get_description()

◆ get_failover_ratio()

◆ get_health_checks()

◆ get_id()

◆ get_instances()

◆ get_kind()

◆ get_name()

◆ get_region()

◆ get_self_link()

◆ get_session_affinity()

◆ GetTypeName()

◆ has_backup_pool()

◆ has_creation_timestamp()

◆ has_description()

◆ has_failover_ratio()

◆ has_health_checks()

◆ has_id()

◆ has_instances()

◆ has_kind()

◆ has_name()

◆ has_region()

◆ has_self_link()

◆ has_session_affinity()

◆ mutable_healthChecks()

◆ mutable_instances()

◆ New()

◆ set_backup_pool()

◆ set_creation_timestamp()

◆ set_description()

◆ set_failover_ratio()

◆ set_id()

◆ set_kind()

◆ set_name()

◆ set_region()

◆ set_self_link()

◆ set_session_affinity()