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.
data
array
Optional. Data for populating the Message object.
↳ all_instances_config
InstanceGroupManagerAllInstancesConfig
Specifies 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
string
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
↳ 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
string
An optional description of this resource.
↳ distribution_policy
DistributionPolicy
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
↳ fingerprint
string
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.
↳ id
int|string
[Output Only] A unique identifier for this resource type. The server generates this identifier.
↳ instance_flexibility_policy
InstanceGroupManagerInstanceFlexibilityPolicy
Instance 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
↳ instance_template
string
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.
↳ kind
string
[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
↳ list_managed_instances_results
string
Pagination behavior of the listManagedInstances API method for this managed instance group. Check the ListManagedInstancesResults enum for the list of possible values.
↳ name
string
The 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).
↳ 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
↳ stateful_policy
↳ status
↳ target_pools
array
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.
↳ target_size
int
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.
↳ target_stopped_size
int
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.
↳ target_suspended_size
int
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.
↳ update_policy
↳ 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.
hasAllInstancesConfig
clearAllInstancesConfig
setAllInstancesConfig
Specifies configuration that overrides the instance template configuration for the group.
$this
getAutoHealingPolicies
The autohealing policy for this managed instance group. You can specify only one value.
setAutoHealingPolicies
The autohealing policy for this managed instance group. You can specify only one value.
$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
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
var
string
$this
getCreationTimestamp
[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
var
string
$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.
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.
$this
getDescription
An optional description of this resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource.
var
string
$this
getDistributionPolicy
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
hasDistributionPolicy
clearDistributionPolicy
setDistributionPolicy
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
$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.
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.
var
string
$this
getId
[Output Only] A unique identifier for this resource type. The server generates this identifier.
int|string
hasId
clearId
setId
[Output Only] A unique identifier for this resource type. The server generates this identifier.
var
int|string
$this
getInstanceFlexibilityPolicy
Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.
hasInstanceFlexibilityPolicy
clearInstanceFlexibilityPolicy
setInstanceFlexibilityPolicy
Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.
$this
getInstanceGroup
[Output Only] The URL of the Instance Group resource.
string
hasInstanceGroup
clearInstanceGroup
setInstanceGroup
[Output Only] The URL of the Instance Group resource.
var
string
$this
getInstanceLifecyclePolicy
The repair policy for this managed instance group.
hasInstanceLifecyclePolicy
clearInstanceLifecyclePolicy
setInstanceLifecyclePolicy
The repair policy for this managed instance group.
$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.
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.
var
string
$this
getKind
[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
string
hasKind
clearKind
setKind
[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
var
string
$this
getListManagedInstancesResults
Pagination behavior of the listManagedInstances API method for this managed instance group.
Check the ListManagedInstancesResults enum for the list of possible values.
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.
var
string
$this
getName
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
string
hasName
clearName
setName
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
var
string
$this
getNamedPorts
[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.
setNamedPorts
[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.
$this
getRegion
[Output Only] The URL of the region where the managed instance group resides (for regional resources).
string
hasRegion
clearRegion
setRegion
[Output Only] The URL of the region where the managed instance group resides (for regional resources).
var
string
$this
getSatisfiesPzi
[Output Only] Reserved for future use.
bool
hasSatisfiesPzi
clearSatisfiesPzi
setSatisfiesPzi
[Output Only] Reserved for future use.
var
bool
$this
getSatisfiesPzs
[Output Only] Reserved for future use.
bool
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
[Output Only] Reserved for future use.
var
bool
$this
getSelfLink
[Output Only] The URL for this managed instance group. The server defines this URL.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] The URL for this managed instance group. The server defines this URL.
var
string
$this
getStandbyPolicy
Standby policy for stopped and suspended instances.
hasStandbyPolicy
clearStandbyPolicy
setStandbyPolicy
Standby policy for stopped and suspended instances.
$this
getStatefulPolicy
Stateful configuration for this Instanced Group Manager
hasStatefulPolicy
clearStatefulPolicy
setStatefulPolicy
Stateful configuration for this Instanced Group Manager
$this
getStatus
[Output Only] The status of this managed instance group.
hasStatus
clearStatus
setStatus
[Output Only] The status of this managed instance group.
$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.
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.
var
string[]
$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.
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.
var
int
$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.
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.
var
int
$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.
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.
var
int
$this
getUpdatePolicy
The update policy for this managed instance group.
hasUpdatePolicy
clearUpdatePolicy
setUpdatePolicy
The update policy for this managed instance group.
$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.
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.
$this
getZone
[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
string
hasZone
clearZone
setZone
[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
var
string
$this
