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: | 1355 lines (38 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 18 classes
Google_Service_Replicapoolupdater:: (1 method):
__construct()
Google_Service_Replicapoolupdater_RollingUpdates_Resource:: (8 methods):
cancel()
get()
insert()
listRollingUpdates()
listInstanceUpdates()
pause()
resume()
rollback()
Google_Service_Replicapoolupdater_ZoneOperations_Resource:: (2 methods):
get()
listZoneOperations()
Google_Service_Replicapoolupdater_InstanceUpdate:: (6 methods):
setError()
getError()
setInstance()
getInstance()
setStatus()
getStatus()
Google_Service_Replicapoolupdater_InstanceUpdateError:: (2 methods):
setErrors()
getErrors()
Google_Service_Replicapoolupdater_InstanceUpdateErrorErrors:: (6 methods):
setCode()
getCode()
setLocation()
getLocation()
setMessage()
getMessage()
Google_Service_Replicapoolupdater_InstanceUpdateList:: (8 methods):
setItems()
getItems()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
setSelfLink()
getSelfLink()
Google_Service_Replicapoolupdater_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_Replicapoolupdater_OperationError:: (2 methods):
setErrors()
getErrors()
Google_Service_Replicapoolupdater_OperationErrorErrors:: (6 methods):
setCode()
getCode()
setLocation()
getLocation()
setMessage()
getMessage()
Google_Service_Replicapoolupdater_OperationList:: (10 methods):
setId()
getId()
setItems()
getItems()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
setSelfLink()
getSelfLink()
Google_Service_Replicapoolupdater_OperationWarnings:: (6 methods):
setCode()
getCode()
setData()
getData()
setMessage()
getMessage()
Google_Service_Replicapoolupdater_OperationWarningsData:: (4 methods):
setKey()
getKey()
setValue()
getValue()
Google_Service_Replicapoolupdater_RollingUpdate:: (32 methods):
setActionType()
getActionType()
setCreationTimestamp()
getCreationTimestamp()
setDescription()
getDescription()
setError()
getError()
setId()
getId()
setInstanceGroup()
getInstanceGroup()
setInstanceGroupManager()
getInstanceGroupManager()
setInstanceTemplate()
getInstanceTemplate()
setKind()
getKind()
setOldInstanceTemplate()
getOldInstanceTemplate()
setPolicy()
getPolicy()
setProgress()
getProgress()
setSelfLink()
getSelfLink()
setStatus()
getStatus()
setStatusMessage()
getStatusMessage()
setUser()
getUser()
Google_Service_Replicapoolupdater_RollingUpdateError:: (2 methods):
setErrors()
getErrors()
Google_Service_Replicapoolupdater_RollingUpdateErrorErrors:: (6 methods):
setCode()
getCode()
setLocation()
getLocation()
setMessage()
getMessage()
Google_Service_Replicapoolupdater_RollingUpdateList:: (8 methods):
setItems()
getItems()
setKind()
getKind()
setNextPageToken()
getNextPageToken()
setSelfLink()
getSelfLink()
Google_Service_Replicapoolupdater_RollingUpdatePolicy:: (10 methods):
setAutoPauseAfterInstances()
getAutoPauseAfterInstances()
setInstanceStartupTimeoutSec()
getInstanceStartupTimeoutSec()
setMaxNumConcurrentInstances()
getMaxNumConcurrentInstances()
setMaxNumFailedInstances()
getMaxNumFailedInstances()
setMinInstanceUpdateTimeSec()
getMinInstanceUpdateTimeSec()
Class: Google_Service_Replicapoolupdater - X-Ref
Service definition for Replicapoolupdater (v1beta1).<p>
The Google Compute Engine Instance Group Updater API provides services for
updating groups of Compute Engine Instances.</p>
<p>
For more information about this service, see the API
<a href="https://cloud.google.com/compute/docs/instance-groups/manager/#applying_rolling_updates_using_the_updater_service" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the Replicapoolupdater service. param: Google_Client $client |
Class: Google_Service_Replicapoolupdater_RollingUpdates_Resource - X-Ref
The "rollingUpdates" collection of methods.Typical usage is:
<code>
$replicapoolupdaterService = new Google_Service_Replicapoolupdater(...);
$rollingUpdates = $replicapoolupdaterService->rollingUpdates;
</code>
| cancel($project, $zone, $rollingUpdate, $optParams = array() X-Ref |
| Cancels an update. The update must be PAUSED before it can be cancelled. This has no effect if the update is already CANCELLED. (rollingUpdates.cancel) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the update's target param: string $rollingUpdate The name of the update. param: array $optParams Optional parameters. return: Google_Service_Replicapoolupdater_Operation |
| get($project, $zone, $rollingUpdate, $optParams = array() X-Ref |
| Returns information about an update. (rollingUpdates.get) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the update's target param: string $rollingUpdate The name of the update. param: array $optParams Optional parameters. return: Google_Service_Replicapoolupdater_RollingUpdate |
| insert($project, $zone, Google_Service_Replicapoolupdater_RollingUpdate $postBody, $optParams = array() X-Ref |
| Inserts and starts a new update. (rollingUpdates.insert) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the update's target param: Google_RollingUpdate $postBody param: array $optParams Optional parameters. return: Google_Service_Replicapoolupdater_Operation |
| listRollingUpdates($project, $zone, $optParams = array() X-Ref |
| Lists recent updates for a given managed instance group, in reverse chronological order and paginated format. (rollingUpdates.listRollingUpdates) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the update's target param: array $optParams Optional parameters. return: Google_Service_Replicapoolupdater_RollingUpdateList |
| listInstanceUpdates($project, $zone, $rollingUpdate, $optParams = array() X-Ref |
| Lists the current status for each instance within a given update. (rollingUpdates.listInstanceUpdates) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the update's target param: string $rollingUpdate The name of the update. param: array $optParams Optional parameters. return: Google_Service_Replicapoolupdater_InstanceUpdateList |
| pause($project, $zone, $rollingUpdate, $optParams = array() X-Ref |
| Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED. (rollingUpdates.pause) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the update's target param: string $rollingUpdate The name of the update. param: array $optParams Optional parameters. return: Google_Service_Replicapoolupdater_Operation |
| resume($project, $zone, $rollingUpdate, $optParams = array() X-Ref |
| Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT. (rollingUpdates.resume) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the update's target param: string $rollingUpdate The name of the update. param: array $optParams Optional parameters. return: Google_Service_Replicapoolupdater_Operation |
| rollback($project, $zone, $rollingUpdate, $optParams = array() X-Ref |
| Rolls back the update in state from ROLLING_FORWARD or PAUSED. Has no effect if invoked when the state of the update is ROLLED_BACK. (rollingUpdates.rollback) param: string $project The Google Developers Console project name. param: string $zone The name of the zone in which the update's target param: string $rollingUpdate The name of the update. param: array $optParams Optional parameters. return: Google_Service_Replicapoolupdater_Operation |
Class: Google_Service_Replicapoolupdater_ZoneOperations_Resource - X-Ref
The "zoneOperations" collection of methods.Typical usage is:
<code>
$replicapoolupdaterService = new Google_Service_Replicapoolupdater(...);
$zoneOperations = $replicapoolupdaterService->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_Replicapoolupdater_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_Replicapoolupdater_OperationList |
Class: Google_Service_Replicapoolupdater_InstanceUpdateErrorErrors - 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_Replicapoolupdater_InstanceUpdateList - X-Ref
| 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_Replicapoolupdater_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_Replicapoolupdater_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_Replicapoolupdater_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_Replicapoolupdater_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_Replicapoolupdater_RollingUpdate - X-Ref
| setActionType($actionType) X-Ref |
| No description |
| getActionType() X-Ref |
| No description |
| setCreationTimestamp($creationTimestamp) X-Ref |
| No description |
| getCreationTimestamp() X-Ref |
| No description |
| setDescription($description) X-Ref |
| No description |
| getDescription() X-Ref |
| No description |
| setError(Google_Service_Replicapoolupdater_RollingUpdateError $error) X-Ref |
| No description |
| getError() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setInstanceGroup($instanceGroup) X-Ref |
| No description |
| getInstanceGroup() X-Ref |
| No description |
| setInstanceGroupManager($instanceGroupManager) X-Ref |
| No description |
| getInstanceGroupManager() 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 |
| setOldInstanceTemplate($oldInstanceTemplate) X-Ref |
| No description |
| getOldInstanceTemplate() X-Ref |
| No description |
| setPolicy(Google_Service_Replicapoolupdater_RollingUpdatePolicy $policy) X-Ref |
| No description |
| getPolicy() X-Ref |
| No description |
| setProgress($progress) X-Ref |
| No description |
| getProgress() X-Ref |
| No description |
| setSelfLink($selfLink) X-Ref |
| No description |
| getSelfLink() 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 |
| setUser($user) X-Ref |
| No description |
| getUser() X-Ref |
| No description |
Class: Google_Service_Replicapoolupdater_RollingUpdateErrorErrors - 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_Replicapoolupdater_RollingUpdateList - X-Ref
| 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_Replicapoolupdater_RollingUpdatePolicy - X-Ref
| setAutoPauseAfterInstances($autoPauseAfterInstances) X-Ref |
| No description |
| getAutoPauseAfterInstances() X-Ref |
| No description |
| setInstanceStartupTimeoutSec($instanceStartupTimeoutSec) X-Ref |
| No description |
| getInstanceStartupTimeoutSec() X-Ref |
| No description |
| setMaxNumConcurrentInstances($maxNumConcurrentInstances) X-Ref |
| No description |
| getMaxNumConcurrentInstances() X-Ref |
| No description |
| setMaxNumFailedInstances($maxNumFailedInstances) X-Ref |
| No description |
| getMaxNumFailedInstances() X-Ref |
| No description |
| setMinInstanceUpdateTimeSec($minInstanceUpdateTimeSec) X-Ref |
| No description |
| getMinInstanceUpdateTimeSec() X-Ref |
| No description |
