compute  v1
Public Member Functions | Static Public Member Functions | List of all members
google_compute_api::InstanceGroupManagerUpdatePolicy Class Reference
Compute Engine API Data Objects

#include <instance_group_manager_update_policy.h>

Inheritance diagram for google_compute_api::InstanceGroupManagerUpdatePolicy:

Public Member Functions

 InstanceGroupManagerUpdatePolicy (const Json::Value &storage)
 
 InstanceGroupManagerUpdatePolicy (Json::Value *storage)
 
virtual ~InstanceGroupManagerUpdatePolicy ()
 
const StringPiece GetTypeName () const
 
bool has_max_surge () const
 
void clear_max_surge ()
 
const FixedOrPercent get_max_surge () const
 
FixedOrPercent mutable_maxSurge ()
 
bool has_max_unavailable () const
 
void clear_max_unavailable ()
 
const FixedOrPercent get_max_unavailable () const
 
FixedOrPercent mutable_maxUnavailable ()
 
bool has_minimal_action () const
 
void clear_minimal_action ()
 
const StringPiece get_minimal_action () const
 
void set_minimal_action (const StringPiece &value)
 
bool has_type () const
 
void clear_type ()
 
const StringPiece get_type () const
 
void set_type (const StringPiece &value)
 

Static Public Member Functions

static InstanceGroupManagerUpdatePolicy * New ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ InstanceGroupManagerUpdatePolicy() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ InstanceGroupManagerUpdatePolicy() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~InstanceGroupManagerUpdatePolicy()

google_compute_api::InstanceGroupManagerUpdatePolicy::~InstanceGroupManagerUpdatePolicy ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_max_surge()

void google_compute_api::InstanceGroupManagerUpdatePolicy::clear_max_surge ( )
inline

Clears the 'maxSurge' attribute.

◆ clear_max_unavailable()

void google_compute_api::InstanceGroupManagerUpdatePolicy::clear_max_unavailable ( )
inline

Clears the 'maxUnavailable' attribute.

◆ clear_minimal_action()

void google_compute_api::InstanceGroupManagerUpdatePolicy::clear_minimal_action ( )
inline

Clears the 'minimalAction' attribute.

◆ clear_type()

void google_compute_api::InstanceGroupManagerUpdatePolicy::clear_type ( )
inline

Clears the 'type' attribute.

◆ get_max_surge()

const FixedOrPercent google_compute_api::InstanceGroupManagerUpdatePolicy::get_max_surge ( ) const

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

◆ get_max_unavailable()

const FixedOrPercent google_compute_api::InstanceGroupManagerUpdatePolicy::get_max_unavailable ( ) const

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

◆ get_minimal_action()

const StringPiece google_compute_api::InstanceGroupManagerUpdatePolicy::get_minimal_action ( ) const
inline

Get the value of the 'minimalAction' attribute.

◆ get_type()

const StringPiece google_compute_api::InstanceGroupManagerUpdatePolicy::get_type ( ) const
inline

Get the value of the 'type' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_compute_api::InstanceGroupManagerUpdatePolicy

◆ has_max_surge()

bool google_compute_api::InstanceGroupManagerUpdatePolicy::has_max_surge ( ) const
inline

Determine if the 'maxSurge' attribute was set.

Returns
true if the 'maxSurge' attribute was set.

◆ has_max_unavailable()

bool google_compute_api::InstanceGroupManagerUpdatePolicy::has_max_unavailable ( ) const
inline

Determine if the 'maxUnavailable' attribute was set.

Returns
true if the 'maxUnavailable' attribute was set.

◆ has_minimal_action()

bool google_compute_api::InstanceGroupManagerUpdatePolicy::has_minimal_action ( ) const
inline

Determine if the 'minimalAction' attribute was set.

Returns
true if the 'minimalAction' attribute was set.

◆ has_type()

bool google_compute_api::InstanceGroupManagerUpdatePolicy::has_type ( ) const
inline

Determine if the 'type' attribute was set.

Returns
true if the 'type' attribute was set.

◆ mutable_maxSurge()

FixedOrPercent google_compute_api::InstanceGroupManagerUpdatePolicy::mutable_maxSurge ( )

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

The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

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

◆ mutable_maxUnavailable()

FixedOrPercent google_compute_api::InstanceGroupManagerUpdatePolicy::mutable_maxUnavailable ( )

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

The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:

  • The instance's status is RUNNING.
  • If there is a health check on the instance group, the instance's liveness health check result must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

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

◆ New()

InstanceGroupManagerUpdatePolicy * google_compute_api::InstanceGroupManagerUpdatePolicy::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_minimal_action()

void google_compute_api::InstanceGroupManagerUpdatePolicy::set_minimal_action ( const StringPiece &  value)
inline

Change the 'minimalAction' attribute.

Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

Parameters
[in]valueThe new value.

◆ set_type()

void google_compute_api::InstanceGroupManagerUpdatePolicy::set_type ( const StringPiece &  value)
inline

Change the 'type' attribute.

Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: