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

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

Overview

An Instance Group Manager resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ InstanceGroupManager

Returns a new instance of InstanceGroupManager



9014
9015
9016
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9014

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

Instance Attribute Details

#activities ⇒ Google::Apis::ComputeAlpha::InstanceGroupManagerActivities

Corresponds to the JSON property activities

Returns:



8858
8859
8860
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8858

def activities
  @activities
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:



8864
8865
8866
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8864

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) 


8872
8873
8874
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8872

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) 


8878
8879
8880
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8878

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:



8884
8885
8886
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8884

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) 


8890
8891
8892
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8890

def description
  @description
end

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

Policy valid only for regional managed instance groups. Corresponds to the JSON property distributionPolicy

Returns:



8895
8896
8897
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8895

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) 


8901
8902
8903
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8901

def failover_action
  @failover_action
end

#fingerprint ⇒ String

[Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


8908
8909
8910
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8908

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) 


8914
8915
8916
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8914

def id
  @id
end

#instance_group ⇒ String

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

Returns:

  • (String) 


8919
8920
8921
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8919

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

Returns:

  • (String) 


8926
8927
8928
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8926

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) 


8932
8933
8934
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8932

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) 


8938
8939
8940
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8938

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:



8944
8945
8946
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8944

def named_ports
  @named_ports
end

#pending_actions ⇒ Google::Apis::ComputeAlpha::InstanceGroupManagerPendingActionsSummary

[Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions. Corresponds to the JSON property pendingActions

Returns:



8950
8951
8952
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8950

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


8956
8957
8958
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8956

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) 


8962
8963
8964
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8962

def self_link
  @self_link
end

#service_account ⇒ String

[Output Only] 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) 


8970
8971
8972
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8970

def 
  @service_account
end

#stateful_policy ⇒ Google::Apis::ComputeAlpha::InstanceGroupManagerStatefulPolicy

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

Returns:



8975
8976
8977
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8975

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


8982
8983
8984
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8982

def target_pools
  @target_pools
end

#target_size ⇒ Fixnum

The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. Corresponds to the JSON property targetSize

Returns:

  • (Fixnum) 


8989
8990
8991
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8989

def target_size
  @target_size
end

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

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

Returns:



8994
8995
8996
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8994

def update_policy
  @update_policy
end

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

Versions supported by this IGM. User should set this field if they need fine- grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. " instanceTemplate: X" is semantically equivalent to "versions [ instanceTemplate: X ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically. Corresponds to the JSON property versions

Returns:



9006
9007
9008
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9006

def versions
  @versions
end

#zone ⇒ String

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

Returns:

  • (String) 


9012
9013
9014
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9012

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9019

def update!(**args)
  @activities = args[:activities] if args.key?(:activities)
  @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)
  @pending_actions = args[:pending_actions] if args.key?(:pending_actions)
  @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)
  @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