Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::InstanceGroup.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#creation_timestamp
def creation_timestamp() -> ::String
Returns
- (::String) — [Output Only] The creation timestamp for this instance group in RFC3339 text format.
#creation_timestamp=
def creation_timestamp=(value) -> ::String
Parameter
- value (::String) — [Output Only] The creation timestamp for this instance group in RFC3339 text format.
Returns
- (::String) — [Output Only] The creation timestamp for this instance group in RFC3339 text format.
#description
def description() -> ::String
Returns
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#fingerprint
def fingerprint() -> ::String
Returns
- (::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.
#fingerprint=
def fingerprint=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#id
def id() -> ::Integer
Returns
- (::Integer) — [Output Only] A unique identifier for this instance group, generated by the server.
#id=
def id=(value) -> ::Integer
Parameter
- value (::Integer) — [Output Only] A unique identifier for this instance group, generated by the server.
Returns
- (::Integer) — [Output Only] A unique identifier for this instance group, generated by the server.
#kind
def kind() -> ::String
Returns
- (::String) — [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
#kind=
def kind=(value) -> ::String
Parameter
- value (::String) — [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
Returns
- (::String) — [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
#name
def name() -> ::String
Returns
- (::String) — The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
Returns
- (::String) — The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
#named_ports
def named_ports() -> ::Array<::Google::Cloud::Compute::V1::NamedPort>
Returns
- (::Array<::Google::Cloud::Compute::V1::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.
#named_ports=
def named_ports=(value) -> ::Array<::Google::Cloud::Compute::V1::NamedPort>
Parameter
- value (::Array<::Google::Cloud::Compute::V1::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.
Returns
- (::Array<::Google::Cloud::Compute::V1::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.
#network
def network() -> ::String
Returns
- (::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).
#network=
def network=(value) -> ::String
Parameter
- value (::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).
Returns
- (::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).
#region
def region() -> ::String
Returns
- (::String) — [Output Only] The URL of the region where the instance group is located (for regional resources).
#region=
def region=(value) -> ::String
Parameter
- value (::String) — [Output Only] The URL of the region where the instance group is located (for regional resources).
Returns
- (::String) — [Output Only] The URL of the region where the instance group is located (for regional resources).
#self_link
def self_link() -> ::String
Returns
- (::String) — [Output Only] The URL for this instance group. The server generates this URL.
#self_link=
def self_link=(value) -> ::String
Parameter
- value (::String) — [Output Only] The URL for this instance group. The server generates this URL.
Returns
- (::String) — [Output Only] The URL for this instance group. The server generates this URL.
#size
def size() -> ::Integer
Returns
- (::Integer) — [Output Only] The total number of instances in the instance group.
#size=
def size=(value) -> ::Integer
Parameter
- value (::Integer) — [Output Only] The total number of instances in the instance group.
Returns
- (::Integer) — [Output Only] The total number of instances in the instance group.
#subnetwork
def subnetwork() -> ::String
Returns
- (::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).
#subnetwork=
def subnetwork=(value) -> ::String
Parameter
- value (::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).
Returns
- (::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).
#zone
def zone() -> ::String
Returns
- (::String) — [Output Only] The URL of the zone where the instance group is located (for zonal resources).
#zone=
def zone=(value) -> ::String
Parameter
- value (::String) — [Output Only] The URL of the zone where the instance group is located (for zonal resources).
Returns
- (::String) — [Output Only] The URL of the zone where the instance group is located (for zonal resources).