Documentation

Google_Service_CloudMemorystoreforMemcached_Resource_ProjectsLocationsInstances extends Google_Service_Resource
in package

Application

The "instances" collection of methods.

Typical usage is: $memcacheService = new Google_Service_CloudMemorystoreforMemcached(...); $instances = $memcacheService->instances;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
applyParameters() : Google_Service_CloudMemorystoreforMemcached_Operation: ApplyParameters will restart the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_CloudMemorystoreforMemcached_Operation: Creates a new Instance in a given location. (instances.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_CloudMemorystoreforMemcached_Operation: Deletes a single Instance. (instances.delete)
get() : Google_Service_CloudMemorystoreforMemcached_Instance: Gets details of a single Instance. (instances.get)
listProjectsLocationsInstances() : Google_Service_CloudMemorystoreforMemcached_ListInstancesResponse: Lists Instances in a given location.
patch() : Google_Service_CloudMemorystoreforMemcached_Operation: Updates an existing Instance in a given project and location.
updateParameters() : Google_Service_CloudMemorystoreforMemcached_Operation: Updates the defined Memcached Parameters for an existing Instance. This method only stages the parameters, it must be followed by ApplyParameters to apply the parameters to nodes of the Memcached Instance.
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 —

applyParameters()

ApplyParameters will restart the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.


    public
                applyParameters(string $name, Google_Service_CloudMemorystoreforMemcached_ApplyParametersRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMemorystoreforMemcached_Operation

(instances.applyParameters)

Parameters

$name : string: Required. Resource name of the Memcached instance for which parameter group updates should be applied.
$postBody : Google_Service_CloudMemorystoreforMemcached_ApplyParametersRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMemorystoreforMemcached_Operation —

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 new Instance in a given location. (instances.create)


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

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_CloudMemorystoreforMemcached_Instance
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMemorystoreforMemcached_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 single Instance. (instances.delete)


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

Parameters

$name : string: Required. Memcached instance resource name in the format: 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_CloudMemorystoreforMemcached_Operation —

get()

Gets details of a single Instance. (instances.get)


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

Parameters

$name : string: Required. Memcached instance resource name in the format: 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_CloudMemorystoreforMemcached_Instance —

listProjectsLocationsInstances()

Lists Instances in a given location.


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

(instances.listProjectsLocationsInstances)

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_CloudMemorystoreforMemcached_ListInstancesResponse —

patch()

Updates an existing Instance in a given project and location.


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

(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: Memcached instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.
$postBody : Google_Service_CloudMemorystoreforMemcached_Instance
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMemorystoreforMemcached_Operation —

updateParameters()

Updates the defined Memcached Parameters for an existing Instance. This method only stages the parameters, it must be followed by ApplyParameters to apply the parameters to nodes of the Memcached Instance.


    public
                updateParameters(string $name, Google_Service_CloudMemorystoreforMemcached_UpdateParametersRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudMemorystoreforMemcached_Operation

(instances.updateParameters)

Parameters

$name : string: Required. Resource name of the Memcached instance for which the parameters should be updated.
$postBody : Google_Service_CloudMemorystoreforMemcached_UpdateParametersRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudMemorystoreforMemcached_Operation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —