Class: Google::Apis::ComputeAlpha::InstanceGroup

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

Overview

Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load 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, read Instance groups.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstanceGroup

Returns a new instance of InstanceGroup.



14805
14806
14807
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14805

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

Instance Attribute Details

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


14719
14720
14721
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14719

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) 


14725
14726
14727
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14725

def description
  @description
end

#fingerprint ⇒ String

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


14733
14734
14735
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14733

def fingerprint
  @fingerprint
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


14739
14740
14741
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14739

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


14745
14746
14747
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14745

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


14751
14752
14753
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14751

def name
  @name
end

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

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:



14760
14761
14762
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14760

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) 


14768
14769
14770
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14768

def network
  @network
end

#region ⇒ String

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

Returns:

  • (String) 


14774
14775
14776
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14774

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


14779
14780
14781
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14779

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


14784
14785
14786
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14784

def self_link_with_id
  @self_link_with_id
end

#size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


14789
14790
14791
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14789

def size
  @size
end

#subnetwork ⇒ String

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


14797
14798
14799
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14797

def subnetwork
  @subnetwork
end

#zone ⇒ String

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

Returns:

  • (String) 


14803
14804
14805
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14803

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14810

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)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @size = args[:size] if args.key?(:size)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @zone = args[:zone] if args.key?(:zone)
end