Class: Google::Apis::ComputeV1::InstanceGroupManager

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/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, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstanceGroupManager

Returns a new instance of InstanceGroupManager.



15602
15603
15604
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15602

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

Instance Attribute Details

#all_instances_config ⇒ Google::Apis::ComputeV1::InstanceGroupManagerAllInstancesConfig

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

Returns:



15429
15430
15431
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15429

def all_instances_config
  @all_instances_config
end

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

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

Returns:



15435
15436
15437
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15435

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. @pattern a-z Corresponds to the JSON property baseInstanceName

Returns:

  • (String) 


15448
15449
15450
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15448

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) 


15454
15455
15456
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15454

def creation_timestamp
  @creation_timestamp
end

#current_actions ⇒ Google::Apis::ComputeV1::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:



15460
15461
15462
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15460

def current_actions
  @current_actions
end

#description ⇒ String

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

Returns:

  • (String) 


15465
15466
15467
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15465

def description
  @description
end

#distribution_policy ⇒ Google::Apis::ComputeV1::DistributionPolicy

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

Returns:



15471
15472
15473
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15471

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


15481
15482
15483
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15481

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) 


15487
15488
15489
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15487

def id
  @id
end

#instance_group ⇒ String

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

Returns:

  • (String) 


15492
15493
15494
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15492

def instance_group
  @instance_group
end

#instance_lifecycle_policy ⇒ Google::Apis::ComputeV1::InstanceGroupManagerInstanceLifecyclePolicy

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

Returns:



15497
15498
15499
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15497

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

Returns:

  • (String) 


15506
15507
15508
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15506

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) 


15512
15513
15514
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15512

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) 


15518
15519
15520
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15518

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


15524
15525
15526
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15524

def name
  @name
end

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

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

Returns:



15530
15531
15532
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15530

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) 


15536
15537
15538
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15536

def region
  @region
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

[Output Only] Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


15541
15542
15543
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15541

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) 


15547
15548
15549
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15547

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) 


15554
15555
15556
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15554

def self_link
  @self_link
end

#stateful_policy ⇒ Google::Apis::ComputeV1::StatefulPolicy

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

Returns:



15559
15560
15561
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15559

def stateful_policy
  @stateful_policy
end

#status ⇒ Google::Apis::ComputeV1::InstanceGroupManagerStatus

[Output Only] The status of this managed instance group. Corresponds to the JSON property status

Returns:



15564
15565
15566
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15564

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


15571
15572
15573
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15571

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) 


15578
15579
15580
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15578

def target_size
  @target_size
end

#update_policy ⇒ Google::Apis::ComputeV1::InstanceGroupManagerUpdatePolicy

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

Returns:



15583
15584
15585
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15583

def update_policy
  @update_policy
end

#versions ⇒ Array<Google::Apis::ComputeV1::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:



15594
15595
15596
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15594

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) 


15600
15601
15602
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15600

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15607

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)
  @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_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)
  @name = args[:name] if args.key?(:name)
  @named_ports = args[:named_ports] if args.key?(:named_ports)
  @region = args[:region] if args.key?(:region)
  @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)
  @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