Class: Google::Apis::ComputeBeta::InstanceGroupManager

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

Overview

An Instance Group Manager resource. (== resource_for beta. instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1. regionInstanceGroupManagers ==)

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



8357
8358
8359
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8357

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

Instance Attribute Details

#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:



8208
8209
8210
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8208

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) 


8216
8217
8218
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8216

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) 


8222
8223
8224
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8222

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:



8228
8229
8230
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8228

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) 


8234
8235
8236
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8234

def description
  @description
end

#distribution_policy ⇒ Google::Apis::ComputeBeta::DistributionPolicy

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

Returns:



8240
8241
8242
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8240

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) 


8246
8247
8248
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8246

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


8256
8257
8258
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8256

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) 


8262
8263
8264
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8262

def id
  @id
end

#instance_group ⇒ String

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

Returns:

  • (String) 


8267
8268
8269
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8267

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) 


8274
8275
8276
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8274

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) 


8280
8281
8282
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8280

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) 


8286
8287
8288
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8286

def name
  @name
end

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

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

Returns:



8292
8293
8294
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8292

def named_ports
  @named_ports
end

#pending_actions ⇒ Google::Apis::ComputeBeta::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:



8298
8299
8300
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8298

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) 


8304
8305
8306
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8304

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) 


8310
8311
8312
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8310

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) 


8318
8319
8320
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8318

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


8325
8326
8327
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8325

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) 


8332
8333
8334
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8332

def target_size
  @target_size
end

#update_policy ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerUpdatePolicy

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

Returns:



8337
8338
8339
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8337

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



8349
8350
8351
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8349

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) 


8355
8356
8357
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8355

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8362

def update!(**args)
  @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)
  @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