Documentation

Google_Service_CloudRedis_Resource_ProjectsLocationsInstances extends Google_Service_Resource
in package

Application

The "instances" collection of methods.

Typical usage is: $redisService = new Google_Service_CloudRedis(...); $instances = $redisService->instances;

$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.
create() : Google_Service_CloudRedis_Operation: Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's [default network](https://cloud.google.com/vpc/docs/vpc). The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_CloudRedis_Operation: Deletes a specific Redis instance. Instance stops serving and data is deleted. (instances.delete)
export() : Google_Service_CloudRedis_Operation: Export Redis instance data into a Redis RDB format file in Cloud Storage.
failover() : Google_Service_CloudRedis_Operation: Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
get() : Google_Service_CloudRedis_Instance: Gets the details of a specific Redis instance. (instances.get)
import() : Google_Service_CloudRedis_Operation: Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
listProjectsLocationsInstances() : Google_Service_CloudRedis_ListInstancesResponse: Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. (instances.listProjectsLocationsInstances)
patch() : Google_Service_CloudRedis_Operation: Updates the metadata and configuration of a specific Redis instance.
upgrade() : Google_Service_CloudRedis_Operation: Upgrades Redis instance to the newer Redis version specified in the request.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

create()

Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's [default network](https://cloud.google.com/vpc/docs/vpc). The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.


    public
                create(string $parent, Google_Service_CloudRedis_Instance $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRedis_Operation

(instances.create)

Parameters

$parent : string: Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.
$postBody : Google_Service_CloudRedis_Instance
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudRedis_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>

Return values

string —

$requestUrl

delete()

Deletes a specific Redis instance. Instance stops serving and data is deleted. (instances.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRedis_Operation

Parameters

$name : string: Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudRedis_Operation —

export()

Export Redis instance data into a Redis RDB format file in Cloud Storage.


    public
                export(string $name, Google_Service_CloudRedis_ExportInstanceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRedis_Operation

Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. (instances.export)

Parameters

$name : string: Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.
$postBody : Google_Service_CloudRedis_ExportInstanceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudRedis_Operation —

failover()

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.


    public
                failover(string $name, Google_Service_CloudRedis_FailoverInstanceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRedis_Operation

(instances.failover)

Parameters

$name : string: Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.
$postBody : Google_Service_CloudRedis_FailoverInstanceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudRedis_Operation —

get()

Gets the details of a specific Redis instance. (instances.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRedis_Instance

Parameters

$name : string: Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudRedis_Instance —

import()

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.


    public
                import(string $name, Google_Service_CloudRedis_ImportInstanceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRedis_Operation

Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. (instances.import)

Parameters

$name : string: Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.
$postBody : Google_Service_CloudRedis_ImportInstanceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudRedis_Operation —

listProjectsLocationsInstances()

Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. (instances.listProjectsLocationsInstances)


    public
                listProjectsLocationsInstances(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRedis_ListInstancesResponse

Parameters

$parent : string: Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudRedis_ListInstancesResponse —

patch()

Updates the metadata and configuration of a specific Redis instance.


    public
                patch(string $name, Google_Service_CloudRedis_Instance $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRedis_Operation

Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. (instances.patch)

Parameters

$name : string: Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.
$postBody : Google_Service_CloudRedis_Instance
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudRedis_Operation —

upgrade()

Upgrades Redis instance to the newer Redis version specified in the request.


    public
                upgrade(string $name, Google_Service_CloudRedis_UpgradeInstanceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRedis_Operation

(instances.upgrade)

Parameters

$name : string: Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.
$postBody : Google_Service_CloudRedis_UpgradeInstanceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudRedis_Operation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —