Compute V1 Client - Class RegionInstanceGroupManagersClient (1.21.0)

Reference documentation and code samples for the Compute V1 Client class RegionInstanceGroupManagersClient.

Service Description: The RegionInstanceGroupManagers API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Constructor.

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.

The async variant is RegionInstanceGroupManagersClient::abandonInstancesAsync() .

Apply updates to selected instances the managed instance group.

The async variant is RegionInstanceGroupManagersClient::applyUpdatesToInstancesAsync() .

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.

The async variant is RegionInstanceGroupManagersClient::createInstancesAsync() .

Deletes the specified managed instance group and all of the instances in that group.

The async variant is RegionInstanceGroupManagersClient::deleteAsync() .

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.

The async variant is RegionInstanceGroupManagersClient::deleteInstancesAsync() .

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

The async variant is RegionInstanceGroupManagersClient::deletePerInstanceConfigsAsync() .

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

The async variant is RegionInstanceGroupManagersClient::getAsync() .

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.

The async variant is RegionInstanceGroupManagersClient::insertAsync() .

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

The async variant is RegionInstanceGroupManagersClient::listAsync() .

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

The async variant is RegionInstanceGroupManagersClient::listErrorsAsync() .

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.

The async variant is RegionInstanceGroupManagersClient::listManagedInstancesAsync() .

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

The async variant is RegionInstanceGroupManagersClient::listPerInstanceConfigsAsync() .

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.

The async variant is RegionInstanceGroupManagersClient::patchAsync() .

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.

The async variant is RegionInstanceGroupManagersClient::patchPerInstanceConfigsAsync() .

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.

The async variant is RegionInstanceGroupManagersClient::recreateInstancesAsync() .

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.

The async variant is RegionInstanceGroupManagersClient::resizeAsync() .

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

The async variant is RegionInstanceGroupManagersClient::setInstanceTemplateAsync() .

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

The async variant is RegionInstanceGroupManagersClient::setTargetPoolsAsync() .

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.

The async variant is RegionInstanceGroupManagersClient::updatePerInstanceConfigsAsync() .

Return an RegionOperationsClient object with the same endpoint as $this.

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.