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

#include <instance_group_manager.h>

Inheritance diagram for google_compute_api::InstanceGroupManager:

Public Member Functions

 InstanceGroupManager (const Json::Value &storage)
 
 InstanceGroupManager (Json::Value *storage)
 
virtual ~InstanceGroupManager ()
 
const StringPiece GetTypeName () const
 
bool has_auto_healing_policies () const
 
void clear_auto_healing_policies ()
 
const client::JsonCppArray< InstanceGroupManagerAutoHealingPolicyget_auto_healing_policies () const
 
client::JsonCppArray< InstanceGroupManagerAutoHealingPolicymutable_autoHealingPolicies ()
 
bool has_base_instance_name () const
 
void clear_base_instance_name ()
 
const StringPiece get_base_instance_name () const
 
void set_base_instance_name (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_current_actions () const
 
void clear_current_actions ()
 
const InstanceGroupManagerActionsSummary get_current_actions () const
 
InstanceGroupManagerActionsSummary mutable_currentActions ()
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_distribution_policy () const
 
void clear_distribution_policy ()
 
const DistributionPolicy get_distribution_policy () const
 
DistributionPolicy mutable_distributionPolicy ()
 
bool has_fingerprint () const
 
void clear_fingerprint ()
 
const StringPiece get_fingerprint () const
 
void set_fingerprint (const StringPiece &value)
 
bool has_id () const
 
void clear_id ()
 
uint64 get_id () const
 
void set_id (uint64 value)
 
bool has_instance_group () const
 
void clear_instance_group ()
 
const StringPiece get_instance_group () const
 
void set_instance_group (const StringPiece &value)
 
bool has_instance_template () const
 
void clear_instance_template ()
 
const StringPiece get_instance_template () const
 
void set_instance_template (const StringPiece &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_named_ports () const
 
void clear_named_ports ()
 
const client::JsonCppArray< NamedPortget_named_ports () const
 
client::JsonCppArray< NamedPortmutable_namedPorts ()
 
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_status () const
 
void clear_status ()
 
const InstanceGroupManagerStatus get_status () const
 
InstanceGroupManagerStatus mutable_status ()
 
bool has_target_pools () const
 
void clear_target_pools ()
 
const client::JsonCppArray< string > get_target_pools () const
 
client::JsonCppArray< string > mutable_targetPools ()
 
bool has_target_size () const
 
void clear_target_size ()
 
int32 get_target_size () const
 
void set_target_size (int32 value)
 
bool has_update_policy () const
 
void clear_update_policy ()
 
const InstanceGroupManagerUpdatePolicy get_update_policy () const
 
InstanceGroupManagerUpdatePolicy mutable_updatePolicy ()
 
bool has_versions () const
 
void clear_versions ()
 
const client::JsonCppArray< InstanceGroupManagerVersionget_versions () const
 
client::JsonCppArray< InstanceGroupManagerVersionmutable_versions ()
 
bool has_zone () const
 
void clear_zone ()
 
const StringPiece get_zone () const
 
void set_zone (const StringPiece &value)
 

Static Public Member Functions

static InstanceGroupManagerNew ()
 

Detailed Description

An Instance Group Manager resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==).

Constructor & Destructor Documentation

◆ InstanceGroupManager() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ InstanceGroupManager() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~InstanceGroupManager()

google_compute_api::InstanceGroupManager::~InstanceGroupManager ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_auto_healing_policies()

void google_compute_api::InstanceGroupManager::clear_auto_healing_policies ( )
inline

Clears the 'autoHealingPolicies' attribute.

◆ clear_base_instance_name()

void google_compute_api::InstanceGroupManager::clear_base_instance_name ( )
inline

Clears the 'baseInstanceName' attribute.

◆ clear_creation_timestamp()

void google_compute_api::InstanceGroupManager::clear_creation_timestamp ( )
inline

Clears the 'creationTimestamp' attribute.

◆ clear_current_actions()

void google_compute_api::InstanceGroupManager::clear_current_actions ( )
inline

Clears the 'currentActions' attribute.

◆ clear_description()

void google_compute_api::InstanceGroupManager::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_distribution_policy()

void google_compute_api::InstanceGroupManager::clear_distribution_policy ( )
inline

Clears the 'distributionPolicy' attribute.

◆ clear_fingerprint()

void google_compute_api::InstanceGroupManager::clear_fingerprint ( )
inline

Clears the 'fingerprint' attribute.

◆ clear_id()

void google_compute_api::InstanceGroupManager::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_instance_group()

void google_compute_api::InstanceGroupManager::clear_instance_group ( )
inline

Clears the 'instanceGroup' attribute.

◆ clear_instance_template()

void google_compute_api::InstanceGroupManager::clear_instance_template ( )
inline

Clears the 'instanceTemplate' attribute.

◆ clear_kind()

void google_compute_api::InstanceGroupManager::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_name()

void google_compute_api::InstanceGroupManager::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_named_ports()

void google_compute_api::InstanceGroupManager::clear_named_ports ( )
inline

Clears the 'namedPorts' attribute.

◆ clear_region()

void google_compute_api::InstanceGroupManager::clear_region ( )
inline

Clears the 'region' attribute.

◆ clear_self_link()

void google_compute_api::InstanceGroupManager::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ clear_status()

void google_compute_api::InstanceGroupManager::clear_status ( )
inline

Clears the 'status' attribute.

◆ clear_target_pools()

void google_compute_api::InstanceGroupManager::clear_target_pools ( )
inline

Clears the 'targetPools' attribute.

◆ clear_target_size()

void google_compute_api::InstanceGroupManager::clear_target_size ( )
inline

Clears the 'targetSize' attribute.

◆ clear_update_policy()

void google_compute_api::InstanceGroupManager::clear_update_policy ( )
inline

Clears the 'updatePolicy' attribute.

◆ clear_versions()

void google_compute_api::InstanceGroupManager::clear_versions ( )
inline

Clears the 'versions' attribute.

◆ clear_zone()

void google_compute_api::InstanceGroupManager::clear_zone ( )
inline

Clears the 'zone' attribute.

◆ get_auto_healing_policies()

const client::JsonCppArray<InstanceGroupManagerAutoHealingPolicy > google_compute_api::InstanceGroupManager::get_auto_healing_policies ( ) const

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

◆ get_base_instance_name()

const StringPiece google_compute_api::InstanceGroupManager::get_base_instance_name ( ) const
inline

Get the value of the 'baseInstanceName' attribute.

◆ get_creation_timestamp()

const StringPiece google_compute_api::InstanceGroupManager::get_creation_timestamp ( ) const
inline

Get the value of the 'creationTimestamp' attribute.

◆ get_current_actions()

const InstanceGroupManagerActionsSummary google_compute_api::InstanceGroupManager::get_current_actions ( ) const

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

◆ get_description()

const StringPiece google_compute_api::InstanceGroupManager::get_description ( ) const
inline

Get the value of the 'description' attribute.

◆ get_distribution_policy()

const DistributionPolicy google_compute_api::InstanceGroupManager::get_distribution_policy ( ) const

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

◆ get_fingerprint()

const StringPiece google_compute_api::InstanceGroupManager::get_fingerprint ( ) const
inline

Get the value of the 'fingerprint' attribute.

◆ get_id()

uint64 google_compute_api::InstanceGroupManager::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_instance_group()

const StringPiece google_compute_api::InstanceGroupManager::get_instance_group ( ) const
inline

Get the value of the 'instanceGroup' attribute.

◆ get_instance_template()

const StringPiece google_compute_api::InstanceGroupManager::get_instance_template ( ) const
inline

Get the value of the 'instanceTemplate' attribute.

◆ get_kind()

const StringPiece google_compute_api::InstanceGroupManager::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_compute_api::InstanceGroupManager::get_name ( ) const
inline

Get the value of the 'name' attribute.

◆ get_named_ports()

const client::JsonCppArray<NamedPort > google_compute_api::InstanceGroupManager::get_named_ports ( ) const

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

◆ get_region()

const StringPiece google_compute_api::InstanceGroupManager::get_region ( ) const
inline

Get the value of the 'region' attribute.

◆ get_self_link()

const StringPiece google_compute_api::InstanceGroupManager::get_self_link ( ) const
inline

Get the value of the 'selfLink' attribute.

◆ get_status()

const InstanceGroupManagerStatus google_compute_api::InstanceGroupManager::get_status ( ) const

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

◆ get_target_pools()

const client::JsonCppArray<string > google_compute_api::InstanceGroupManager::get_target_pools ( ) const
inline

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

◆ get_target_size()

int32 google_compute_api::InstanceGroupManager::get_target_size ( ) const
inline

Get the value of the 'targetSize' attribute.

◆ get_update_policy()

const InstanceGroupManagerUpdatePolicy google_compute_api::InstanceGroupManager::get_update_policy ( ) const

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

◆ get_versions()

const client::JsonCppArray<InstanceGroupManagerVersion > google_compute_api::InstanceGroupManager::get_versions ( ) const

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

◆ get_zone()

const StringPiece google_compute_api::InstanceGroupManager::get_zone ( ) const
inline

Get the value of the 'zone' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_compute_api::InstanceGroupManager

◆ has_auto_healing_policies()

bool google_compute_api::InstanceGroupManager::has_auto_healing_policies ( ) const
inline

Determine if the 'autoHealingPolicies' attribute was set.

Returns
true if the 'autoHealingPolicies' attribute was set.

◆ has_base_instance_name()

bool google_compute_api::InstanceGroupManager::has_base_instance_name ( ) const
inline

Determine if the 'baseInstanceName' attribute was set.

Returns
true if the 'baseInstanceName' attribute was set.

◆ has_creation_timestamp()

bool google_compute_api::InstanceGroupManager::has_creation_timestamp ( ) const
inline

Determine if the 'creationTimestamp' attribute was set.

Returns
true if the 'creationTimestamp' attribute was set.

◆ has_current_actions()

bool google_compute_api::InstanceGroupManager::has_current_actions ( ) const
inline

Determine if the 'currentActions' attribute was set.

Returns
true if the 'currentActions' attribute was set.

◆ has_description()

bool google_compute_api::InstanceGroupManager::has_description ( ) const
inline

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_distribution_policy()

bool google_compute_api::InstanceGroupManager::has_distribution_policy ( ) const
inline

Determine if the 'distributionPolicy' attribute was set.

Returns
true if the 'distributionPolicy' attribute was set.

◆ has_fingerprint()

bool google_compute_api::InstanceGroupManager::has_fingerprint ( ) const
inline

Determine if the 'fingerprint' attribute was set.

Returns
true if the 'fingerprint' attribute was set.

◆ has_id()

bool google_compute_api::InstanceGroupManager::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_instance_group()

bool google_compute_api::InstanceGroupManager::has_instance_group ( ) const
inline

Determine if the 'instanceGroup' attribute was set.

Returns
true if the 'instanceGroup' attribute was set.

◆ has_instance_template()

bool google_compute_api::InstanceGroupManager::has_instance_template ( ) const
inline

Determine if the 'instanceTemplate' attribute was set.

Returns
true if the 'instanceTemplate' attribute was set.

◆ has_kind()

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

Determine if the 'name' attribute was set.

Returns
true if the 'name' attribute was set.

◆ has_named_ports()

bool google_compute_api::InstanceGroupManager::has_named_ports ( ) const
inline

Determine if the 'namedPorts' attribute was set.

Returns
true if the 'namedPorts' attribute was set.

◆ has_region()

bool google_compute_api::InstanceGroupManager::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::InstanceGroupManager::has_self_link ( ) const
inline

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ has_status()

bool google_compute_api::InstanceGroupManager::has_status ( ) const
inline

Determine if the 'status' attribute was set.

Returns
true if the 'status' attribute was set.

◆ has_target_pools()

bool google_compute_api::InstanceGroupManager::has_target_pools ( ) const
inline

Determine if the 'targetPools' attribute was set.

Returns
true if the 'targetPools' attribute was set.

◆ has_target_size()

bool google_compute_api::InstanceGroupManager::has_target_size ( ) const
inline

Determine if the 'targetSize' attribute was set.

Returns
true if the 'targetSize' attribute was set.

◆ has_update_policy()

bool google_compute_api::InstanceGroupManager::has_update_policy ( ) const
inline

Determine if the 'updatePolicy' attribute was set.

Returns
true if the 'updatePolicy' attribute was set.

◆ has_versions()

bool google_compute_api::InstanceGroupManager::has_versions ( ) const
inline

Determine if the 'versions' attribute was set.

Returns
true if the 'versions' attribute was set.

◆ has_zone()

bool google_compute_api::InstanceGroupManager::has_zone ( ) const
inline

Determine if the 'zone' attribute was set.

Returns
true if the 'zone' attribute was set.

◆ mutable_autoHealingPolicies()

client::JsonCppArray<InstanceGroupManagerAutoHealingPolicy > google_compute_api::InstanceGroupManager::mutable_autoHealingPolicies ( )

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

The autohealing policy for this managed instance group. You can specify only one value.

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

◆ mutable_currentActions()

InstanceGroupManagerActionsSummary google_compute_api::InstanceGroupManager::mutable_currentActions ( )

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

[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.

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

◆ mutable_distributionPolicy()

DistributionPolicy google_compute_api::InstanceGroupManager::mutable_distributionPolicy ( )

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

Policy specifying intended distribution of instances in regional managed instance group.

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

◆ mutable_namedPorts()

client::JsonCppArray<NamedPort > google_compute_api::InstanceGroupManager::mutable_namedPorts ( )

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

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

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

◆ mutable_status()

InstanceGroupManagerStatus google_compute_api::InstanceGroupManager::mutable_status ( )

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

[Output Only] The status of this managed instance group.

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

◆ mutable_targetPools()

client::JsonCppArray<string > google_compute_api::InstanceGroupManager::mutable_targetPools ( )
inline

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

The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

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

◆ mutable_updatePolicy()

InstanceGroupManagerUpdatePolicy google_compute_api::InstanceGroupManager::mutable_updatePolicy ( )

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

The update policy for this managed instance group.

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

◆ mutable_versions()

client::JsonCppArray<InstanceGroupManagerVersion > google_compute_api::InstanceGroupManager::mutable_versions ( )

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

Specifies the instance templates used by this managed instance group to create instances.

Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top- level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

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

◆ New()

InstanceGroupManager * google_compute_api::InstanceGroupManager::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_base_instance_name()

void google_compute_api::InstanceGroupManager::set_base_instance_name ( const StringPiece &  value)
inline

Change the 'baseInstanceName' attribute.

The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

Parameters
[in]valueThe new value.

◆ set_creation_timestamp()

void google_compute_api::InstanceGroupManager::set_creation_timestamp ( const StringPiece &  value)
inline

Change the 'creationTimestamp' attribute.

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

Parameters
[in]valueThe new value.

◆ set_description()

void google_compute_api::InstanceGroupManager::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]valueThe new value.

◆ set_fingerprint()

void google_compute_api::InstanceGroupManager::set_fingerprint ( const StringPiece &  value)
inline

Change the 'fingerprint' attribute.

Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

Parameters
[in]valueThe new value.

◆ set_id()

void google_compute_api::InstanceGroupManager::set_id ( uint64  value)
inline

Change the 'id' attribute.

[Output Only] A unique identifier for this resource type. The server generates this identifier.

Parameters
[in]valueThe new value.

◆ set_instance_group()

void google_compute_api::InstanceGroupManager::set_instance_group ( const StringPiece &  value)
inline

Change the 'instanceGroup' attribute.

[Output Only] The URL of the Instance Group resource.

Parameters
[in]valueThe new value.

◆ set_instance_template()

void google_compute_api::InstanceGroupManager::set_instance_template ( const StringPiece &  value)
inline

Change the 'instanceTemplate' attribute.

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_compute_api::InstanceGroupManager::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

[Output Only] The resource type, which is always compute::instanceGroupManager for managed instance groups.

Parameters
[in]valueThe new value.

◆ set_name()

void google_compute_api::InstanceGroupManager::set_name ( const StringPiece &  value)
inline

Change the 'name' attribute.

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

Parameters
[in]valueThe new value.

◆ set_region()

void google_compute_api::InstanceGroupManager::set_region ( const StringPiece &  value)
inline

Change the 'region' attribute.

[Output Only] The URL of the region where the managed instance group resides (for regional resources).

Parameters
[in]valueThe new value.

◆ set_self_link()

void google_compute_api::InstanceGroupManager::set_self_link ( const StringPiece &  value)
inline

Change the 'selfLink' attribute.

[Output Only] The URL for this managed instance group. The server defines this URL.

Parameters
[in]valueThe new value.

◆ set_target_size()

void google_compute_api::InstanceGroupManager::set_target_size ( int32  value)
inline

Change the 'targetSize' attribute.

The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.

Parameters
[in]valueThe new value.

◆ set_zone()

void google_compute_api::InstanceGroupManager::set_zone ( const StringPiece &  value)
inline

Change the 'zone' attribute.

[Output Only] The URL of the zone where the managed instance group is located (for zonal resources).

Parameters
[in]valueThe new value.

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