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

#include <autoscaling_policy.h>

Inheritance diagram for google_compute_api::AutoscalingPolicy:

Public Member Functions

 AutoscalingPolicy (const Json::Value &storage)
 
 AutoscalingPolicy (Json::Value *storage)
 
virtual ~AutoscalingPolicy ()
 
const StringPiece GetTypeName () const
 
bool has_cool_down_period_sec () const
 
void clear_cool_down_period_sec ()
 
int32 get_cool_down_period_sec () const
 
void set_cool_down_period_sec (int32 value)
 
bool has_cpu_utilization () const
 
void clear_cpu_utilization ()
 
const AutoscalingPolicyCpuUtilization get_cpu_utilization () const
 
AutoscalingPolicyCpuUtilization mutable_cpuUtilization ()
 
bool has_custom_metric_utilizations () const
 
void clear_custom_metric_utilizations ()
 
const client::JsonCppArray< AutoscalingPolicyCustomMetricUtilizationget_custom_metric_utilizations () const
 
client::JsonCppArray< AutoscalingPolicyCustomMetricUtilizationmutable_customMetricUtilizations ()
 
bool has_load_balancing_utilization () const
 
void clear_load_balancing_utilization ()
 
const AutoscalingPolicyLoadBalancingUtilization get_load_balancing_utilization () const
 
AutoscalingPolicyLoadBalancingUtilization mutable_loadBalancingUtilization ()
 
bool has_max_num_replicas () const
 
void clear_max_num_replicas ()
 
int32 get_max_num_replicas () const
 
void set_max_num_replicas (int32 value)
 
bool has_min_num_replicas () const
 
void clear_min_num_replicas ()
 
int32 get_min_num_replicas () const
 
void set_min_num_replicas (int32 value)
 

Static Public Member Functions

static AutoscalingPolicyNew ()
 

Detailed Description

Cloud Autoscaler policy.

Constructor & Destructor Documentation

◆ AutoscalingPolicy() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ AutoscalingPolicy() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~AutoscalingPolicy()

google_compute_api::AutoscalingPolicy::~AutoscalingPolicy ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_cool_down_period_sec()

void google_compute_api::AutoscalingPolicy::clear_cool_down_period_sec ( )
inline

Clears the 'coolDownPeriodSec' attribute.

◆ clear_cpu_utilization()

void google_compute_api::AutoscalingPolicy::clear_cpu_utilization ( )
inline

Clears the 'cpuUtilization' attribute.

◆ clear_custom_metric_utilizations()

void google_compute_api::AutoscalingPolicy::clear_custom_metric_utilizations ( )
inline

Clears the 'customMetricUtilizations' attribute.

◆ clear_load_balancing_utilization()

void google_compute_api::AutoscalingPolicy::clear_load_balancing_utilization ( )
inline

Clears the 'loadBalancingUtilization' attribute.

◆ clear_max_num_replicas()

void google_compute_api::AutoscalingPolicy::clear_max_num_replicas ( )
inline

Clears the 'maxNumReplicas' attribute.

◆ clear_min_num_replicas()

void google_compute_api::AutoscalingPolicy::clear_min_num_replicas ( )
inline

Clears the 'minNumReplicas' attribute.

◆ get_cool_down_period_sec()

int32 google_compute_api::AutoscalingPolicy::get_cool_down_period_sec ( ) const
inline

Get the value of the 'coolDownPeriodSec' attribute.

◆ get_cpu_utilization()

const AutoscalingPolicyCpuUtilization google_compute_api::AutoscalingPolicy::get_cpu_utilization ( ) const

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

◆ get_custom_metric_utilizations()

const client::JsonCppArray<AutoscalingPolicyCustomMetricUtilization > google_compute_api::AutoscalingPolicy::get_custom_metric_utilizations ( ) const

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

◆ get_load_balancing_utilization()

const AutoscalingPolicyLoadBalancingUtilization google_compute_api::AutoscalingPolicy::get_load_balancing_utilization ( ) const

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

◆ get_max_num_replicas()

int32 google_compute_api::AutoscalingPolicy::get_max_num_replicas ( ) const
inline

Get the value of the 'maxNumReplicas' attribute.

◆ get_min_num_replicas()

int32 google_compute_api::AutoscalingPolicy::get_min_num_replicas ( ) const
inline

Get the value of the 'minNumReplicas' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_compute_api::AutoscalingPolicy

◆ has_cool_down_period_sec()

bool google_compute_api::AutoscalingPolicy::has_cool_down_period_sec ( ) const
inline

Determine if the 'coolDownPeriodSec' attribute was set.

Returns
true if the 'coolDownPeriodSec' attribute was set.

◆ has_cpu_utilization()

bool google_compute_api::AutoscalingPolicy::has_cpu_utilization ( ) const
inline

Determine if the 'cpuUtilization' attribute was set.

Returns
true if the 'cpuUtilization' attribute was set.

◆ has_custom_metric_utilizations()

bool google_compute_api::AutoscalingPolicy::has_custom_metric_utilizations ( ) const
inline

Determine if the 'customMetricUtilizations' attribute was set.

Returns
true if the 'customMetricUtilizations' attribute was set.

◆ has_load_balancing_utilization()

bool google_compute_api::AutoscalingPolicy::has_load_balancing_utilization ( ) const
inline

Determine if the 'loadBalancingUtilization' attribute was set.

Returns
true if the 'loadBalancingUtilization' attribute was set.

◆ has_max_num_replicas()

bool google_compute_api::AutoscalingPolicy::has_max_num_replicas ( ) const
inline

Determine if the 'maxNumReplicas' attribute was set.

Returns
true if the 'maxNumReplicas' attribute was set.

◆ has_min_num_replicas()

bool google_compute_api::AutoscalingPolicy::has_min_num_replicas ( ) const
inline

Determine if the 'minNumReplicas' attribute was set.

Returns
true if the 'minNumReplicas' attribute was set.

◆ mutable_cpuUtilization()

AutoscalingPolicyCpuUtilization google_compute_api::AutoscalingPolicy::mutable_cpuUtilization ( )

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

Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

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

◆ mutable_customMetricUtilizations()

client::JsonCppArray<AutoscalingPolicyCustomMetricUtilization > google_compute_api::AutoscalingPolicy::mutable_customMetricUtilizations ( )

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

Configuration parameters of autoscaling based on a custom metric.

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

◆ mutable_loadBalancingUtilization()

AutoscalingPolicyLoadBalancingUtilization google_compute_api::AutoscalingPolicy::mutable_loadBalancingUtilization ( )

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

Configuration parameters of autoscaling based on load balancer.

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

◆ New()

AutoscalingPolicy * google_compute_api::AutoscalingPolicy::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_cool_down_period_sec()

void google_compute_api::AutoscalingPolicy::set_cool_down_period_sec ( int32  value)
inline

Change the 'coolDownPeriodSec' attribute.

The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.

Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

Parameters
[in]valueThe new value.

◆ set_max_num_replicas()

void google_compute_api::AutoscalingPolicy::set_max_num_replicas ( int32  value)
inline

Change the 'maxNumReplicas' attribute.

The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

Parameters
[in]valueThe new value.

◆ set_min_num_replicas()

void google_compute_api::AutoscalingPolicy::set_min_num_replicas ( int32  value)
inline

Change the 'minNumReplicas' attribute.

The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

Parameters
[in]valueThe new value.

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