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.



23898
23899
23900
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23898

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:



23644
23645
23646
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23644

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:



23650
23651
23652
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23650

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) 


23665
23666
23667
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23665

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) 


23671
23672
23673
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23671

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:



23678
23679
23680
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23678

def current_actions
  @current_actions
end

#description ⇒ String

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

Returns:

  • (String) 


23683
23684
23685
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23683

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:



23689
23690
23691
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23689

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) 


23695
23696
23697
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23695

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) 


23706
23707
23708
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23706

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) 


23712
23713
23714
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23712

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:



23720
23721
23722
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23720

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) 


23725
23726
23727
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23725

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:



23730
23731
23732
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23730

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) 


23739
23740
23741
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23739

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) 


23745
23746
23747
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23745

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) 


23751
23752
23753
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23751

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) 


23756
23757
23758
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23756

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) 


23762
23763
23764
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23762

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:



23768
23769
23770
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23768

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:



23773
23774
23775
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23773

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) 


23779
23780
23781
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23779

def region
  @region
end

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

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

Returns:



23784
23785
23786
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23784

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) 


23789
23790
23791
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23789

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) 


23795
23796
23797
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23795

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) 


23802
23803
23804
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23802

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) 


23811
23812
23813
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23811

def 
  @service_account
end

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

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

Returns:



23816
23817
23818
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23816

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:



23821
23822
23823
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23821

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:



23826
23827
23828
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23826

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


23833
23834
23835
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23833

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) 


23841
23842
23843
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23841

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:



23847
23848
23849
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23847

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) 


23859
23860
23861
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23859

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) 


23871
23872
23873
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23871

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:



23876
23877
23878
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23876

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:



23890
23891
23892
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23890

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) 


23896
23897
23898
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23896

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



23903
23904
23905
23906
23907
23908
23909
23910
23911
23912
23913
23914
23915
23916
23917
23918
23919
23920
23921
23922
23923
23924
23925
23926
23927
23928
23929
23930
23931
23932
23933
23934
23935
23936
23937
23938
23939
23940
23941
 
# File 'lib/google/apis/compute_beta/classes.rb', line 23903

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