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

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. (== 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



10566
10567
10568
# File 'generated/google/apis/compute_beta/classes.rb', line 10566

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

Instance Attribute Details

#auto_healing_policiesArray<Google::Apis::ComputeBeta::InstanceGroupManagerAutoHealingPolicy>

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



10408
10409
10410
# File 'generated/google/apis/compute_beta/classes.rb', line 10408

def auto_healing_policies
  @auto_healing_policies
end

#base_instance_nameString

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)


10416
10417
10418
# File 'generated/google/apis/compute_beta/classes.rb', line 10416

def base_instance_name
  @base_instance_name
end

#creation_timestampString

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)


10422
10423
10424
# File 'generated/google/apis/compute_beta/classes.rb', line 10422

def creation_timestamp
  @creation_timestamp
end

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



10428
10429
10430
# File 'generated/google/apis/compute_beta/classes.rb', line 10428

def current_actions
  @current_actions
end

#descriptionString

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)


10434
10435
10436
# File 'generated/google/apis/compute_beta/classes.rb', line 10434

def description
  @description
end

#distribution_policyGoogle::Apis::ComputeBeta::DistributionPolicy

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



10440
10441
10442
# File 'generated/google/apis/compute_beta/classes.rb', line 10440

def distribution_policy
  @distribution_policy
end

#failover_actionString

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)


10446
10447
10448
# File 'generated/google/apis/compute_beta/classes.rb', line 10446

def failover_action
  @failover_action
end

#fingerprintString

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)


10457
10458
10459
# File 'generated/google/apis/compute_beta/classes.rb', line 10457

def fingerprint
  @fingerprint
end

#idFixnum

[Output Only] A unique identifier for this resource type. The server generates this identifier. Corresponds to the JSON property id

Returns:

  • (Fixnum)


10463
10464
10465
# File 'generated/google/apis/compute_beta/classes.rb', line 10463

def id
  @id
end

#instance_groupString

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

Returns:

  • (String)


10468
10469
10470
# File 'generated/google/apis/compute_beta/classes.rb', line 10468

def instance_group
  @instance_group
end

#instance_templateString

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)


10475
10476
10477
# File 'generated/google/apis/compute_beta/classes.rb', line 10475

def instance_template
  @instance_template
end

#kindString

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. Corresponds to the JSON property kind

Returns:

  • (String)


10481
10482
10483
# File 'generated/google/apis/compute_beta/classes.rb', line 10481

def kind
  @kind
end

#nameString

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)


10487
10488
10489
# File 'generated/google/apis/compute_beta/classes.rb', line 10487

def name
  @name
end

#named_portsArray<Google::Apis::ComputeBeta::NamedPort>

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



10493
10494
10495
# File 'generated/google/apis/compute_beta/classes.rb', line 10493

def named_ports
  @named_ports
end

#pending_actionsGoogle::Apis::ComputeBeta::InstanceGroupManagerPendingActionsSummary

[Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [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



10502
10503
10504
# File 'generated/google/apis/compute_beta/classes.rb', line 10502

def pending_actions
  @pending_actions
end

#regionString

[Output Only] The URL of the region where the managed instance group resides ( for regional resources). Corresponds to the JSON property region

Returns:

  • (String)


10508
10509
10510
# File 'generated/google/apis/compute_beta/classes.rb', line 10508

def region
  @region
end

[Output Only] The URL for this managed instance group. The server defines this URL. Corresponds to the JSON property selfLink

Returns:

  • (String)


10514
10515
10516
# File 'generated/google/apis/compute_beta/classes.rb', line 10514

def self_link
  @self_link
end

#service_accountString

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)


10522
10523
10524
# File 'generated/google/apis/compute_beta/classes.rb', line 10522

def 
  @service_account
end

#statusGoogle::Apis::ComputeBeta::InstanceGroupManagerStatus

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



10527
10528
10529
# File 'generated/google/apis/compute_beta/classes.rb', line 10527

def status
  @status
end

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


10534
10535
10536
# File 'generated/google/apis/compute_beta/classes.rb', line 10534

def target_pools
  @target_pools
end

#target_sizeFixnum

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)


10541
10542
10543
# File 'generated/google/apis/compute_beta/classes.rb', line 10541

def target_size
  @target_size
end

#update_policyGoogle::Apis::ComputeBeta::InstanceGroupManagerUpdatePolicy

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



10546
10547
10548
# File 'generated/google/apis/compute_beta/classes.rb', line 10546

def update_policy
  @update_policy
end

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



10558
10559
10560
# File 'generated/google/apis/compute_beta/classes.rb', line 10558

def versions
  @versions
end

#zoneString

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


10564
10565
10566
# File 'generated/google/apis/compute_beta/classes.rb', line 10564

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
# File 'generated/google/apis/compute_beta/classes.rb', line 10571

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