Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Replicapoolupdater_RollingUpdates_Resource Class Reference

The "rollingUpdates" collection of methods. More...

Inheritance diagram for Google_Service_Replicapoolupdater_RollingUpdates_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 cancel ($project, $zone, $rollingUpdate, $optParams=array())
 Cancels an update.
 
 get ($project, $zone, $rollingUpdate, $optParams=array())
 Returns information about an update.
 
 insert ($project, $zone, Google_Service_Replicapoolupdater_RollingUpdate $postBody, $optParams=array())
 Inserts and starts a new update.
 
 listInstanceUpdates ($project, $zone, $rollingUpdate, $optParams=array())
 Lists the current status for each instance within a given update.
 
 listRollingUpdates ($project, $zone, $optParams=array())
 Lists recent updates for a given managed instance group, in reverse chronological order and paginated format.
 
 pause ($project, $zone, $rollingUpdate, $optParams=array())
 Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK.
 
 resume ($project, $zone, $rollingUpdate, $optParams=array())
 Continues an update in PAUSED state.
 
 rollback ($project, $zone, $rollingUpdate, $optParams=array())
 Rolls back the update in state from ROLLING_FORWARD or PAUSED.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "rollingUpdates" collection of methods.

Typical usage is: $replicapoolupdaterService = new Google_Service_Replicapoolupdater(...); $rollingUpdates = $replicapoolupdaterService->rollingUpdates;

Member Function Documentation

◆ 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

◆ cancel()

Google_Service_Replicapoolupdater_RollingUpdates_Resource::cancel ( $project,
$zone,
$rollingUpdate,
$optParams = array() )

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)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the update's target resides.
string$rollingUpdateThe name of the update.
array$optParamsOptional parameters.
Return values
Google_Service_Replicapoolupdater_Operation

◆ get()

Google_Service_Replicapoolupdater_RollingUpdates_Resource::get ( $project,
$zone,
$rollingUpdate,
$optParams = array() )

Returns information about an update.

(rollingUpdates.get)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the update's target resides.
string$rollingUpdateThe name of the update.
array$optParamsOptional parameters.
Return values
Google_Service_Replicapoolupdater_RollingUpdate

◆ insert()

Google_Service_Replicapoolupdater_RollingUpdates_Resource::insert ( $project,
$zone,
Google_Service_Replicapoolupdater_RollingUpdate $postBody,
$optParams = array() )

Inserts and starts a new update.

(rollingUpdates.insert)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the update's target resides.
Google_RollingUpdate$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Replicapoolupdater_Operation

◆ listInstanceUpdates()

Google_Service_Replicapoolupdater_RollingUpdates_Resource::listInstanceUpdates ( $project,
$zone,
$rollingUpdate,
$optParams = array() )

Lists the current status for each instance within a given update.

(rollingUpdates.listInstanceUpdates)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the update's target resides.
string$rollingUpdateThe name of the update.
array$optParamsOptional parameters.

@opt_param string maxResults Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500. @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.

Return values
Google_Service_Replicapoolupdater_InstanceUpdateList

◆ listRollingUpdates()

Google_Service_Replicapoolupdater_RollingUpdates_Resource::listRollingUpdates ( $project,
$zone,
$optParams = array() )

Lists recent updates for a given managed instance group, in reverse chronological order and paginated format.

(rollingUpdates.listRollingUpdates)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the update's target 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_Replicapoolupdater_RollingUpdateList

◆ pause()

Google_Service_Replicapoolupdater_RollingUpdates_Resource::pause ( $project,
$zone,
$rollingUpdate,
$optParams = array() )

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)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the update's target resides.
string$rollingUpdateThe name of the update.
array$optParamsOptional parameters.
Return values
Google_Service_Replicapoolupdater_Operation

◆ resume()

Google_Service_Replicapoolupdater_RollingUpdates_Resource::resume ( $project,
$zone,
$rollingUpdate,
$optParams = array() )

Continues an update in PAUSED state.

Has no effect if invoked when the state of the update is ROLLED_OUT. (rollingUpdates.resume)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the update's target resides.
string$rollingUpdateThe name of the update.
array$optParamsOptional parameters.
Return values
Google_Service_Replicapoolupdater_Operation

◆ rollback()

Google_Service_Replicapoolupdater_RollingUpdates_Resource::rollback ( $project,
$zone,
$rollingUpdate,
$optParams = array() )

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)

Parameters
string$projectThe Google Developers Console project name.
string$zoneThe name of the zone in which the update's target resides.
string$rollingUpdateThe name of the update.
array$optParamsOptional parameters.
Return values
Google_Service_Replicapoolupdater_Operation

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