Class: Google::Apis::ComputeV1::InstanceGroup
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::InstanceGroup
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/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.
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::ComputeV1::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.
14470 14471 14472 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14470 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
14389 14390 14391 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14389 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
14395 14396 14397 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14395 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.
14403 14404 14405 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14403 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
14409 14410 14411 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14409 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
14415 14416 14417 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14415 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
14421 14422 14423 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14421 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: "
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
14430 14431 14432 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14430 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
14438 14439 14440 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14438 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
14444 14445 14446 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14444 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
14449 14450 14451 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14449 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
14454 14455 14456 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14454 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
14462 14463 14464 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14462 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
14468 14469 14470 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14468 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 |
# File 'lib/google/apis/compute_v1/classes.rb', line 14475 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 |