Compute V1 Client - Class InstanceGroup (1.5.0)

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.

Parameters
Name	Description
`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.

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] The creation timestamp for this instance group in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

An optional description of this resource. Provide this property when you create the resource.

Generated from protobuf field optional string description = 422937596;

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Generated from protobuf field optional string description = 422937596;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Generated from protobuf field optional string fingerprint = 234678500;

Returns
Type	Description
`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.

Generated from protobuf field optional string fingerprint = 234678500;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getId

[Output Only] A unique identifier for this instance group, generated by the server.

Generated from protobuf field optional uint64 id = 3355;

Returns
Type	Description
`int\|string`

hasId

clearId

setId

[Output Only] A unique identifier for this instance group, generated by the server.

Generated from protobuf field optional uint64 id = 3355;

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getKind

[Output Only] The resource type, which is always compute#instanceGroup for instance groups.

Generated from protobuf field optional string kind = 3292052;

Returns
Type	Description
`string`

hasKind

clearKind

setKind

[Output Only] The resource type, which is always compute#instanceGroup for instance groups.

Generated from protobuf field optional string kind = 3292052;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getName

The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

Generated from protobuf field optional string name = 3373707;

Returns
Type	Description
`string`

hasName

clearName

setName

The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

Generated from protobuf field optional string name = 3373707;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Generated from protobuf field repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setNamedPorts

Generated from protobuf field repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\NamedPort>`

Returns
Type	Description
`$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).

Generated from protobuf field optional string network = 232872494;

Returns
Type	Description
`string`

hasNetwork

clearNetwork

setNetwork

Generated from protobuf field optional string network = 232872494;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRegion

[Output Only] The URL of the region where the instance group is located (for regional resources).

Generated from protobuf field optional string region = 138946292;

Returns
Type	Description
`string`

hasRegion

clearRegion

setRegion

[Output Only] The URL of the region where the instance group is located (for regional resources).

Generated from protobuf field optional string region = 138946292;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSelfLink

[Output Only] The URL for this instance group. The server generates this URL.

Generated from protobuf field optional string self_link = 456214797;

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] The URL for this instance group. The server generates this URL.

Generated from protobuf field optional string self_link = 456214797;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSize

[Output Only] The total number of instances in the instance group.

Generated from protobuf field optional int32 size = 3530753;

Returns
Type	Description
`int`

hasSize

clearSize

setSize

[Output Only] The total number of instances in the instance group.

Generated from protobuf field optional int32 size = 3530753;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$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).

Generated from protobuf field optional string subnetwork = 307827694;

Returns
Type	Description
`string`

hasSubnetwork

clearSubnetwork

setSubnetwork

Generated from protobuf field optional string subnetwork = 307827694;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getZone

[Output Only] The URL of the zone where the instance group is located (for zonal resources).

Generated from protobuf field optional string zone = 3744684;

Returns
Type	Description
`string`

hasZone

clearZone

setZone

[Output Only] The URL of the zone where the instance group is located (for zonal resources).

Generated from protobuf field optional string zone = 3744684;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`