Class: Google::Apis::ComputeBeta::InstanceGroup
- Inherits:
-
Object
- Object
- Google::Apis::ComputeBeta::InstanceGroup
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/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::ComputeBeta::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.
-
#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.
13062 13063 13064 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13062 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
12981 12982 12983 |
# File 'lib/google/apis/compute_beta/classes.rb', line 12981 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
12987 12988 12989 |
# File 'lib/google/apis/compute_beta/classes.rb', line 12987 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.
12995 12996 12997 |
# File 'lib/google/apis/compute_beta/classes.rb', line 12995 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
13001 13002 13003 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13001 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
13007 13008 13009 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13007 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
13013 13014 13015 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13013 def name @name end |
#named_ports ⇒ Array<Google::Apis::ComputeBeta::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
13022 13023 13024 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13022 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
13030 13031 13032 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13030 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
13036 13037 13038 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13036 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
13041 13042 13043 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13041 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
13046 13047 13048 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13046 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
13054 13055 13056 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13054 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
13060 13061 13062 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13060 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 |
# File 'lib/google/apis/compute_beta/classes.rb', line 13067 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 |