Class: Google::Apis::ComputeAlpha::InstanceGroup
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::InstanceGroup
- 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
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.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ InstanceGroup
Returns a new instance of InstanceGroup.
11805 11806 11807 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11805 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
11724 11725 11726 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11724 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
11730 11731 11732 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11730 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.
11738 11739 11740 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11738 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
11744 11745 11746 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11744 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
11750 11751 11752 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11750 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
11756 11757 11758 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11756 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
11765 11766 11767 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11765 def named_ports @named_ports end |
#network ⇒ String
The URL of the network to which all instances in the instance group belong.
Corresponds to the JSON property network
11770 11771 11772 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11770 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
11776 11777 11778 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11776 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
11781 11782 11783 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11781 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
11786 11787 11788 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11786 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
11791 11792 11793 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11791 def size @size end |
#subnetwork ⇒ String
[Output Only] The URL of the subnetwork to which all instances in the instance
group belong.
Corresponds to the JSON property subnetwork
11797 11798 11799 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11797 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
11803 11804 11805 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11803 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 11810 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 |