Documentation

Google_Service_Replicapoolupdater_Resource_RollingUpdates extends Google_Service_Resource
in package

The "rollingUpdates" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
cancel()  : Google_Service_Replicapoolupdater_Operation
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)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Replicapoolupdater_RollingUpdate
Returns information about an update. (rollingUpdates.get)
insert()  : Google_Service_Replicapoolupdater_Operation
Inserts and starts a new update. (rollingUpdates.insert)
listInstanceUpdates()  : Google_Service_Replicapoolupdater_InstanceUpdateList
Lists the current status for each instance within a given update.
listRollingUpdates()  : Google_Service_Replicapoolupdater_RollingUpdateList
Lists recent updates for a given managed instance group, in reverse chronological order and paginated format. (rollingUpdates.listRollingUpdates)
pause()  : Google_Service_Replicapoolupdater_Operation
Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED.
resume()  : Google_Service_Replicapoolupdater_Operation
Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT. (rollingUpdates.resume)
rollback()  : Google_Service_Replicapoolupdater_Operation
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.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

cancel()

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)

public cancel(string $project, string $zone, string $rollingUpdate[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapoolupdater_Operation
Parameters
$project : string

The Google Developers Console project name.

$zone : string

The name of the zone in which the update's target resides.

$rollingUpdate : string

The name of the update.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Replicapoolupdater_Operation

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

get()

Returns information about an update. (rollingUpdates.get)

public get(string $project, string $zone, string $rollingUpdate[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapoolupdater_RollingUpdate
Parameters
$project : string

The Google Developers Console project name.

$zone : string

The name of the zone in which the update's target resides.

$rollingUpdate : string

The name of the update.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Replicapoolupdater_RollingUpdate

insert()

Inserts and starts a new update. (rollingUpdates.insert)

public insert(string $project, string $zone, Google_Service_Replicapoolupdater_RollingUpdate $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapoolupdater_Operation
Parameters
$project : string

The Google Developers Console project name.

$zone : string

The name of the zone in which the update's target resides.

$postBody : Google_Service_Replicapoolupdater_RollingUpdate
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Replicapoolupdater_Operation

listInstanceUpdates()

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

public listInstanceUpdates(string $project, string $zone, string $rollingUpdate[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapoolupdater_InstanceUpdateList

(rollingUpdates.listInstanceUpdates)

Parameters
$project : string

The Google Developers Console project name.

$zone : string

The name of the zone in which the update's target resides.

$rollingUpdate : string

The name of the update.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter Optional. Filter expression for filtering listed resources.

opt_param

string maxResults Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.

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()

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

public listRollingUpdates(string $project, string $zone[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapoolupdater_RollingUpdateList
Parameters
$project : string

The Google Developers Console project name.

$zone : string

The name of the zone in which the update's target resides.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter Optional. Filter expression for filtering listed resources.

opt_param

string maxResults Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.

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_RollingUpdateList

pause()

Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED.

public pause(string $project, string $zone, string $rollingUpdate[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapoolupdater_Operation

(rollingUpdates.pause)

Parameters
$project : string

The Google Developers Console project name.

$zone : string

The name of the zone in which the update's target resides.

$rollingUpdate : string

The name of the update.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Replicapoolupdater_Operation

resume()

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

public resume(string $project, string $zone, string $rollingUpdate[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapoolupdater_Operation
Parameters
$project : string

The Google Developers Console project name.

$zone : string

The name of the zone in which the update's target resides.

$rollingUpdate : string

The name of the update.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Replicapoolupdater_Operation

rollback()

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.

public rollback(string $project, string $zone, string $rollingUpdate[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapoolupdater_Operation

(rollingUpdates.rollback)

Parameters
$project : string

The Google Developers Console project name.

$zone : string

The name of the zone in which the update's target resides.

$rollingUpdate : string

The name of the update.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Replicapoolupdater_Operation

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results