Class: Google::Apis::ComputeAlpha::InstanceGroup
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::InstanceGroup
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/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.
(== resource_for $api_version
.instanceGroups ==) (== resource_for $
api_version
.regionInstanceGroups ==)
Instance Attribute Summary collapse
-
#creation_timestamp ⇒ String
[Output Only] The creation timestamp for this instance group in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#fingerprint ⇒ String
[Output Only] The fingerprint of the named ports.
-
#id ⇒ Fixnum
[Output Only] A unique identifier for this instance group, generated by the server.
-
#kind ⇒ String
[Output Only] The resource type, which is always compute#instanceGroup for instance groups.
-
#name ⇒ String
The name of the instance group.
-
#named_ports ⇒ Array<Google::Apis::ComputeAlpha::NamedPort>
Assigns a name to a port number.
-
#network ⇒ String
[Output Only] The URL of the network to which all instances in the instance group belong.
-
#region ⇒ String
[Output Only] The URL of the region where the instance group is located (for regional resources).
-
#self_link ⇒ String
[Output Only] The URL for this instance group.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#size ⇒ Fixnum
[Output Only] The total number of instances in the instance group.
-
#subnetwork ⇒ String
[Output Only] The URL of the subnetwork to which all instances in the instance group belong.
-
#zone ⇒ String
[Output Only] The URL of the zone where the instance group is located (for zonal resources).
Instance Method Summary collapse
-
#initialize(**args) ⇒ InstanceGroup
constructor
A new instance of InstanceGroup.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ InstanceGroup
Returns a new instance of InstanceGroup.
13657 13658 13659 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13657 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
13571 13572 13573 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13571 def @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
13577 13578 13579 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13577 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.
13585 13586 13587 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13585 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
13591 13592 13593 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13591 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
13597 13598 13599 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13597 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
13603 13604 13605 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13603 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:
"http", port: 80
,name: "http", port: 8080
]
Named ports apply to all instances in this instance group.
Corresponds to the JSON property namedPorts
13612 13613 13614 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13612 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
13620 13621 13622 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13620 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
13626 13627 13628 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13626 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
13631 13632 13633 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13631 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
13636 13637 13638 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13636 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
13641 13642 13643 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13641 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
13649 13650 13651 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13649 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
13655 13656 13657 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13655 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 13662 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 |