Documentation

Google_Service_Replicapool_Resource_Replicas extends Google_Service_Resource
in package

The "replicas" collection of methods.

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

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()  : Google_Service_Replicapool_Replica
Deletes a replica from the pool. (replicas.delete)
get()  : Google_Service_Replicapool_Replica
Gets information about a specific replica. (replicas.get)
listReplicas()  : Google_Service_Replicapool_ReplicasListResponse
Lists all replicas in a pool. (replicas.listReplicas)
restart()  : Google_Service_Replicapool_Replica
Restarts a replica in a pool. (replicas.restart)
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 from the pool. (replicas.delete)

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

The project ID for this request.

$zone : string

The zone where the replica lives.

$poolName : string

The replica pool name for this request.

$replicaName : string

The name of the replica for this request.

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

Optional parameters.

Return values
Google_Service_Replicapool_Replica —

get()

Gets information about a specific replica. (replicas.get)

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

The project ID for this request.

$zone : string

The zone where the replica lives.

$poolName : string

The replica pool name for this request.

$replicaName : string

The name of the replica for this request.

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

Optional parameters.

Return values
Google_Service_Replicapool_Replica —

listReplicas()

Lists all replicas in a pool. (replicas.listReplicas)

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

The project ID for this request.

$zone : string

The zone where the replica pool lives.

$poolName : string

The replica pool name for this request.

$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_ReplicasListResponse —

restart()

Restarts a replica in a pool. (replicas.restart)

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

The project ID for this request.

$zone : string

The zone where the replica lives.

$poolName : string

The replica pool name for this request.

$replicaName : string

The name of the replica for this request.

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

Optional parameters.

Return values
Google_Service_Replicapool_Replica —

convertToArrayAndStripNulls()

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

Search results