Reference documentation and code samples for the Compute V1 Client class InstanceGroupManager.
Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.
Generated from protobuf message google.cloud.compute.v1.InstanceGroupManager
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ all_instances_config | InstanceGroupManagerAllInstancesConfigSpecifies configuration that overrides the instance template configuration for the group. |
↳ auto_healing_policies | array<InstanceGroupManagerAutoHealingPolicy>The autohealing policy for this managed instance group. You can specify only one value. |
↳ base_instance_name | stringThe base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern a-z |
↳ creation_timestamp | string[Output Only] The creation timestamp for this managed instance group in RFC3339 text format. |
↳ current_actions | InstanceGroupManagerActionsSummary[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. |
↳ description | stringAn optional description of this resource. |
↳ distribution_policy | DistributionPolicyPolicy specifying the intended distribution of managed instances across zones in a regional managed instance group. |
↳ fingerprint | stringFingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. |
↳ id | int|string[Output Only] A unique identifier for this resource type. The server generates this identifier. |
↳ instance_flexibility_policy | InstanceGroupManagerInstanceFlexibilityPolicyInstance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. |
↳ instance_group | string[Output Only] The URL of the Instance Group resource. |
↳ instance_lifecycle_policy | InstanceGroupManagerInstanceLifecyclePolicyThe repair policy for this managed instance group. |
↳ instance_template | stringThe URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. |
↳ kind | string[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. |
↳ list_managed_instances_results | stringPagination behavior of the listManagedInstances API method for this managed instance group. Check the ListManagedInstancesResults enum for the list of possible values. |
↳ name | stringThe name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. |
↳ named_ports | array<NamedPort>[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. |
↳ region | string[Output Only] The URL of the region where the managed instance group resides (for regional resources). |
↳ resource_policies | InstanceGroupManagerResourcePoliciesResource policies for this managed instance group. |
↳ satisfies_pzi | bool[Output Only] Reserved for future use. |
↳ satisfies_pzs | bool[Output Only] Reserved for future use. |
↳ self_link | string[Output Only] The URL for this managed instance group. The server defines this URL. |
↳ standby_policy | InstanceGroupManagerStandbyPolicyStandby policy for stopped and suspended instances. |
↳ stateful_policy | StatefulPolicyStateful configuration for this Instanced Group Manager |
↳ status | InstanceGroupManagerStatus[Output Only] The status of this managed instance group. |
↳ target_pools | arrayThe URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. |
↳ target_size | intThe target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. |
↳ target_stopped_size | intThe target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. |
↳ target_suspended_size | intThe target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. |
↳ update_policy | InstanceGroupManagerUpdatePolicyThe update policy for this managed instance group. |
↳ versions | array<InstanceGroupManagerVersion>Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. |
↳ zone | string[Output Only] The URL of a zone where the managed instance group is located (for zonal resources). |
getAllInstancesConfig
Specifies configuration that overrides the instance template configuration for the group.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerAllInstancesConfig|null | |
hasAllInstancesConfig
clearAllInstancesConfig
setAllInstancesConfig
Specifies configuration that overrides the instance template configuration for the group.
| Parameter | |
|---|---|
| Name | Description |
var | InstanceGroupManagerAllInstancesConfig |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAutoHealingPolicies
The autohealing policy for this managed instance group. You can specify only one value.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAutoHealingPolicies
The autohealing policy for this managed instance group. You can specify only one value.
| Parameter | |
|---|---|
| Name | Description |
var | array<InstanceGroupManagerAutoHealingPolicy> |
| Returns | |
|---|---|
| Type | Description |
$this | |
getBaseInstanceName
The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern a-z
| Returns | |
|---|---|
| Type | Description |
string | |
hasBaseInstanceName
clearBaseInstanceName
setBaseInstanceName
The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern a-z
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreationTimestamp
[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCurrentActions
[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerActionsSummary|null | |
hasCurrentActions
clearCurrentActions
setCurrentActions
[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
| Parameter | |
|---|---|
| Name | Description |
var | InstanceGroupManagerActionsSummary |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
An optional description of this resource.
| Returns | |
|---|---|
| Type | Description |
string | |
hasDescription
clearDescription
setDescription
An optional description of this resource.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDistributionPolicy
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
| Returns | |
|---|---|
| Type | Description |
DistributionPolicy|null | |
hasDistributionPolicy
clearDistributionPolicy
setDistributionPolicy
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
| Parameter | |
|---|---|
| Name | Description |
var | DistributionPolicy |
| Returns | |
|---|---|
| Type | Description |
$this | |
getFingerprint
Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
| Returns | |
|---|---|
| Type | Description |
string | |
hasFingerprint
clearFingerprint
setFingerprint
Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
[Output Only] A unique identifier for this resource type. The server generates this identifier.
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasId
clearId
setId
[Output Only] A unique identifier for this resource type. The server generates this identifier.
| Parameter | |
|---|---|
| Name | Description |
var | int|string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstanceFlexibilityPolicy
Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerInstanceFlexibilityPolicy|null | |
hasInstanceFlexibilityPolicy
clearInstanceFlexibilityPolicy
setInstanceFlexibilityPolicy
Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.
| Parameter | |
|---|---|
| Name | Description |
var | InstanceGroupManagerInstanceFlexibilityPolicy |
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstanceGroup
[Output Only] The URL of the Instance Group resource.
| Returns | |
|---|---|
| Type | Description |
string | |
hasInstanceGroup
clearInstanceGroup
setInstanceGroup
[Output Only] The URL of the Instance Group resource.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstanceLifecyclePolicy
The repair policy for this managed instance group.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerInstanceLifecyclePolicy|null | |
hasInstanceLifecyclePolicy
clearInstanceLifecyclePolicy
setInstanceLifecyclePolicy
The repair policy for this managed instance group.
| Parameter | |
|---|---|
| Name | Description |
var | InstanceGroupManagerInstanceLifecyclePolicy |
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstanceTemplate
The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.
| Returns | |
|---|---|
| Type | Description |
string | |
hasInstanceTemplate
clearInstanceTemplate
setInstanceTemplate
The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getListManagedInstancesResults
Pagination behavior of the listManagedInstances API method for this managed instance group.
Check the ListManagedInstancesResults enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasListManagedInstancesResults
clearListManagedInstancesResults
setListManagedInstancesResults
Pagination behavior of the listManagedInstances API method for this managed instance group.
Check the ListManagedInstancesResults enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
| Returns | |
|---|---|
| Type | Description |
string | |
hasName
clearName
setName
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getNamedPorts
[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setNamedPorts
[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.
| Parameter | |
|---|---|
| Name | Description |
var | array<NamedPort> |
| Returns | |
|---|---|
| Type | Description |
$this | |
getRegion
[Output Only] The URL of the region where the managed instance group resides (for regional resources).
| Returns | |
|---|---|
| Type | Description |
string | |
hasRegion
clearRegion
setRegion
[Output Only] The URL of the region where the managed instance group resides (for regional resources).
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourcePolicies
Resource policies for this managed instance group.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerResourcePolicies|null | |
hasResourcePolicies
clearResourcePolicies
setResourcePolicies
Resource policies for this managed instance group.
| Parameter | |
|---|---|
| Name | Description |
var | InstanceGroupManagerResourcePolicies |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSatisfiesPzi
[Output Only] Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasSatisfiesPzi
clearSatisfiesPzi
setSatisfiesPzi
[Output Only] Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var | bool |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSatisfiesPzs
[Output Only] Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
[Output Only] Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var | bool |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelfLink
[Output Only] The URL for this managed instance group. The server defines this URL.
| Returns | |
|---|---|
| Type | Description |
string | |
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] The URL for this managed instance group. The server defines this URL.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getStandbyPolicy
Standby policy for stopped and suspended instances.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerStandbyPolicy|null | |
hasStandbyPolicy
clearStandbyPolicy
setStandbyPolicy
Standby policy for stopped and suspended instances.
| Parameter | |
|---|---|
| Name | Description |
var | InstanceGroupManagerStandbyPolicy |
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatefulPolicy
Stateful configuration for this Instanced Group Manager
| Returns | |
|---|---|
| Type | Description |
StatefulPolicy|null | |
hasStatefulPolicy
clearStatefulPolicy
setStatefulPolicy
Stateful configuration for this Instanced Group Manager
| Parameter | |
|---|---|
| Name | Description |
var | StatefulPolicy |
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
[Output Only] The status of this managed instance group.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerStatus|null | |
hasStatus
clearStatus
setStatus
[Output Only] The status of this managed instance group.
| Parameter | |
|---|---|
| Name | Description |
var | InstanceGroupManagerStatus |
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetPools
The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setTargetPools
The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
| Parameter | |
|---|---|
| Name | Description |
var | string[] |
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetSize
The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
| Returns | |
|---|---|
| Type | Description |
int | |
hasTargetSize
clearTargetSize
setTargetSize
The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetStoppedSize
The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method.
| Returns | |
|---|---|
| Type | Description |
int | |
hasTargetStoppedSize
clearTargetStoppedSize
setTargetStoppedSize
The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetSuspendedSize
The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method.
| Returns | |
|---|---|
| Type | Description |
int | |
hasTargetSuspendedSize
clearTargetSuspendedSize
setTargetSuspendedSize
The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdatePolicy
The update policy for this managed instance group.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy|null | |
hasUpdatePolicy
clearUpdatePolicy
setUpdatePolicy
The update policy for this managed instance group.
| Parameter | |
|---|---|
| Name | Description |
var | InstanceGroupManagerUpdatePolicy |
| Returns | |
|---|---|
| Type | Description |
$this | |
getVersions
Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setVersions
Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
| Parameter | |
|---|---|
| Name | Description |
var | array<InstanceGroupManagerVersion> |
| Returns | |
|---|---|
| Type | Description |
$this | |
getZone
[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
| Returns | |
|---|---|
| Type | Description |
string | |
hasZone
clearZone
setZone
[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |