Class: Google::Apis::ComputeV1::InstanceGroupManager

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/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



7345
7346
7347
# File 'generated/google/apis/compute_v1/classes.rb', line 7345

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

Instance Attribute Details

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


7249
7250
7251
# File 'generated/google/apis/compute_v1/classes.rb', line 7249

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)


7255
7256
7257
# File 'generated/google/apis/compute_v1/classes.rb', line 7255

def creation_timestamp
  @creation_timestamp
end

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



7261
7262
7263
# File 'generated/google/apis/compute_v1/classes.rb', line 7261

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)


7267
7268
7269
# File 'generated/google/apis/compute_v1/classes.rb', line 7267

def description
  @description
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. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


7275
7276
7277
# File 'generated/google/apis/compute_v1/classes.rb', line 7275

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)


7281
7282
7283
# File 'generated/google/apis/compute_v1/classes.rb', line 7281

def id
  @id
end

#instance_groupString

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

Returns:

  • (String)


7286
7287
7288
# File 'generated/google/apis/compute_v1/classes.rb', line 7286

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)


7293
7294
7295
# File 'generated/google/apis/compute_v1/classes.rb', line 7293

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)


7299
7300
7301
# File 'generated/google/apis/compute_v1/classes.rb', line 7299

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)


7305
7306
7307
# File 'generated/google/apis/compute_v1/classes.rb', line 7305

def name
  @name
end

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

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



7311
7312
7313
# File 'generated/google/apis/compute_v1/classes.rb', line 7311

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


7317
7318
7319
# File 'generated/google/apis/compute_v1/classes.rb', line 7317

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)


7323
7324
7325
# File 'generated/google/apis/compute_v1/classes.rb', line 7323

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


7330
7331
7332
# File 'generated/google/apis/compute_v1/classes.rb', line 7330

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)


7337
7338
7339
# File 'generated/google/apis/compute_v1/classes.rb', line 7337

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


7343
7344
7345
# File 'generated/google/apis/compute_v1/classes.rb', line 7343

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
# File 'generated/google/apis/compute_v1/classes.rb', line 7350

def update!(**args)
  @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)
  @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)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @target_pools = args[:target_pools] if args.key?(:target_pools)
  @target_size = args[:target_size] if args.key?(:target_size)
  @zone = args[:zone] if args.key?(:zone)
end