Reference documentation and code samples for the Compute V1 Client class 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.
Generated from protobuf message google.cloud.compute.v1.InstanceGroup
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ creation_timestamp
string
[Output Only] The creation timestamp for this instance group in RFC3339 text format.
↳ description
string
An optional description of this resource. Provide this property when you create the resource.
↳ 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.
↳ id
int|string
[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. The name must be 1-63 characters long, and comply with RFC1035.
↳ named_ports
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
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
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. The server generates this URL.
↳ size
int
[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. 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
string
[Output Only] The URL of the zone where the instance group is located (for zonal resources).
getCreationTimestamp
[Output Only] The creation timestamp for this instance group in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] The creation timestamp for this instance group in RFC3339 text format.
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
var
string
$this
getFingerprint
[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
string
hasFingerprint
clearFingerprint
setFingerprint
[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
var
string
$this
getId
[Output Only] A unique identifier for this instance group, generated by the server.
int|string
hasId
clearId
setId
[Output Only] A unique identifier for this instance group, generated by the server.
var
int|string
$this
getKind
[Output Only] The resource type, which is always compute#instanceGroup for instance groups.
string
hasKind
clearKind
setKind
[Output Only] The resource type, which is always compute#instanceGroup for instance groups.
var
string
$this
getName
The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
string
hasName
clearName
setName
The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
var
string
$this
getNamedPorts
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.
setNamedPorts
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.
$this
getNetwork
[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).
string
hasNetwork
clearNetwork
setNetwork
[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).
var
string
$this
getRegion
[Output Only] The URL of the region where the instance group is located (for regional resources).
string
hasRegion
clearRegion
setRegion
[Output Only] The URL of the region where the instance group is located (for regional resources).
var
string
$this
getSelfLink
[Output Only] The URL for this instance group. The server generates this URL.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] The URL for this instance group. The server generates this URL.
var
string
$this
getSize
[Output Only] The total number of instances in the instance group.
int
hasSize
clearSize
setSize
[Output Only] The total number of instances in the instance group.
var
int
$this
getSubnetwork
[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).
string
hasSubnetwork
clearSubnetwork
setSubnetwork
[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).
var
string
$this
getZone
[Output Only] The URL of the zone where the instance group is located (for zonal resources).
string
hasZone
clearZone
setZone
[Output Only] The URL of the zone where the instance group is located (for zonal resources).
var
string
$this
