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



9315
9316
9317
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9315

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

Instance Attribute Details

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

Corresponds to the JSON property activities

Returns:



9159
9160
9161
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9159

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:



9165
9166
9167
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9165

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) 


9173
9174
9175
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9173

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) 


9179
9180
9181
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9179

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:



9185
9186
9187
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9185

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) 


9191
9192
9193
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9191

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:



9196
9197
9198
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9196

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) 


9202
9203
9204
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9202

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) 


9209
9210
9211
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9209

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) 


9215
9216
9217
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9215

def id
  @id
end

#instance_group ⇒ String

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

Returns:

  • (String) 


9220
9221
9222
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9220

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) 


9227
9228
9229
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9227

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) 


9233
9234
9235
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9233

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) 


9239
9240
9241
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9239

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:



9245
9246
9247
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9245

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:



9251
9252
9253
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9251

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) 


9257
9258
9259
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9257

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) 


9263
9264
9265
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9263

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) 


9271
9272
9273
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9271

def 
  @service_account
end

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

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

Returns:



9276
9277
9278
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9276

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


9283
9284
9285
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9283

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) 


9290
9291
9292
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9290

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:



9295
9296
9297
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9295

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. Every template 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:



9307
9308
9309
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9307

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) 


9313
9314
9315
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9313

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9320

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