Documentation

Google_Service_Replicapool_Resource_Pools extends Google_Service_Resource
in package

The "pools" collection of methods.

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

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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes a replica pool. (pools.delete)
get()  : Google_Service_Replicapool_Pool
Gets information about a single replica pool. (pools.get)
insert()  : Google_Service_Replicapool_Pool
Inserts a new replica pool. (pools.insert)
listPools()  : Google_Service_Replicapool_PoolsListResponse
List all replica pools. (pools.listPools)
resize()  : Google_Service_Replicapool_Pool
Resize a pool. This is an asynchronous operation, and multiple overlapping resize requests can be made. Replica Pools will use the information from the last resize request. (pools.resize)
updatetemplate()  : mixed
Update the template used by the pool. (pools.updatetemplate)
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

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

delete()

Deletes a replica pool. (pools.delete)

public delete(string $projectName, string $zone, string $poolName, Google_Service_Replicapool_PoolsDeleteRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$projectName : string

The project ID for this replica pool.

$zone : string

The zone for this replica pool.

$poolName : string

The name of the replica pool for this request.

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

Optional parameters.

Return values
mixed

get()

Gets information about a single replica pool. (pools.get)

public get(string $projectName, string $zone, string $poolName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapool_Pool
Parameters
$projectName : string

The project ID for this replica pool.

$zone : string

The zone for this replica pool.

$poolName : string

The name of the replica pool for this request.

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

Optional parameters.

Return values
Google_Service_Replicapool_Pool

insert()

Inserts a new replica pool. (pools.insert)

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

The project ID for this replica pool.

$zone : string

The zone for this replica pool.

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

Optional parameters.

Return values
Google_Service_Replicapool_Pool

listPools()

List all replica pools. (pools.listPools)

public listPools(string $projectName, string $zone[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapool_PoolsListResponse
Parameters
$projectName : string

The project ID for this request.

$zone : string

The zone for this replica pool.

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

Optional parameters.

Tags
opt_param

int maxResults Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)

opt_param

string pageToken Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request.

Return values
Google_Service_Replicapool_PoolsListResponse

resize()

Resize a pool. This is an asynchronous operation, and multiple overlapping resize requests can be made. Replica Pools will use the information from the last resize request. (pools.resize)

public resize(string $projectName, string $zone, string $poolName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Replicapool_Pool
Parameters
$projectName : string

The project ID for this replica pool.

$zone : string

The zone for this replica pool.

$poolName : string

The name of the replica pool for this request.

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

Optional parameters.

Tags
opt_param

int numReplicas The desired number of replicas to resize to. If this number is larger than the existing number of replicas, new replicas will be added. If the number is smaller, then existing replicas will be deleted.

Return values
Google_Service_Replicapool_Pool

updatetemplate()

Update the template used by the pool. (pools.updatetemplate)

public updatetemplate(string $projectName, string $zone, string $poolName, Google_Service_Replicapool_Template $postBody[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$projectName : string

The project ID for this replica pool.

$zone : string

The zone for this replica pool.

$poolName : string

The name of the replica pool for this request.

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

Optional parameters.

Return values
mixed

convertToArrayAndStripNulls()

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

Search results