Memorystore for Memcached: Node.js Client

Memcache client for Node.js

A comprehensive list of changes in each version may be found inthe CHANGELOG.

• Memorystore for Memcached Node.js Client API Reference
• Memorystore for Memcached Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-memcache

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Memorystore for Memcached API.
4. Set up authentication so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/memcache

Using the client library

/** * This snippet 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. * TODO(developer): Uncomment these variables before running the sample. *//** *  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 */// const parent = 'abc123'/** *  The maximum number of items to return. *  If not specified, a default value of 1000 will be used by the service. *  Regardless of the page_size value, the response may include a partial list *  and a caller should only rely on response's *  next_page_token CloudMemcache.ListInstancesResponse.next_page_token *  to determine if there are more instances left to be queried. */// const pageSize = 1234/** *  The next_page_token value returned from a previous List request, *  if any. */// const pageToken = 'abc123'/** *  List filter. For example, exclude all Memcached instances with name as *  my-instance by specifying "name != my-instance". */// const filter = 'abc123'/** *  Sort results. Supported values are "name", "name desc" or "" (unsorted). */// const orderBy = 'abc123'// Imports the Memcache libraryconst {CloudMemcacheClient} = require('@google-cloud/memcache').v1;// Instantiates a clientconst memcacheClient = newCloudMemcacheClient();async function callListInstances() {  // Construct request  const request = {    parent,  };  // Run request  const iterable = await memcacheClient.listInstancesAsync(request);  for await (const response of iterable) {    console.log(response);  }}callListInstances();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

Sample	Source Code	Try it
Cloud_memcache.apply_parameters	source code
Cloud_memcache.create_instance	source code
Cloud_memcache.delete_instance	source code
Cloud_memcache.get_instance	source code
Cloud_memcache.list_instances	source code
Cloud_memcache.reschedule_maintenance	source code
Cloud_memcache.update_instance	source code
Cloud_memcache.update_parameters	source code
Cloud_memcache.apply_parameters	source code
Cloud_memcache.apply_software_update	source code
Cloud_memcache.create_instance	source code
Cloud_memcache.delete_instance	source code
Cloud_memcache.get_instance	source code
Cloud_memcache.list_instances	source code
Cloud_memcache.reschedule_maintenance	source code
Cloud_memcache.update_instance	source code
Cloud_memcache.update_parameters	source code
Quickstart	source code

TheMemorystore for Memcached Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/memcache@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE