Class: Google::Apis::ComputeBeta::InstanceGroupManager

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/representations.rb

Overview

Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, readInstance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use theregionInstanceGroupManagers resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstanceGroupManager

Returns a new instance of InstanceGroupManager.



24381
24382
24383
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24381

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#all_instances_config ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerAllInstancesConfig

Specifies configuration that overrides the instance template configuration for the group. Corresponds to the JSON property allInstancesConfig

Returns:



24127
24128
24129
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24127

def all_instances_config
  @all_instances_config
end

#auto_healing_policies ⇒ Array<Google::Apis::ComputeBeta::InstanceGroupManagerAutoHealingPolicy>

The autohealing policy for this managed instance group. You can specify only one value. Corresponds to the JSON property autoHealingPolicies

Returns:



24133
24134
24135
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24133

def auto_healing_policies
  @auto_healing_policies
end

#base_instance_name ⇒ String

The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. a-z Corresponds to the JSON property baseInstanceName

Returns:

  • (String) 


24148
24149
24150
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24148

def base_instance_name
  @base_instance_name
end

#creation_timestamp ⇒ String

Output only. The creation timestamp for this managed instance group inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


24154
24155
24156
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24154

def creation_timestamp
  @creation_timestamp
end

#current_actions ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerActionsSummary

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. Corresponds to the JSON property currentActions

Returns:



24161
24162
24163
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24161

def current_actions
  @current_actions
end

#description ⇒ String

An optional description of this resource. Corresponds to the JSON property description

Returns:

  • (String) 


24166
24167
24168
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24166

def description
  @description
end

#distribution_policy ⇒ Google::Apis::ComputeBeta::DistributionPolicy

Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. Corresponds to the JSON property distributionPolicy

Returns:



24172
24173
24174
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24172

def distribution_policy
  @distribution_policy
end

#failover_action ⇒ String

The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. Corresponds to the JSON property failoverAction

Returns:

  • (String) 


24178
24179
24180
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24178

def failover_action
  @failover_action
end

#fingerprint ⇒ String

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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


24189
24190
24191
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24189

def fingerprint
  @fingerprint
end

#id ⇒ Fixnum

Output only. A unique identifier for this resource type. The server generates this identifier. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


24195
24196
24197
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24195

def id
  @id
end

#instance_flexibility_policy ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerInstanceFlexibilityPolicy

Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. Corresponds to the JSON property instanceFlexibilityPolicy

Returns:



24203
24204
24205
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24203

def instance_flexibility_policy
  @instance_flexibility_policy
end

#instance_group ⇒ String

Output only. The URL of the Instance Group resource. Corresponds to the JSON property instanceGroup

Returns:

  • (String) 


24208
24209
24210
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24208

def instance_group
  @instance_group
end

#instance_lifecycle_policy ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerInstanceLifecyclePolicy

The repair policy for this managed instance group. Corresponds to the JSON property instanceLifecyclePolicy

Returns:



24213
24214
24215
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24213

def instance_lifecycle_policy
  @instance_lifecycle_policy
end

#instance_template ⇒ String

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. The templates for existing instances in the group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE. Corresponds to the JSON property instanceTemplate

Returns:

  • (String) 


24222
24223
24224
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24222

def instance_template
  @instance_template
end

#kind ⇒ String

Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups. Corresponds to the JSON property kind

Returns:

  • (String) 


24228
24229
24230
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24228

def kind
  @kind
end

#list_managed_instances_results ⇒ String

Pagination behavior of the listManagedInstances API method for this managed instance group. Corresponds to the JSON property listManagedInstancesResults

Returns:

  • (String) 


24234
24235
24236
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24234

def list_managed_instances_results
  @list_managed_instances_results
end

#multi_mig ⇒ String

URL to the multi-MIG that this Managed Instance Group belongs to. Corresponds to the JSON property multiMig

Returns:

  • (String) 


24239
24240
24241
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24239

def multi_mig
  @multi_mig
end

#name ⇒ String

The name of the managed instance group. The name must be 1-63 characters long, and comply withRFC1035. Corresponds to the JSON property name

Returns:

  • (String) 


24245
24246
24247
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24245

def name
  @name
end

#named_ports ⇒ Array<Google::Apis::ComputeBeta::NamedPort>

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. Corresponds to the JSON property namedPorts

Returns:



24251
24252
24253
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24251

def named_ports
  @named_ports
end

#params ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerParams

Input only additional params for instance group manager creation. Corresponds to the JSON property params

Returns:



24256
24257
24258
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24256

def params
  @params
end

#region ⇒ String

Output only. [Output Only] The URL of theregion where the managed instance group resides (for regional resources). Corresponds to the JSON property region

Returns:

  • (String) 


24262
24263
24264
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24262

def region
  @region
end

#resource_policies ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerResourcePolicies

Resource policies for this managed instance group. Corresponds to the JSON property resourcePolicies

Returns:



24267
24268
24269
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24267

def resource_policies
  @resource_policies
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


24272
24273
24274
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24272

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


24278
24279
24280
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24278

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

Output only. The URL for this managed instance group. The server defines this URL. Corresponds to the JSON property selfLink

Returns:

  • (String) 


24285
24286
24287
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24285

def self_link
  @self_link
end

#service_account ⇒ String

The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account projectNumber@cloudservices.gserviceaccount.com is used. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


24294
24295
24296
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24294

def 
  @service_account
end

#standby_policy ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerStandbyPolicy

Standby policy for stopped and suspended instances. Corresponds to the JSON property standbyPolicy

Returns:



24299
24300
24301
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24299

def standby_policy
  @standby_policy
end

#stateful_policy ⇒ Google::Apis::ComputeBeta::StatefulPolicy

Stateful configuration for this Instanced Group Manager Corresponds to the JSON property statefulPolicy

Returns:



24304
24305
24306
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24304

def stateful_policy
  @stateful_policy
end

#status ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerStatus

Output only. The status of this managed instance group. Corresponds to the JSON property status

Returns:



24309
24310
24311
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24309

def status
  @status
end

#target_pools ⇒ Array<String>

The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. Corresponds to the JSON property targetPools

Returns:

  • (Array<String>) 


24316
24317
24318
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24316

def target_pools
  @target_pools
end

#target_size ⇒ Fixnum

The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. Corresponds to the JSON property targetSize

Returns:

  • (Fixnum) 


24324
24325
24326
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24324

def target_size
  @target_size
end

#target_size_policy ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerTargetSizePolicy

The policy that specifies how the MIG creates its VMs to achieve the target size. Corresponds to the JSON property targetSizePolicy

Returns:



24330
24331
24332
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24330

def target_size_policy
  @target_size_policy
end

#target_stopped_size ⇒ Fixnum

The target number of stopped instances for this managed instance group. This number changes when you:

  • Stop instance using the stopInstances method or start instances using the startInstances method.
  • Manually change the targetStoppedSize using the update method. Corresponds to the JSON property targetStoppedSize

Returns:

  • (Fixnum) 


24342
24343
24344
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24342

def target_stopped_size
  @target_stopped_size
end

#target_suspended_size ⇒ Fixnum

The target number of suspended instances for this managed instance group. This number changes when you:

  • Suspend instance using the suspendInstances method or resume instances using the resumeInstances method.
  • Manually change the targetSuspendedSize using the update method. Corresponds to the JSON property targetSuspendedSize

Returns:

  • (Fixnum) 


24354
24355
24356
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24354

def target_suspended_size
  @target_suspended_size
end

#update_policy ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerUpdatePolicy

The update policy for this managed instance group. Corresponds to the JSON property updatePolicy

Returns:



24359
24360
24361
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24359

def update_policy
  @update_policy
end

#versions ⇒ Array<Google::Apis::ComputeBeta::InstanceGroupManagerVersion>

Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about therelationships between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all remaining instances. For more information, read aboutcanary updates. Corresponds to the JSON property versions

Returns:



24373
24374
24375
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24373

def versions
  @versions
end

#zone ⇒ String

Output only. The URL of azone where the managed instance group is located (for zonal resources). Corresponds to the JSON property zone

Returns:

  • (String) 


24379
24380
24381
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24379

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



24386
24387
24388
24389
24390
24391
24392
24393
24394
24395
24396
24397
24398
24399
24400
24401
24402
24403
24404
24405
24406
24407
24408
24409
24410
24411
24412
24413
24414
24415
24416
24417
24418
24419
24420
24421
24422
24423
24424
 
# File 'lib/google/apis/compute_beta/classes.rb', line 24386

def update!(**args)
  @all_instances_config = args[:all_instances_config] if args.key?(:all_instances_config)
  @auto_healing_policies = args[:auto_healing_policies] if args.key?(:auto_healing_policies)
  @base_instance_name = args[:base_instance_name] if args.key?(:base_instance_name)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @current_actions = args[:current_actions] if args.key?(:current_actions)
  @description = args[:description] if args.key?(:description)
  @distribution_policy = args[:distribution_policy] if args.key?(:distribution_policy)
  @failover_action = args[:failover_action] if args.key?(:failover_action)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @id = args[:id] if args.key?(:id)
  @instance_flexibility_policy = args[:instance_flexibility_policy] if args.key?(:instance_flexibility_policy)
  @instance_group = args[:instance_group] if args.key?(:instance_group)
  @instance_lifecycle_policy = args[:instance_lifecycle_policy] if args.key?(:instance_lifecycle_policy)
  @instance_template = args[:instance_template] if args.key?(:instance_template)
  @kind = args[:kind] if args.key?(:kind)
  @list_managed_instances_results = args[:list_managed_instances_results] if args.key?(:list_managed_instances_results)
  @multi_mig = args[:multi_mig] if args.key?(:multi_mig)
  @name = args[:name] if args.key?(:name)
  @named_ports = args[:named_ports] if args.key?(:named_ports)
  @params = args[:params] if args.key?(:params)
  @region = args[:region] if args.key?(:region)
  @resource_policies = args[:resource_policies] if args.key?(:resource_policies)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @self_link = args[:self_link] if args.key?(:self_link)
  @service_account = args[:service_account] if args.key?(:service_account)
  @standby_policy = args[:standby_policy] if args.key?(:standby_policy)
  @stateful_policy = args[:stateful_policy] if args.key?(:stateful_policy)
  @status = args[:status] if args.key?(:status)
  @target_pools = args[:target_pools] if args.key?(:target_pools)
  @target_size = args[:target_size] if args.key?(:target_size)
  @target_size_policy = args[:target_size_policy] if args.key?(:target_size_policy)
  @target_stopped_size = args[:target_stopped_size] if args.key?(:target_stopped_size)
  @target_suspended_size = args[:target_suspended_size] if args.key?(:target_suspended_size)
  @update_policy = args[:update_policy] if args.key?(:update_policy)
  @versions = args[:versions] if args.key?(:versions)
  @zone = args[:zone] if args.key?(:zone)
end