Google Cloud Memorystore for Redis API: Node.js Client

Google Cloud Memorystore for Redis API client for Node.js

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

• Google Cloud Memorystore for Redis API Node.js Client API Reference
• Google Cloud Memorystore for Redis API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-redis-cluster

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 Google Cloud Memorystore for Redis API API.
4. Set up authentication so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/redis-cluster

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 cluster 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` google.cloud.redis.cluster.v1.ListClustersResponse.next_page_token *  to determine if there are more clusters left to be queried. */// const pageSize = 1234/** *  The `next_page_token` value returned from a previous *  ListClusters CloudRedis.ListClusters  request, if any. */// const pageToken = 'abc123'// Imports the Cluster libraryconst {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;// Instantiates a clientconst clusterClient = newCloudRedisClusterClient();async function callListClusters() {  // Construct request  const request = {    parent,  };  // Run request  const iterable = await clusterClient.listClustersAsync(request);  for await (const response of iterable) {    console.log(response);  }}callListClusters();

Samples

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

Sample	Source Code	Try it
Cloud_redis_cluster.backup_cluster	source code
Cloud_redis_cluster.create_cluster	source code
Cloud_redis_cluster.delete_backup	source code
Cloud_redis_cluster.delete_cluster	source code
Cloud_redis_cluster.export_backup	source code
Cloud_redis_cluster.get_backup	source code
Cloud_redis_cluster.get_backup_collection	source code
Cloud_redis_cluster.get_cluster	source code
Cloud_redis_cluster.get_cluster_certificate_authority	source code
Cloud_redis_cluster.list_backup_collections	source code
Cloud_redis_cluster.list_backups	source code
Cloud_redis_cluster.list_clusters	source code
Cloud_redis_cluster.reschedule_cluster_maintenance	source code
Cloud_redis_cluster.update_cluster	source code
Cloud_redis_cluster.backup_cluster	source code
Cloud_redis_cluster.create_cluster	source code
Cloud_redis_cluster.delete_backup	source code
Cloud_redis_cluster.delete_cluster	source code
Cloud_redis_cluster.export_backup	source code
Cloud_redis_cluster.get_backup	source code
Cloud_redis_cluster.get_backup_collection	source code
Cloud_redis_cluster.get_cluster	source code
Cloud_redis_cluster.get_cluster_certificate_authority	source code
Cloud_redis_cluster.list_backup_collections	source code
Cloud_redis_cluster.list_backups	source code
Cloud_redis_cluster.list_clusters	source code
Cloud_redis_cluster.reschedule_cluster_maintenance	source code
Cloud_redis_cluster.update_cluster	source code
Quickstart	source code

TheGoogle Cloud Memorystore for Redis API 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/redis-cluster@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to be inpreview. This means it is still awork-in-progress and under active development. Any release is subject tobackwards-incompatible changes at any time.

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