Class: Google::Apis::ComputeAlpha::InstanceGroupManager

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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.



15043
15044
15045
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15043

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

Instance Attribute Details

#all_instances_config ⇒ Google::Apis::ComputeAlpha::InstanceGroupManagerAllInstancesConfig

Specifies the instances configs overrides that should be applied for all instances in the MIG. Corresponds to the JSON property allInstancesConfig

Returns:



14853
14854
14855
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14853

def all_instances_config
  @all_instances_config
end

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

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

Returns:



14859
14860
14861
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14859

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) 


14867
14868
14869
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14867

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) 


14873
14874
14875
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14873

def creation_timestamp
  @creation_timestamp
end

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



14879
14880
14881
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14879

def current_actions
  @current_actions
end

#description ⇒ String

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

Returns:

  • (String) 


14884
14885
14886
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14884

def description
  @description
end

#distribution_policy ⇒ Google::Apis::ComputeAlpha::DistributionPolicy

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

Returns:



14890
14891
14892
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14890

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) 


14896
14897
14898
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14896

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) 


14906
14907
14908
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14906

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) 


14912
14913
14914
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14912

def id
  @id
end

#instance_group ⇒ String

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

Returns:

  • (String) 


14917
14918
14919
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14917

def instance_group
  @instance_group
end

#instance_lifecycle_policy ⇒ Google::Apis::ComputeAlpha::InstanceGroupManagerInstanceLifecyclePolicy

Instance lifecycle policy for this Instance Group Manager. Corresponds to the JSON property instanceLifecyclePolicy

Returns:



14922
14923
14924
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14922

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) 


14931
14932
14933
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14931

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) 


14937
14938
14939
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14937

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) 


14943
14944
14945
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14943

def name
  @name
end

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

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

Returns:



14949
14950
14951
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14949

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) 


14955
14956
14957
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14955

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) 


14961
14962
14963
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14961

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


14966
14967
14968
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14966

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


14974
14975
14976
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14974

def 
  @service_account
end

#standby_policy ⇒ Google::Apis::ComputeAlpha::InstanceGroupManagerStandbyPolicy

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

Returns:



14979
14980
14981
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14979

def standby_policy
  @standby_policy
end

#stateful_policy ⇒ Google::Apis::ComputeAlpha::StatefulPolicy

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

Returns:



14984
14985
14986
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14984

def stateful_policy
  @stateful_policy
end

#status ⇒ Google::Apis::ComputeAlpha::InstanceGroupManagerStatus

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

Returns:



14989
14990
14991
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14989

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


14996
14997
14998
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14996

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) 


15003
15004
15005
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15003

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


15011
15012
15013
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15011

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) 


15019
15020
15021
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15019

def target_suspended_size
  @target_suspended_size
end

#update_policy ⇒ Google::Apis::ComputeAlpha::InstanceGroupManagerUpdatePolicy

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

Returns:



15024
15025
15026
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15024

def update_policy
  @update_policy
end

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



15035
15036
15037
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15035

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) 


15041
15042
15043
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15041

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 15048

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