Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Replicapool_InstanceGroupManagers_Resource Class Reference

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

Inheritance diagram for Google_Service_Replicapool_InstanceGroupManagers_Resource:
Google_Service_Resource

Public Member Functions

 abandonInstances ($project, $zone, $instanceGroupManager, Google_Service_Replicapool_InstanceGroupManagersAbandonInstancesRequest $postBody, $optParams=array())
 Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.
 
 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($project, $zone, $instanceGroupManager, $optParams=array())
 Deletes the instance group manager and all instances contained within.
 
 deleteInstances ($project, $zone, $instanceGroupManager, Google_Service_Replicapool_InstanceGroupManagersDeleteInstancesRequest $postBody, $optParams=array())
 Deletes the specified instances.
 
 get ($project, $zone, $instanceGroupManager, $optParams=array())
 Returns the specified Instance Group Manager resource.
 
 insert ($project, $zone, $size, Google_Service_Replicapool_InstanceGroupManager $postBody, $optParams=array())
 Creates an instance group manager, as well as the instance group and the specified number of instances.
 
 listInstanceGroupManagers ($project, $zone, $optParams=array())
 Retrieves the list of Instance Group Manager resources contained within the specified zone.
 
 recreateInstances ($project, $zone, $instanceGroupManager, Google_Service_Replicapool_InstanceGroupManagersRecreateInstancesRequest $postBody, $optParams=array())
 Recreates the specified instances.
 
 resize ($project, $zone, $instanceGroupManager, $size, $optParams=array())
 Resizes the managed instance group up or down.
 
 setInstanceTemplate ($project, $zone, $instanceGroupManager, Google_Service_Replicapool_InstanceGroupManagersSetInstanceTemplateRequest $postBody, $optParams=array())
 Sets the instance template to use when creating new instances in this group.
 
 setTargetPools ($project, $zone, $instanceGroupManager, Google_Service_Replicapool_InstanceGroupManagersSetTargetPoolsRequest $postBody, $optParams=array())
 Modifies the target pools to which all new instances in this group are assigned.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "instanceGroupManagers" collection of methods.

Typical usage is: $replicapoolService = new Google_Service_Replicapool(...); $instanceGroupManagers = $replicapoolService->instanceGroupManagers;

Member Function Documentation

◆ abandonInstances()

Google_Service_Replicapool_InstanceGroupManagers_Resource::abandonInstances ( $project,
$zone,
$instanceGroupManager,
Google_Service_Replicapool_InstanceGroupManagersAbandonInstancesRequest $postBody,
$optParams = array() )

Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.

(instanceGroupManagers.abandonInstances)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the instance group manager resides.
string$instanceGroupManagerThe name of the instance group manager.
Google_InstanceGroupManagersAbandonInstancesRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Replicapool_Operation

◆ 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_Replicapool_InstanceGroupManagers_Resource::delete ( $project,
$zone,
$instanceGroupManager,
$optParams = array() )

Deletes the instance group manager and all instances contained within.

If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group. (instanceGroupManagers.delete)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the instance group manager resides.
string$instanceGroupManagerName of the Instance Group Manager resource to delete.
array$optParamsOptional parameters.
Return values
Google_Service_Replicapool_Operation

◆ deleteInstances()

Google_Service_Replicapool_InstanceGroupManagers_Resource::deleteInstances ( $project,
$zone,
$instanceGroupManager,
Google_Service_Replicapool_InstanceGroupManagersDeleteInstancesRequest $postBody,
$optParams = array() )

Deletes the specified instances.

The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted. (instanceGroupManagers.deleteInstances)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the instance group manager resides.
string$instanceGroupManagerThe name of the instance group manager.
Google_InstanceGroupManagersDeleteInstancesRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Replicapool_Operation

◆ get()

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

Returns the specified Instance Group Manager resource.

(instanceGroupManagers.get)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the instance group manager resides.
string$instanceGroupManagerName of the instance resource to return.
array$optParamsOptional parameters.
Return values
Google_Service_Replicapool_InstanceGroupManager

◆ insert()

Google_Service_Replicapool_InstanceGroupManagers_Resource::insert ( $project,
$zone,
$size,
Google_Service_Replicapool_InstanceGroupManager $postBody,
$optParams = array() )

Creates an instance group manager, as well as the instance group and the specified number of instances.

(instanceGroupManagers.insert)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the instance group manager resides.
int$sizeNumber of instances that should exist.
Google_InstanceGroupManager$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Replicapool_Operation

◆ listInstanceGroupManagers()

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

Retrieves the list of Instance Group Manager resources contained within the specified zone.

(instanceGroupManagers.listInstanceGroupManagers)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the instance group manager resides.
array$optParamsOptional parameters.

@opt_param string filter Optional. Filter expression for filtering listed resources. @opt_param string pageToken Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request. @opt_param string maxResults Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.

Return values
Google_Service_Replicapool_InstanceGroupManagerList

◆ recreateInstances()

Google_Service_Replicapool_InstanceGroupManagers_Resource::recreateInstances ( $project,
$zone,
$instanceGroupManager,
Google_Service_Replicapool_InstanceGroupManagersRecreateInstancesRequest $postBody,
$optParams = array() )

Recreates the specified instances.

The instances are deleted, then recreated using the instance group manager's current instance template. (instanceGroupManagers.recreateInstances)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the instance group manager resides.
string$instanceGroupManagerThe name of the instance group manager.
Google_InstanceGroupManagersRecreateInstancesRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Replicapool_Operation

◆ resize()

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

Resizes the managed instance group up or down.

If resized up, new instances are created using the current instance template. If resized down, instances are removed in the order outlined in Resizing a managed instance group. (instanceGroupManagers.resize)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the instance group manager resides.
string$instanceGroupManagerThe name of the instance group manager.
int$sizeNumber of instances that should exist in this Instance Group Manager.
array$optParamsOptional parameters.
Return values
Google_Service_Replicapool_Operation

◆ setInstanceTemplate()

Google_Service_Replicapool_InstanceGroupManagers_Resource::setInstanceTemplate ( $project,
$zone,
$instanceGroupManager,
Google_Service_Replicapool_InstanceGroupManagersSetInstanceTemplateRequest $postBody,
$optParams = array() )

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

Existing instances are not affected. (instanceGroupManagers.setInstanceTemplate)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the instance group manager resides.
string$instanceGroupManagerThe name of the instance group manager.
Google_InstanceGroupManagersSetInstanceTemplateRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Replicapool_Operation

◆ setTargetPools()

Google_Service_Replicapool_InstanceGroupManagers_Resource::setTargetPools ( $project,
$zone,
$instanceGroupManager,
Google_Service_Replicapool_InstanceGroupManagersSetTargetPoolsRequest $postBody,
$optParams = array() )

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

Existing instances in the group are not affected. (instanceGroupManagers.setTargetPools)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the instance group manager resides.
string$instanceGroupManagerThe name of the instance group manager.
Google_InstanceGroupManagersSetTargetPoolsRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Replicapool_Operation

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