Memorystore for Memcached V1 Client - Class CloudMemcacheClient (1.1.1)

Reference documentation and code samples for the Memorystore for Memcached V1 Client class CloudMemcacheClient.

Service Description: Configures and manages Cloud Memorystore for Memcached instances.

The memcache.googleapis.com service implements the Google Cloud Memorystore for Memcached API and defines the following resource model for managing Memorystore Memcached (also called Memcached below) instances:

  • The service works with a collection of cloud projects, named: /projects/*
  • Each project has a collection of available locations, named: /locations/*
  • Each location has a collection of Memcached instances, named: /instances/*
  • As such, Memcached instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note that location_id must be a GCP region; for example:

  • projects/my-memcached-project/locations/us-central1/instances/my-memcached

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$cloudMemcacheClient = new CloudMemcacheClient();
try {
    $formattedName = $cloudMemcacheClient->instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
    $operationResponse = $cloudMemcacheClient->applyParameters($formattedName);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $cloudMemcacheClient->applyParameters($formattedName);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $cloudMemcacheClient->resumeOperation($operationName, 'applyParameters');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $cloudMemcacheClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This service has a new (beta) implementation. See Google\Cloud\Memcache\V1\Client\CloudMemcacheClient to use the new surface.

Namespace

Google \ Cloud \ Memcache \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
options array

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.

↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

applyParameters

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

Parameters
NameDescription
name string

Required. Resource name of the Memcached instance for which parameter group updates should be applied.

optionalArgs array

Optional.

↳ nodeIds string[]

Nodes to which the instance-level parameter group is applied.

↳ applyAll bool

Whether to apply instance-level parameter group to all nodes. If set to true, users are restricted from specifying individual nodes, and ApplyParameters updates all nodes within the instance.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memcache\V1\CloudMemcacheClient;
use Google\Cloud\Memcache\V1\Instance;
use Google\Rpc\Status;

/**
 * @param string $formattedName Resource name of the Memcached instance for which parameter group updates
 *                              should be applied. Please see
 *                              {@see CloudMemcacheClient::instanceName()} for help formatting this field.
 */
function apply_parameters_sample(string $formattedName): void
{
    // Create a client.
    $cloudMemcacheClient = new CloudMemcacheClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $cloudMemcacheClient->applyParameters($formattedName);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Instance $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CloudMemcacheClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');

    apply_parameters_sample($formattedName);
}

createInstance

Creates a new Instance in a given location.

Parameters
NameDescription
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

instanceId string

Required. The logical name of the Memcached instance in the user project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-40 characters.
  • Must end with a number or a letter.
  • Must be unique within the user project / location.

If any of the above are not met, the API raises an invalid argument error.

instance Google\Cloud\Memcache\V1\Instance

Required. A Memcached Instance

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memcache\V1\CloudMemcacheClient;
use Google\Cloud\Memcache\V1\Instance;
use Google\Cloud\Memcache\V1\Instance\NodeConfig;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                The resource name of the instance location using the form:
 *                                               `projects/{project_id}/locations/{location_id}`
 *                                               where `location_id` refers to a GCP region
 *                                               Please see {@see CloudMemcacheClient::locationName()} for help formatting this field.
 * @param string $instanceId                     The logical name of the Memcached instance in the user
 *                                               project with the following restrictions:
 *
 *                                               * Must contain only lowercase letters, numbers, and hyphens.
 *                                               * Must start with a letter.
 *                                               * Must be between 1-40 characters.
 *                                               * Must end with a number or a letter.
 *                                               * Must be unique within the user project / location.
 *
 *                                               If any of the above are not met, the API raises an invalid argument error.
 * @param string $instanceName                   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 the regional level
 *                                               so `location_id` here refers to a Google Cloud region; however, users may
 *                                               choose which zones Memcached nodes should be provisioned in within an
 *                                               instance. Refer to [zones][google.cloud.memcache.v1.Instance.zones] field for more details.
 * @param int    $instanceNodeCount              Number of nodes in the Memcached instance.
 * @param int    $instanceNodeConfigCpuCount     Number of cpus per Memcached node.
 * @param int    $instanceNodeConfigMemorySizeMb Memory size in MiB for each Memcached node.
 */
function create_instance_sample(
    string $formattedParent,
    string $instanceId,
    string $instanceName,
    int $instanceNodeCount,
    int $instanceNodeConfigCpuCount,
    int $instanceNodeConfigMemorySizeMb
): void {
    // Create a client.
    $cloudMemcacheClient = new CloudMemcacheClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $instanceNodeConfig = (new NodeConfig())
        ->setCpuCount($instanceNodeConfigCpuCount)
        ->setMemorySizeMb($instanceNodeConfigMemorySizeMb);
    $instance = (new Instance())
        ->setName($instanceName)
        ->setNodeCount($instanceNodeCount)
        ->setNodeConfig($instanceNodeConfig);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $cloudMemcacheClient->createInstance($formattedParent, $instanceId, $instance);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Instance $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = CloudMemcacheClient::locationName('[PROJECT]', '[LOCATION]');
    $instanceId = '[INSTANCE_ID]';
    $instanceName = '[NAME]';
    $instanceNodeCount = 0;
    $instanceNodeConfigCpuCount = 0;
    $instanceNodeConfigMemorySizeMb = 0;

    create_instance_sample(
        $formattedParent,
        $instanceId,
        $instanceName,
        $instanceNodeCount,
        $instanceNodeConfigCpuCount,
        $instanceNodeConfigMemorySizeMb
    );
}

deleteInstance

Deletes a single Instance.

Parameters
NameDescription
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

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memcache\V1\CloudMemcacheClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName Memcached instance resource name in the format:
 *                              `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
 *                              where `location_id` refers to a GCP region
 *                              Please see {@see CloudMemcacheClient::instanceName()} for help formatting this field.
 */
function delete_instance_sample(string $formattedName): void
{
    // Create a client.
    $cloudMemcacheClient = new CloudMemcacheClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $cloudMemcacheClient->deleteInstance($formattedName);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CloudMemcacheClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');

    delete_instance_sample($formattedName);
}

getInstance

Gets details of a single Instance.

Parameters
NameDescription
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

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Memcache\V1\Instance
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Memcache\V1\CloudMemcacheClient;
use Google\Cloud\Memcache\V1\Instance;

/**
 * @param string $formattedName Memcached instance resource name in the format:
 *                              `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
 *                              where `location_id` refers to a GCP region
 *                              Please see {@see CloudMemcacheClient::instanceName()} for help formatting this field.
 */
function get_instance_sample(string $formattedName): void
{
    // Create a client.
    $cloudMemcacheClient = new CloudMemcacheClient();

    // Call the API and handle any network failures.
    try {
        /** @var Instance $response */
        $response = $cloudMemcacheClient->getInstance($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CloudMemcacheClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');

    get_instance_sample($formattedName);
}

listInstances

Lists Instances in a given location.

Parameters
NameDescription
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

optionalArgs array

Optional.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ filter string

List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".

↳ orderBy string

Sort results. Supported values are "name", "name desc" or "" (unsorted).

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Memcache\V1\CloudMemcacheClient;
use Google\Cloud\Memcache\V1\Instance;

/**
 * @param string $formattedParent The resource name of the instance location using the form:
 *                                `projects/{project_id}/locations/{location_id}`
 *                                where `location_id` refers to a GCP region
 *                                Please see {@see CloudMemcacheClient::locationName()} for help formatting this field.
 */
function list_instances_sample(string $formattedParent): void
{
    // Create a client.
    $cloudMemcacheClient = new CloudMemcacheClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $cloudMemcacheClient->listInstances($formattedParent);

        /** @var Instance $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = CloudMemcacheClient::locationName('[PROJECT]', '[LOCATION]');

    list_instances_sample($formattedParent);
}

rescheduleMaintenance

Reschedules upcoming maintenance event.

Parameters
NameDescription
instance string

Required. Memcache instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

rescheduleType int

Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well. For allowed values, use constants defined on Google\Cloud\Memcache\V1\RescheduleMaintenanceRequest\RescheduleType

optionalArgs array

Optional.

↳ scheduleTime Timestamp

Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memcache\V1\CloudMemcacheClient;
use Google\Cloud\Memcache\V1\Instance;
use Google\Cloud\Memcache\V1\RescheduleMaintenanceRequest\RescheduleType;
use Google\Rpc\Status;

/**
 * @param string $formattedInstance Memcache instance resource name using the form:
 *                                  `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
 *                                  where `location_id` refers to a GCP region. Please see
 *                                  {@see CloudMemcacheClient::instanceName()} for help formatting this field.
 * @param int    $rescheduleType    If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
 */
function reschedule_maintenance_sample(string $formattedInstance, int $rescheduleType): void
{
    // Create a client.
    $cloudMemcacheClient = new CloudMemcacheClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $cloudMemcacheClient->rescheduleMaintenance($formattedInstance, $rescheduleType);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Instance $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedInstance = CloudMemcacheClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
    $rescheduleType = RescheduleType::RESCHEDULE_TYPE_UNSPECIFIED;

    reschedule_maintenance_sample($formattedInstance, $rescheduleType);
}

updateInstance

Updates an existing Instance in a given project and location.

Parameters
NameDescription
updateMask Google\Protobuf\FieldMask

Required. Mask of fields to update.

  • displayName
instance Google\Cloud\Memcache\V1\Instance

Required. A Memcached Instance. Only fields specified in update_mask are updated.

optionalArgs array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memcache\V1\CloudMemcacheClient;
use Google\Cloud\Memcache\V1\Instance;
use Google\Cloud\Memcache\V1\Instance\NodeConfig;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $instanceName                   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 the regional level
 *                                               so `location_id` here refers to a Google Cloud region; however, users may
 *                                               choose which zones Memcached nodes should be provisioned in within an
 *                                               instance. Refer to [zones][google.cloud.memcache.v1.Instance.zones] field for more details.
 * @param int    $instanceNodeCount              Number of nodes in the Memcached instance.
 * @param int    $instanceNodeConfigCpuCount     Number of cpus per Memcached node.
 * @param int    $instanceNodeConfigMemorySizeMb Memory size in MiB for each Memcached node.
 */
function update_instance_sample(
    string $instanceName,
    int $instanceNodeCount,
    int $instanceNodeConfigCpuCount,
    int $instanceNodeConfigMemorySizeMb
): void {
    // Create a client.
    $cloudMemcacheClient = new CloudMemcacheClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $updateMask = new FieldMask();
    $instanceNodeConfig = (new NodeConfig())
        ->setCpuCount($instanceNodeConfigCpuCount)
        ->setMemorySizeMb($instanceNodeConfigMemorySizeMb);
    $instance = (new Instance())
        ->setName($instanceName)
        ->setNodeCount($instanceNodeCount)
        ->setNodeConfig($instanceNodeConfig);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $cloudMemcacheClient->updateInstance($updateMask, $instance);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Instance $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $instanceName = '[NAME]';
    $instanceNodeCount = 0;
    $instanceNodeConfigCpuCount = 0;
    $instanceNodeConfigMemorySizeMb = 0;

    update_instance_sample(
        $instanceName,
        $instanceNodeCount,
        $instanceNodeConfigCpuCount,
        $instanceNodeConfigMemorySizeMb
    );
}

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.

Parameters
NameDescription
name string

Required. Resource name of the Memcached instance for which the parameters should be updated.

updateMask Google\Protobuf\FieldMask

Required. Mask of fields to update.

optionalArgs array

Optional.

↳ parameters MemcacheParameters

The parameters to apply to the instance.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memcache\V1\CloudMemcacheClient;
use Google\Cloud\Memcache\V1\Instance;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $formattedName Resource name of the Memcached instance for which the parameters should be
 *                              updated. Please see
 *                              {@see CloudMemcacheClient::instanceName()} for help formatting this field.
 */
function update_parameters_sample(string $formattedName): void
{
    // Create a client.
    $cloudMemcacheClient = new CloudMemcacheClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $updateMask = new FieldMask();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $cloudMemcacheClient->updateParameters($formattedName, $updateMask);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Instance $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CloudMemcacheClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');

    update_parameters_sample($formattedName);
}

getLocation

Gets information about a location.

Parameters
NameDescription
optionalArgs array

Optional.

↳ name string

Resource name for the location.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Location\Location
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Location\Location;
use Google\Cloud\Memcache\V1\CloudMemcacheClient;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function get_location_sample(): void
{
    // Create a client.
    $cloudMemcacheClient = new CloudMemcacheClient();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $cloudMemcacheClient->getLocation();
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

Parameters
NameDescription
optionalArgs array

Optional.

↳ name string

The resource that owns the locations collection, if applicable.

↳ filter string

The standard list filter.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\Location;
use Google\Cloud\Memcache\V1\CloudMemcacheClient;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_locations_sample(): void
{
    // Create a client.
    $cloudMemcacheClient = new CloudMemcacheClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $cloudMemcacheClient->listLocations();

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
TypeDescription
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
NameDescription
operationName string

The name of the long running operation

methodName string

The name of the method used to start the operation

Returns
TypeDescription
Google\ApiCore\OperationResponse

static::instanceName

Formats a string containing the fully-qualified path to represent a instance resource.

Parameters
NameDescription
project string
location string
instance string
Returns
TypeDescription
stringThe formatted instance resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
stringThe formatted location resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • instance: projects/{project}/locations/{location}/instances/{instance}
  • location: projects/{project}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.cloud.memcache.v1.CloudMemcache'

The name of the service.

SERVICE_ADDRESS

Value: 'memcache.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.