The "instanceGroupManagers" collection of methods. More...

Inheritance diagram for Google_Service_Compute_InstanceGroupManagers_Resource:

Public Member Functions
	abandonInstances ($project, $zone, $instanceGroupManager, Google_Service_Compute_InstanceGroupManagersAbandonInstancesRequest $postBody, $optParams=array())
	Schedules a group action to remove the specified instances from the managed instance group.

	aggregatedList ($project, $optParams=array())
	Retrieves the list of managed instance groups and groups them by zone.

	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.

	delete ($project, $zone, $instanceGroupManager, $optParams=array())
	Deletes the specified managed instance group and all of the instances in that group.

	deleteInstances ($project, $zone, $instanceGroupManager, Google_Service_Compute_InstanceGroupManagersDeleteInstancesRequest $postBody, $optParams=array())
	Schedules a group action to delete the specified instances in the managed instance group.

	get ($project, $zone, $instanceGroupManager, $optParams=array())
	Returns all of the details about the specified managed instance group.

	insert ($project, $zone, Google_Service_Compute_InstanceGroupManager $postBody, $optParams=array())
	Creates a managed instance group using the information that you specify in the request.

	listInstanceGroupManagers ($project, $zone, $optParams=array())
	Retrieves a list of managed instance groups that are contained within the specified project and zone.

	listManagedInstances ($project, $zone, $instanceGroupManager, $optParams=array())
	Lists all of the instances in the managed instance group.

	recreateInstances ($project, $zone, $instanceGroupManager, Google_Service_Compute_InstanceGroupManagersRecreateInstancesRequest $postBody, $optParams=array())
	Schedules a group action to recreate the specified instances in the managed instance group.

	resize ($project, $zone, $instanceGroupManager, $size, $optParams=array())
	Resizes the managed instance group.

	setInstanceTemplate ($project, $zone, $instanceGroupManager, Google_Service_Compute_InstanceGroupManagersSetInstanceTemplateRequest $postBody, $optParams=array())
	Specifies the instance template to use when creating new instances in this group.

	setTargetPools ($project, $zone, $instanceGroupManager, Google_Service_Compute_InstanceGroupManagersSetTargetPoolsRequest $postBody, $optParams=array())
	Modifies the target pools to which all instances in this managed instance group are assigned.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "instanceGroupManagers" collection of methods.

Typical usage is: $computeService = new Google_Service_Compute(...); $instanceGroupManagers = $computeService->instanceGroupManagers;

Member Function Documentation

◆ abandonInstances()

Google_Service_Compute_InstanceGroupManagers_Resource::abandonInstances	(		$project,
			$zone,
			$instanceGroupManager,
		Google_Service_Compute_InstanceGroupManagersAbandonInstancesRequest	$postBody,
			$optParams = array() )

Schedules a group action to remove the specified instances 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. (instanceGroupManagers.abandonInstances)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where the managed instance group is located.
string	$instanceGroupManager	The name of the managed instance group.
Google_InstanceGroupManagersAbandonInstancesRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ aggregatedList()

Google_Service_Compute_InstanceGroupManagers_Resource::aggregatedList	(		$project,
			$optParams = array() )

Retrieves the list of managed instance groups and groups them by zone.

(instanceGroupManagers.aggregatedList)

Parameters

string	$project	The project ID for this request.
array	$optParams	Optional parameters.

@opt_param string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.

The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request. @opt_param string maxResults Maximum count of results to be returned.

Return values

Google_Service_Compute_InstanceGroupManagerAggregatedList

◆ call()

Google_Service_Resource::call	(	$name,
		$arguments,
		$expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

◆ delete()

Google_Service_Compute_InstanceGroupManagers_Resource::delete	(	$project,
		$zone,
		$instanceGroupManager,
		$optParams = array() )

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

(instanceGroupManagers.delete)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where the managed instance group is located.
string	$instanceGroupManager	The name of the managed instance group to delete.
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ deleteInstances()

Google_Service_Compute_InstanceGroupManagers_Resource::deleteInstances	(		$project,
			$zone,
			$instanceGroupManager,
		Google_Service_Compute_InstanceGroupManagersDeleteInstancesRequest	$postBody,
			$optParams = array() )

Schedules a group action to delete the specified instances in the managed instance group.

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. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. (instanceGroupManagers.deleteInstances)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where the managed instance group is located.
string	$instanceGroupManager	The name of the managed instance group.
Google_InstanceGroupManagersDeleteInstancesRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ get()

Google_Service_Compute_InstanceGroupManagers_Resource::get	(	$project,
		$zone,
		$instanceGroupManager,
		$optParams = array() )

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

(instanceGroupManagers.get)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where the managed instance group is located.
string	$instanceGroupManager	The name of the managed instance group.
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_InstanceGroupManager

◆ insert()

Google_Service_Compute_InstanceGroupManagers_Resource::insert	(		$project,
			$zone,
		Google_Service_Compute_InstanceGroupManager	$postBody,
			$optParams = array() )

Creates a managed instance group using the information that you specify in the request.

After the group is created, it schedules an action to create instances in the group 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. (instanceGroupManagers.insert)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where you want to create the managed instance group.
Google_InstanceGroupManager	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ listInstanceGroupManagers()

Google_Service_Compute_InstanceGroupManagers_Resource::listInstanceGroupManagers	(	$project,
		$zone,
		$optParams = array() )

Retrieves a list of managed instance groups that are contained within the specified project and zone.

(instanceGroupManagers.listInstanceGroupManagers)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where the managed instance group is located.
array	$optParams	Optional parameters.

@opt_param string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.

The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request. @opt_param string maxResults Maximum count of results to be returned.

Return values

Google_Service_Compute_InstanceGroupManagerList

◆ listManagedInstances()

Google_Service_Compute_InstanceGroupManagers_Resource::listManagedInstances	(	$project,
		$zone,
		$instanceGroupManager,
		$optParams = array() )

Lists all of the instances in the managed instance group.

Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. (instanceGroupManagers.listManagedInstances)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where the managed instance group is located.
string	$instanceGroupManager	The name of the managed instance group.
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_InstanceGroupManagersListManagedInstancesResponse

◆ recreateInstances()

Google_Service_Compute_InstanceGroupManagers_Resource::recreateInstances	(		$project,
			$zone,
			$instanceGroupManager,
		Google_Service_Compute_InstanceGroupManagersRecreateInstancesRequest	$postBody,
			$optParams = array() )

Schedules a group action to recreate the specified instances in the managed instance group.

The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. (instanceGroupManagers.recreateInstances)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where the managed instance group is located.
string	$instanceGroupManager	The name of the managed instance group.
Google_InstanceGroupManagersRecreateInstancesRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ resize()

Google_Service_Compute_InstanceGroupManagers_Resource::resize	(	$project,
		$zone,
		$instanceGroupManager,
		$size,
		$optParams = array() )

Resizes 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 instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. (instanceGroupManagers.resize)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where the managed instance group is located.
string	$instanceGroupManager	The name of the managed instance group.
int	$size	The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ setInstanceTemplate()

Google_Service_Compute_InstanceGroupManagers_Resource::setInstanceTemplate	(		$project,
			$zone,
			$instanceGroupManager,
		Google_Service_Compute_InstanceGroupManagersSetInstanceTemplateRequest	$postBody,
			$optParams = array() )

Specifies the instance template to use when creating new instances in this group.

The templates for existing instances in the group do not change unless you recreate them. (instanceGroupManagers.setInstanceTemplate)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where the managed instance group is located.
string	$instanceGroupManager	The name of the managed instance group.
Google_InstanceGroupManagersSetInstanceTemplateRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

◆ setTargetPools()

Google_Service_Compute_InstanceGroupManagers_Resource::setTargetPools	(		$project,
			$zone,
			$instanceGroupManager,
		Google_Service_Compute_InstanceGroupManagersSetTargetPoolsRequest	$postBody,
			$optParams = array() )

Modifies the target pools to which all instances in this managed instance group are assigned.

The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. (instanceGroupManagers.setTargetPools)

Parameters

string	$project	The project ID for this request.
string	$zone	The name of the zone where the managed instance group is located.
string	$instanceGroupManager	The name of the managed instance group.
Google_InstanceGroupManagersSetTargetPoolsRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Compute_Operation

The documentation for this class was generated from the following file:

lib/google/src/Google/Service/Compute.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ abandonInstances()

◆ aggregatedList()

◆ call()

◆ delete()

◆ deleteInstances()

◆ get()

◆ insert()

◆ listInstanceGroupManagers()

◆ listManagedInstances()

◆ recreateInstances()

◆ resize()

◆ setInstanceTemplate()

◆ setTargetPools()