Class: Google::Apis::ComputeV1::InstanceGroup

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

Overview

Represents an Instance Group resource. Instance Groups can be used to configure a target forload balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to applyload balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, readInstance groups.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstanceGroup

Returns a new instance of InstanceGroup.



21565
21566
21567
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21565

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

Instance Attribute Details

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


21477
21478
21479
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21477

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


21483
21484
21485
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21483

def description
  @description
end

#fingerprint ⇒ String

Output only. [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


21491
21492
21493
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21491

def fingerprint
  @fingerprint
end

#id ⇒ Fixnum

Output only. [Output Only] A unique identifier for this instance group, generated by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


21498
21499
21500
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21498

def id
  @id
end

#kind ⇒ String

Output only. [Output Only] The resource type, which is alwayscompute# instanceGroup for instance groups. Corresponds to the JSON property kind

Returns:

  • (String) 


21504
21505
21506
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21504

def kind
  @kind
end

#name ⇒ String

The name of the instance group. The name must be 1-63 characters long, and comply withRFC1035. Corresponds to the JSON property name

Returns:

  • (String) 


21510
21511
21512
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21510

def name
  @name
end

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

Optional. Assigns a name to a port number. For example:name: "http", port: 80 This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example:[name: " app1", port: 8080, name: "app1", port: 8081, name: "app2", port: 8082] Named ports apply to all instances in this instance group. Corresponds to the JSON property namedPorts

Returns:



21522
21523
21524
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21522

def named_ports
  @named_ports
end

#network ⇒ String

[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). Corresponds to the JSON property network

Returns:

  • (String) 


21530
21531
21532
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21530

def network
  @network
end

#region ⇒ String

Output only. [Output Only] The URL of theregion where the instance group is located (for regional resources). Corresponds to the JSON property region

Returns:

  • (String) 


21536
21537
21538
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21536

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


21543
21544
21545
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21543

def self_link
  @self_link
end

#size ⇒ Fixnum

Output only. [Output Only] The total number of instances in the instance group. Corresponds to the JSON property size

Returns:

  • (Fixnum) 


21548
21549
21550
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21548

def size
  @size
end

#subnetwork ⇒ String

Output only. [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). Corresponds to the JSON property subnetwork

Returns:

  • (String) 


21557
21558
21559
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21557

def subnetwork
  @subnetwork
end

#zone ⇒ String

Output only. [Output Only] The URL of thezone where the instance group is located (for zonal resources). Corresponds to the JSON property zone

Returns:

  • (String) 


21563
21564
21565
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21563

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21570
21571
21572
21573
21574
21575
21576
21577
21578
21579
21580
21581
21582
21583
21584
 
# File 'lib/google/apis/compute_v1/classes.rb', line 21570

def update!(**args)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @named_ports = args[:named_ports] if args.key?(:named_ports)
  @network = args[:network] if args.key?(:network)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @size = args[:size] if args.key?(:size)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @zone = args[:zone] if args.key?(:zone)
end