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

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

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. (== resource_for $api_version.instanceGroups ==) (== resource_for $ api_version.regionInstanceGroups ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstanceGroup

Returns a new instance of InstanceGroup.



11233
11234
11235
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11233

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) 


11152
11153
11154
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11152

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) 


11158
11159
11160
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11158

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) 


11166
11167
11168
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11166

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) 


11172
11173
11174
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11172

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) 


11178
11179
11180
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11178

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) 


11184
11185
11186
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11184

def name
  @name
end

#named_ports ⇒ Array<Google::Apis::ComputeV1::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: "http", port: 80,name: "http", port: 8080] Named ports apply to all instances in this instance group. Corresponds to the JSON property namedPorts

Returns:



11193
11194
11195
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11193

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) 


11201
11202
11203
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11201

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) 


11207
11208
11209
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11207

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) 


11212
11213
11214
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11212

def self_link
  @self_link
end

#size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


11217
11218
11219
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11217

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) 


11225
11226
11227
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11225

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) 


11231
11232
11233
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11231

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
 
# File 'generated/google/apis/compute_v1/classes.rb', line 11238

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