class RegionInstanceGroupManagers extends Resource (View source)

The "regionInstanceGroupManagers" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $regionInstanceGroupManagers = $computeService->regionInstanceGroupManagers;

Methods

abandonInstances(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersAbandonInstancesRequest $postBody, array $optParams = [])

Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (regionInstanceGroupManagers.abandonInstances)

applyUpdatesToInstances(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersApplyUpdatesRequest $postBody, array $optParams = [])

Apply updates to selected instances the managed instance group.

createInstances(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersCreateInstancesRequest $postBody, array $optParams = [])

Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template.

delete(string $project, string $region, string $instanceGroupManager, array $optParams = [])

Deletes the specified managed instance group and all of the instances in that group. (regionInstanceGroupManagers.delete)

deleteInstances(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersDeleteInstancesRequest $postBody, array $optParams = [])

Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

deletePerInstanceConfigs(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagerDeleteInstanceConfigReq $postBody, array $optParams = [])

Deletes selected per-instance configurations for the managed instance group.

get(string $project, string $region, string $instanceGroupManager, array $optParams = [])

Returns all of the details about the specified managed instance group.

insert(string $project, string $region, InstanceGroupManager $postBody, array $optParams = [])

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. (regionInstanceGroupManagers.insert)

listRegionInstanceGroupManagers(string $project, string $region, array $optParams = [])

Retrieves the list of managed instance groups that are contained within the specified region.

listErrors(string $project, string $region, string $instanceGroupManager, array $optParams = [])

Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.

listManagedInstances(string $project, string $region, string $instanceGroupManager, array $optParams = [])

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The pageToken query parameter is supported only if the group's listManagedInstancesResults field is set to PAGINATED.

listPerInstanceConfigs(string $project, string $region, string $instanceGroupManager, array $optParams = [])

Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.

patch(string $project, string $region, string $instanceGroupManager, InstanceGroupManager $postBody, array $optParams = [])

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.

patchPerInstanceConfigs(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagerPatchInstanceConfigReq $postBody, array $optParams = [])

Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

recreateInstances(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersRecreateRequest $postBody, array $optParams = [])

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

resize(string $project, string $region, string $instanceGroupManager, int $size, array $optParams = [])

Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

setInstanceTemplate(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersSetTemplateRequest $postBody, array $optParams = [])

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

setTargetPools(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersSetTargetPoolsRequest $postBody, array $optParams = [])

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

updatePerInstanceConfigs(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagerUpdateInstanceConfigReq $postBody, array $optParams = [])

Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Details

Operation abandonInstances(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersAbandonInstancesRequest $postBody, array $optParams = [])

Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (regionInstanceGroupManagers.abandonInstances)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

string $instanceGroupManager

Name of the managed instance group.

RegionInstanceGroupManagersAbandonInstancesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation applyUpdatesToInstances(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersApplyUpdatesRequest $postBody, array $optParams = [])

Apply updates to selected instances the managed instance group.

(regionInstanceGroupManagers.applyUpdatesToInstances)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request, should conform to RFC1035.

string $instanceGroupManager

The name of the managed instance group, should conform to RFC1035.

RegionInstanceGroupManagersApplyUpdatesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation createInstances(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersCreateInstancesRequest $postBody, array $optParams = [])

Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template.

The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. (regionInstanceGroupManagers.createInstances)

Parameters

string $project

Project ID for this request.

string $region

The name of the region where the managed instance group is located. It should conform to RFC1035.

string $instanceGroupManager

The name of the managed instance group. It should conform to RFC1035.

RegionInstanceGroupManagersCreateInstancesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation delete(string $project, string $region, string $instanceGroupManager, array $optParams = [])

Deletes the specified managed instance group and all of the instances in that group. (regionInstanceGroupManagers.delete)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

string $instanceGroupManager

Name of the managed instance group to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation deleteInstances(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersDeleteInstancesRequest $postBody, array $optParams = [])

Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

(regionInstanceGroupManagers.deleteInstances)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

string $instanceGroupManager

Name of the managed instance group.

RegionInstanceGroupManagersDeleteInstancesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation deletePerInstanceConfigs(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagerDeleteInstanceConfigReq $postBody, array $optParams = [])

Deletes selected per-instance configurations for the managed instance group.

(regionInstanceGroupManagers.deletePerInstanceConfigs)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request, should conform to RFC1035.

string $instanceGroupManager

The name of the managed instance group. It should conform to RFC1035.

RegionInstanceGroupManagerDeleteInstanceConfigReq $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

InstanceGroupManager get(string $project, string $region, string $instanceGroupManager, array $optParams = [])

Returns all of the details about the specified managed instance group.

(regionInstanceGroupManagers.get)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

string $instanceGroupManager

Name of the managed instance group to return.

array $optParams

Optional parameters.

Return Value

InstanceGroupManager

Exceptions

Exception

Operation insert(string $project, string $region, InstanceGroupManager $postBody, array $optParams = [])

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. (regionInstanceGroupManagers.insert)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

InstanceGroupManager $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

RegionInstanceGroupManagerList listRegionInstanceGroupManagers(string $project, string $region, array $optParams = [])

Retrieves the list of managed instance groups that are contained within the specified region.

(regionInstanceGroupManagers.listRegionInstanceGroupManagers)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

array $optParams

Optional parameters.

Return Value

RegionInstanceGroupManagerList

Exceptions

Exception

RegionInstanceGroupManagersListErrorsResponse listErrors(string $project, string $region, string $instanceGroupManager, array $optParams = [])

Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.

(regionInstanceGroupManagers.listErrors)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request. This should conform to RFC1035.

string $instanceGroupManager

The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:a-z?)|1-9{0,19}.

array $optParams

Optional parameters.

Return Value

RegionInstanceGroupManagersListErrorsResponse

Exceptions

Exception

RegionInstanceGroupManagersListInstancesResponse listManagedInstances(string $project, string $region, string $instanceGroupManager, array $optParams = [])

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The pageToken query parameter is supported only if the group's listManagedInstancesResults field is set to PAGINATED.

(regionInstanceGroupManagers.listManagedInstances)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

string $instanceGroupManager

The name of the managed instance group.

array $optParams

Optional parameters.

Return Value

RegionInstanceGroupManagersListInstancesResponse

Exceptions

Exception

RegionInstanceGroupManagersListInstanceConfigsResp listPerInstanceConfigs(string $project, string $region, string $instanceGroupManager, array $optParams = [])

Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.

(regionInstanceGroupManagers.listPerInstanceConfigs)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request, should conform to RFC1035.

string $instanceGroupManager

The name of the managed instance group. It should conform to RFC1035.

array $optParams

Optional parameters.

Return Value

RegionInstanceGroupManagersListInstanceConfigsResp

Exceptions

Exception

Operation patch(string $project, string $region, string $instanceGroupManager, InstanceGroupManager $postBody, array $optParams = [])

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.

(regionInstanceGroupManagers.patch)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

string $instanceGroupManager

The name of the instance group manager.

InstanceGroupManager $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation patchPerInstanceConfigs(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagerPatchInstanceConfigReq $postBody, array $optParams = [])

Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

(regionInstanceGroupManagers.patchPerInstanceConfigs)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request, should conform to RFC1035.

string $instanceGroupManager

The name of the managed instance group. It should conform to RFC1035.

RegionInstanceGroupManagerPatchInstanceConfigReq $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation recreateInstances(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersRecreateRequest $postBody, array $optParams = [])

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

(regionInstanceGroupManagers.recreateInstances)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

string $instanceGroupManager

Name of the managed instance group.

RegionInstanceGroupManagersRecreateRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation resize(string $project, string $region, string $instanceGroupManager, int $size, array $optParams = [])

Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.

(regionInstanceGroupManagers.resize)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

string $instanceGroupManager

Name of the managed instance group.

int $size

Number of instances that should exist in this instance group manager.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation setInstanceTemplate(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersSetTemplateRequest $postBody, array $optParams = [])

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

(regionInstanceGroupManagers.setInstanceTemplate)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

string $instanceGroupManager

The name of the managed instance group.

RegionInstanceGroupManagersSetTemplateRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation setTargetPools(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagersSetTargetPoolsRequest $postBody, array $optParams = [])

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

(regionInstanceGroupManagers.setTargetPools)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request.

string $instanceGroupManager

Name of the managed instance group.

RegionInstanceGroupManagersSetTargetPoolsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation updatePerInstanceConfigs(string $project, string $region, string $instanceGroupManager, RegionInstanceGroupManagerUpdateInstanceConfigReq $postBody, array $optParams = [])

Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

(regionInstanceGroupManagers.updatePerInstanceConfigs)

Parameters

string $project

Project ID for this request.

string $region

Name of the region scoping this request, should conform to RFC1035.

string $instanceGroupManager

The name of the managed instance group. It should conform to RFC1035.

RegionInstanceGroupManagerUpdateInstanceConfigReq $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception