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



9473
9474
9475
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9473

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

Instance Attribute Details

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

Corresponds to the JSON property activities

Returns:



9317
9318
9319
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9317

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:



9323
9324
9325
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9323

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) 


9331
9332
9333
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9331

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) 


9337
9338
9339
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9337

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:



9343
9344
9345
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9343

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) 


9349
9350
9351
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9349

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:



9354
9355
9356
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9354

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) 


9360
9361
9362
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9360

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) 


9367
9368
9369
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9367

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) 


9373
9374
9375
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9373

def id
  @id
end

#instance_group ⇒ String

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

Returns:

  • (String) 


9378
9379
9380
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9378

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) 


9385
9386
9387
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9385

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) 


9391
9392
9393
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9391

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) 


9397
9398
9399
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9397

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:



9403
9404
9405
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9403

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:



9409
9410
9411
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9409

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) 


9415
9416
9417
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9415

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) 


9421
9422
9423
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9421

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) 


9429
9430
9431
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9429

def 
  @service_account
end

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

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

Returns:



9434
9435
9436
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9434

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


9441
9442
9443
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9441

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) 


9448
9449
9450
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9448

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:



9453
9454
9455
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9453

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:



9465
9466
9467
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9465

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) 


9471
9472
9473
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9471

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9478

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