Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 1313 lines (39 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 17 classes
Google_Service_Replicapool:: (1 method):
__construct()
Google_Service_Replicapool_InstanceGroupManagers_Resource:: (10 methods):
abandonInstances()
delete()
deleteInstances()
get()
insert()
listInstanceGroupManagers()
recreateInstances()
resize()
setInstanceTemplate()
setTargetPools()
Google_Service_Replicapool_ZoneOperations_Resource:: (2 methods):
get()
listZoneOperations()
Google_Service_Replicapool_InstanceGroupManager:: (28 methods):
setAutoHealingPolicies()
getAutoHealingPolicies()
setBaseInstanceName()
getBaseInstanceName()
setCreationTimestamp()
getCreationTimestamp()
setCurrentSize()
getCurrentSize()
setDescription()
getDescription()
setFingerprint()
getFingerprint()
setGroup()
getGroup()
setId()
getId()
setInstanceTemplate()
getInstanceTemplate()
setKind()
getKind()
setName()
getName()
setSelfLink()
getSelfLink()
setTargetPools()
getTargetPools()
setTargetSize()
getTargetSize()
Google_Service_Replicapool_InstanceGroupManagerList:: (10 methods):
setId()
getId()
setItems()
getItems()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
setSelfLink()
getSelfLink()
Google_Service_Replicapool_InstanceGroupManagersAbandonInstancesRequest:: (2 methods):
setInstances()
getInstances()
Google_Service_Replicapool_InstanceGroupManagersDeleteInstancesRequest:: (2 methods):
setInstances()
getInstances()
Google_Service_Replicapool_InstanceGroupManagersRecreateInstancesRequest:: (2 methods):
setInstances()
getInstances()
Google_Service_Replicapool_InstanceGroupManagersSetInstanceTemplateRequest:: (2 methods):
setInstanceTemplate()
getInstanceTemplate()
Google_Service_Replicapool_InstanceGroupManagersSetTargetPoolsRequest:: (4 methods):
setFingerprint()
getFingerprint()
setTargetPools()
getTargetPools()
Google_Service_Replicapool_Operation:: (44 methods):
setClientOperationId()
getClientOperationId()
setCreationTimestamp()
getCreationTimestamp()
setEndTime()
getEndTime()
setError()
getError()
setHttpErrorMessage()
getHttpErrorMessage()
setHttpErrorStatusCode()
getHttpErrorStatusCode()
setId()
getId()
setInsertTime()
getInsertTime()
setKind()
getKind()
setName()
getName()
setOperationType()
getOperationType()
setProgress()
getProgress()
setRegion()
getRegion()
setSelfLink()
getSelfLink()
setStartTime()
getStartTime()
setStatus()
getStatus()
setStatusMessage()
getStatusMessage()
setTargetId()
getTargetId()
setTargetLink()
getTargetLink()
setUser()
getUser()
setWarnings()
getWarnings()
setZone()
getZone()
Google_Service_Replicapool_OperationError:: (2 methods):
setErrors()
getErrors()
Google_Service_Replicapool_OperationErrorErrors:: (6 methods):
setCode()
getCode()
setLocation()
getLocation()
setMessage()
getMessage()
Google_Service_Replicapool_OperationList:: (10 methods):
setId()
getId()
setItems()
getItems()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
setSelfLink()
getSelfLink()
Google_Service_Replicapool_OperationWarnings:: (6 methods):
setCode()
getCode()
setData()
getData()
setMessage()
getMessage()
Google_Service_Replicapool_OperationWarningsData:: (4 methods):
setKey()
getKey()
setValue()
getValue()
Google_Service_Replicapool_ReplicaPoolAutoHealingPolicy:: (4 methods):
setActionType()
getActionType()
setHealthCheck()
getHealthCheck()
Class: Google_Service_Replicapool - X-Ref
Service definition for Replicapool (v1beta2).<p>
The Google Compute Engine Instance Group Manager API provides groups of
homogenous Compute Engine Instances.</p>
<p>
For more information about this service, see the API
<a href="https://developers.google.com/compute/docs/instance-groups/manager/v1beta2" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the Replicapool service. param: Google_Client $client |
Class: Google_Service_Replicapool_InstanceGroupManagers_Resource - X-Ref
The "instanceGroupManagers" collection of methods.Typical usage is:
<code>
$replicapoolService = new Google_Service_Replicapool(...);
$instanceGroupManagers = $replicapoolService->instanceGroupManagers;
</code>
| abandonInstances($project, $zone, $instanceGroupManager, Google_Service_Replicapool_InstanceGroupManagersAbandonInstancesRequest $postBody, $optParams = array() X-Ref |
| 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) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the instance group manager param: string $instanceGroupManager The name of the instance group manager. param: Google_InstanceGroupManagersAbandonInstancesRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Replicapool_Operation |
| delete($project, $zone, $instanceGroupManager, $optParams = array() X-Ref |
| 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) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the instance group manager param: string $instanceGroupManager Name of the Instance Group Manager param: array $optParams Optional parameters. return: Google_Service_Replicapool_Operation |
| deleteInstances($project, $zone, $instanceGroupManager, Google_Service_Replicapool_InstanceGroupManagersDeleteInstancesRequest $postBody, $optParams = array() X-Ref |
| 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) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the instance group manager param: string $instanceGroupManager The name of the instance group manager. param: Google_InstanceGroupManagersDeleteInstancesRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Replicapool_Operation |
| get($project, $zone, $instanceGroupManager, $optParams = array() X-Ref |
| Returns the specified Instance Group Manager resource. (instanceGroupManagers.get) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the instance group manager param: string $instanceGroupManager Name of the instance resource to return. param: array $optParams Optional parameters. return: Google_Service_Replicapool_InstanceGroupManager |
| insert($project, $zone, $size, Google_Service_Replicapool_InstanceGroupManager $postBody, $optParams = array() X-Ref |
| Creates an instance group manager, as well as the instance group and the specified number of instances. (instanceGroupManagers.insert) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the instance group manager param: int $size Number of instances that should exist. param: Google_InstanceGroupManager $postBody param: array $optParams Optional parameters. return: Google_Service_Replicapool_Operation |
| listInstanceGroupManagers($project, $zone, $optParams = array() X-Ref |
| Retrieves the list of Instance Group Manager resources contained within the specified zone. (instanceGroupManagers.listInstanceGroupManagers) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the instance group manager param: array $optParams Optional parameters. return: Google_Service_Replicapool_InstanceGroupManagerList |
| recreateInstances($project, $zone, $instanceGroupManager, Google_Service_Replicapool_InstanceGroupManagersRecreateInstancesRequest $postBody, $optParams = array() X-Ref |
| Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template. (instanceGroupManagers.recreateInstances) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the instance group manager param: string $instanceGroupManager The name of the instance group manager. param: Google_InstanceGroupManagersRecreateInstancesRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Replicapool_Operation |
| resize($project, $zone, $instanceGroupManager, $size, $optParams = array() X-Ref |
| 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) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the instance group manager param: string $instanceGroupManager The name of the instance group manager. param: int $size Number of instances that should exist in this Instance Group param: array $optParams Optional parameters. return: Google_Service_Replicapool_Operation |
| setInstanceTemplate($project, $zone, $instanceGroupManager, Google_Service_Replicapool_InstanceGroupManagersSetInstanceTemplateRequest $postBody, $optParams = array() X-Ref |
| Sets the instance template to use when creating new instances in this group. Existing instances are not affected. (instanceGroupManagers.setInstanceTemplate) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the instance group manager param: string $instanceGroupManager The name of the instance group manager. param: Google_InstanceGroupManagersSetInstanceTemplateRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Replicapool_Operation |
| setTargetPools($project, $zone, $instanceGroupManager, Google_Service_Replicapool_InstanceGroupManagersSetTargetPoolsRequest $postBody, $optParams = array() X-Ref |
| Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. (instanceGroupManagers.setTargetPools) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the instance group manager param: string $instanceGroupManager The name of the instance group manager. param: Google_InstanceGroupManagersSetTargetPoolsRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Replicapool_Operation |
Class: Google_Service_Replicapool_ZoneOperations_Resource - X-Ref
The "zoneOperations" collection of methods.Typical usage is:
<code>
$replicapoolService = new Google_Service_Replicapool(...);
$zoneOperations = $replicapoolService->zoneOperations;
</code>
| get($project, $zone, $operation, $optParams = array() X-Ref |
| Retrieves the specified zone-specific operation resource. (zoneOperations.get) param: string $project Name of the project scoping this request. param: string $zone Name of the zone scoping this request. param: string $operation Name of the operation resource to return. param: array $optParams Optional parameters. return: Google_Service_Replicapool_Operation |
| listZoneOperations($project, $zone, $optParams = array() X-Ref |
| Retrieves the list of operation resources contained within the specified zone. (zoneOperations.listZoneOperations) param: string $project Name of the project scoping this request. param: string $zone Name of the zone scoping this request. param: array $optParams Optional parameters. return: Google_Service_Replicapool_OperationList |
Class: Google_Service_Replicapool_InstanceGroupManager - X-Ref
| setAutoHealingPolicies($autoHealingPolicies) X-Ref |
| No description |
| getAutoHealingPolicies() X-Ref |
| No description |
| setBaseInstanceName($baseInstanceName) X-Ref |
| No description |
| getBaseInstanceName() X-Ref |
| No description |
| setCreationTimestamp($creationTimestamp) X-Ref |
| No description |
| getCreationTimestamp() X-Ref |
| No description |
| setCurrentSize($currentSize) X-Ref |
| No description |
| getCurrentSize() X-Ref |
| No description |
| setDescription($description) X-Ref |
| No description |
| getDescription() X-Ref |
| No description |
| setFingerprint($fingerprint) X-Ref |
| No description |
| getFingerprint() X-Ref |
| No description |
| setGroup($group) X-Ref |
| No description |
| getGroup() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setInstanceTemplate($instanceTemplate) X-Ref |
| No description |
| getInstanceTemplate() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setSelfLink($selfLink) X-Ref |
| No description |
| getSelfLink() X-Ref |
| No description |
| setTargetPools($targetPools) X-Ref |
| No description |
| getTargetPools() X-Ref |
| No description |
| setTargetSize($targetSize) X-Ref |
| No description |
| getTargetSize() X-Ref |
| No description |
Class: Google_Service_Replicapool_InstanceGroupManagerList - X-Ref
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setItems($items) X-Ref |
| No description |
| getItems() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
| setSelfLink($selfLink) X-Ref |
| No description |
| getSelfLink() X-Ref |
| No description |
Class: Google_Service_Replicapool_InstanceGroupManagersSetInstanceTemplateRequest - X-Ref
| setInstanceTemplate($instanceTemplate) X-Ref |
| No description |
| getInstanceTemplate() X-Ref |
| No description |
Class: Google_Service_Replicapool_InstanceGroupManagersSetTargetPoolsRequest - X-Ref
| setFingerprint($fingerprint) X-Ref |
| No description |
| getFingerprint() X-Ref |
| No description |
| setTargetPools($targetPools) X-Ref |
| No description |
| getTargetPools() X-Ref |
| No description |
Class: Google_Service_Replicapool_Operation - X-Ref
| setClientOperationId($clientOperationId) X-Ref |
| No description |
| getClientOperationId() X-Ref |
| No description |
| setCreationTimestamp($creationTimestamp) X-Ref |
| No description |
| getCreationTimestamp() X-Ref |
| No description |
| setEndTime($endTime) X-Ref |
| No description |
| getEndTime() X-Ref |
| No description |
| setError(Google_Service_Replicapool_OperationError $error) X-Ref |
| No description |
| getError() X-Ref |
| No description |
| setHttpErrorMessage($httpErrorMessage) X-Ref |
| No description |
| getHttpErrorMessage() X-Ref |
| No description |
| setHttpErrorStatusCode($httpErrorStatusCode) X-Ref |
| No description |
| getHttpErrorStatusCode() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setInsertTime($insertTime) X-Ref |
| No description |
| getInsertTime() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setOperationType($operationType) X-Ref |
| No description |
| getOperationType() X-Ref |
| No description |
| setProgress($progress) X-Ref |
| No description |
| getProgress() X-Ref |
| No description |
| setRegion($region) X-Ref |
| No description |
| getRegion() X-Ref |
| No description |
| setSelfLink($selfLink) X-Ref |
| No description |
| getSelfLink() X-Ref |
| No description |
| setStartTime($startTime) X-Ref |
| No description |
| getStartTime() X-Ref |
| No description |
| setStatus($status) X-Ref |
| No description |
| getStatus() X-Ref |
| No description |
| setStatusMessage($statusMessage) X-Ref |
| No description |
| getStatusMessage() X-Ref |
| No description |
| setTargetId($targetId) X-Ref |
| No description |
| getTargetId() X-Ref |
| No description |
| setTargetLink($targetLink) X-Ref |
| No description |
| getTargetLink() X-Ref |
| No description |
| setUser($user) X-Ref |
| No description |
| getUser() X-Ref |
| No description |
| setWarnings($warnings) X-Ref |
| No description |
| getWarnings() X-Ref |
| No description |
| setZone($zone) X-Ref |
| No description |
| getZone() X-Ref |
| No description |
Class: Google_Service_Replicapool_OperationErrorErrors - X-Ref
| setCode($code) X-Ref |
| No description |
| getCode() X-Ref |
| No description |
| setLocation($location) X-Ref |
| No description |
| getLocation() X-Ref |
| No description |
| setMessage($message) X-Ref |
| No description |
| getMessage() X-Ref |
| No description |
Class: Google_Service_Replicapool_OperationList - X-Ref
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setItems($items) X-Ref |
| No description |
| getItems() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
| setSelfLink($selfLink) X-Ref |
| No description |
| getSelfLink() X-Ref |
| No description |
Class: Google_Service_Replicapool_ReplicaPoolAutoHealingPolicy - X-Ref
| setActionType($actionType) X-Ref |
| No description |
| getActionType() X-Ref |
| No description |
| setHealthCheck($healthCheck) X-Ref |
| No description |
| getHealthCheck() X-Ref |
| No description |
