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.



18132
18133
18134
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18132

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) 


18046
18047
18048
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18046

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) 


18052
18053
18054
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18052

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) 


18060
18061
18062
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18060

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) 


18066
18067
18068
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18066

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) 


18072
18073
18074
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18072

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) 


18078
18079
18080
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18078

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:



18087
18088
18089
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18087

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) 


18095
18096
18097
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18095

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) 


18101
18102
18103
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18101

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) 


18106
18107
18108
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18106

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) 


18111
18112
18113
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18111

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) 


18116
18117
18118
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18116

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) 


18124
18125
18126
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18124

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) 


18130
18131
18132
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18130

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18137
18138
18139
18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 18137

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