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

Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ====================================================== =================== | regular | standby ======================================= ================================== managed by IGM? | yes | yes added to the IG? | yes | yes counts towards IGM's target size? | yes | no taken into account

by Autoscaler? | yes | no receives traffic from LB? | yes | no ================

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, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for $api_version.instanceGroupManagers ==) (== resource_for $api_version.regionInstanceGroupManagers ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstanceGroupManager

Returns a new instance of InstanceGroupManager.



13505
13506
13507
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13505

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

Instance Attribute Details

#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:



13349
13350
13351
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13349

def auto_healing_policies
  @auto_healing_policies
end

#base_instance_name ⇒ String

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

Returns:

  • (String) 


13357
13358
13359
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13357

def base_instance_name
  @base_instance_name
end

#creation_timestamp ⇒ String

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


13363
13364
13365
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13363

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:



13369
13370
13371
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13369

def current_actions
  @current_actions
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


13375
13376
13377
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13375

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:



13381
13382
13383
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13381

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) 


13387
13388
13389
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13387

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 error 412 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) 


13398
13399
13400
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13398

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) 


13404
13405
13406
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13404

def id
  @id
end

#instance_group ⇒ String

[Output Only] The URL of the Instance Group resource. Corresponds to the JSON property instanceGroup

Returns:

  • (String) 


13409
13410
13411
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13409

def instance_group
  @instance_group
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, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. Corresponds to the JSON property instanceTemplate

Returns:

  • (String) 


13418
13419
13420
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13418

def instance_template
  @instance_template
end

#kind ⇒ String

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. Corresponds to the JSON property kind

Returns:

  • (String) 


13424
13425
13426
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13424

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


13430
13431
13432
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13430

def name
  @name
end

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

Named ports configured for the Instance Groups complementary to this Instance Group Manager. Corresponds to the JSON property namedPorts

Returns:



13436
13437
13438
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13436

def named_ports
  @named_ports
end

#region ⇒ String

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

Returns:

  • (String) 


13442
13443
13444
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13442

def region
  @region
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) 


13448
13449
13450
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13448

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) 


13456
13457
13458
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13456

def 
  @service_account
end

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

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

Returns:



13461
13462
13463
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13461

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:



13466
13467
13468
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13466

def status
  @status
end

#target_pools ⇒ Array<String>

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

Returns:

  • (Array<String>) 


13473
13474
13475
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13473

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) 


13480
13481
13482
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13480

def target_size
  @target_size
end

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

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

Returns:



13485
13486
13487
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13485

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

Returns:



13497
13498
13499
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13497

def versions
  @versions
end

#zone ⇒ String

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

Returns:

  • (String) 


13503
13504
13505
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13503

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13510

def update!(**args)
  @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_group = args[:instance_group] if args.key?(:instance_group)
  @instance_template = args[:instance_template] if args.key?(:instance_template)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @named_ports = args[:named_ports] if args.key?(:named_ports)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @service_account = args[:service_account] if args.key?(:service_account)
  @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)
  @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