|
| 1 | +[//]: # "This README.md file is auto-generated, all changes to this file will be lost." |
| 2 | +[//]: # "The comments you see below are used to generate those parts of the template in later states." |
| 3 | +<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/> |
| 4 | + |
| 5 | +# [Cloud Memorystore for Memcached API: Nodejs Client][homepage] |
| 6 | + |
| 7 | +This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways |
| 8 | +unless absolutely necessary (e.g. because of critical security issues) or with |
| 9 | +an extensive deprecation period. Issues and requests against **stable** libraries |
| 10 | +are addressed with the highest priority |
| 11 | + |
| 12 | +[](https://www.npmjs.org/package/@google-cloud/memcache) |
| 13 | + |
| 14 | +Cloud Memorystore for Memcached API client for Node.js |
| 15 | + |
| 16 | +[//]: # "partials.introduction" |
| 17 | + |
| 18 | +A comprehensive list of changes in each version may be found in |
| 19 | +[the CHANGELOG][homepage_changelog]. |
| 20 | + |
| 21 | +* [Cloud Memorystore for Memcached API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/memcache/latest) |
| 22 | + |
| 23 | + |
| 24 | +Read more about the client libraries for Cloud APIs, including the older |
| 25 | +Google APIs Client Libraries, in [Client Libraries Explained][explained]. |
| 26 | + |
| 27 | +[explained]: https://cloud.google.com/apis/docs/client-libraries-explained |
| 28 | + |
| 29 | +**Table of contents:** |
| 30 | + |
| 31 | +* [Quickstart](#quickstart) |
| 32 | + * [Before you begin](#before-you-begin) |
| 33 | + * [Installing the client library](#installing-the-client-library) |
| 34 | + |
| 35 | +* [Versioning](#versioning) |
| 36 | +* [Contributing](#contributing) |
| 37 | +* [License](#license) |
| 38 | + |
| 39 | +## Quickstart |
| 40 | +### Before you begin |
| 41 | + |
| 42 | +1. [Select or create a Cloud Platform project][projects]. |
| 43 | +1. [Enable billing for your project][billing]. |
| 44 | +1. [Enable the Cloud Memorystore for Memcached API API][enable_api]. |
| 45 | +1. [Set up authentication][auth] so you can access the |
| 46 | + API from your local workstation. |
| 47 | +### Installing the client library |
| 48 | + |
| 49 | +```bash |
| 50 | +npm install @google-cloud/memcache |
| 51 | +``` |
| 52 | + |
| 53 | +[//]: # "partials.body" |
| 54 | + |
| 55 | +## Samples |
| 56 | + |
| 57 | +Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample. |
| 58 | + |
| 59 | +| Sample | Source Code | |
| 60 | +| --------------------------- | --------------------------------- | |
| 61 | +| apply parameters | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1/cloud_memcache.apply_parameters.js) | |
| 62 | +| create instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1/cloud_memcache.create_instance.js) | |
| 63 | +| delete instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1/cloud_memcache.delete_instance.js) | |
| 64 | +| get instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1/cloud_memcache.get_instance.js) | |
| 65 | +| list instances | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1/cloud_memcache.list_instances.js) | |
| 66 | +| reschedule maintenance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1/cloud_memcache.reschedule_maintenance.js) | |
| 67 | +| update instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1/cloud_memcache.update_instance.js) | |
| 68 | +| update parameters | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1/cloud_memcache.update_parameters.js) | |
| 69 | +| cloud | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1/snippet_metadata_google.cloud.memcache.v1.json) | |
| 70 | +| apply parameters | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1beta2/cloud_memcache.apply_parameters.js) | |
| 71 | +| apply software update | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1beta2/cloud_memcache.apply_software_update.js) | |
| 72 | +| create instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1beta2/cloud_memcache.create_instance.js) | |
| 73 | +| delete instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1beta2/cloud_memcache.delete_instance.js) | |
| 74 | +| get instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1beta2/cloud_memcache.get_instance.js) | |
| 75 | +| list instances | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1beta2/cloud_memcache.list_instances.js) | |
| 76 | +| reschedule maintenance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1beta2/cloud_memcache.reschedule_maintenance.js) | |
| 77 | +| update instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1beta2/cloud_memcache.update_instance.js) | |
| 78 | +| update parameters | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1beta2/cloud_memcache.update_parameters.js) | |
| 79 | +| cloud | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples/generated/v1beta2/snippet_metadata_google.cloud.memcache.v1beta2.json) | |
| 80 | + |
| 81 | + |
| 82 | +## Supported Node.js Versions |
| 83 | + |
| 84 | +Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule). |
| 85 | +Libraries are compatible with all current _active_ and _maintenance_ versions of |
| 86 | +Node.js. |
| 87 | +If you are using an end-of-life version of Node.js, we recommend that you update |
| 88 | +as soon as possible to an actively supported LTS version. |
| 89 | + |
| 90 | +Google's client libraries support legacy versions of Node.js runtimes on a |
| 91 | +best-efforts basis with the following warnings: |
| 92 | + |
| 93 | +* Legacy versions are not tested in continuous integration. |
| 94 | +* Some security patches and features cannot be backported. |
| 95 | +* Dependencies cannot be kept up-to-date. |
| 96 | + |
| 97 | +Client libraries targeting some end-of-life versions of Node.js are available, and |
| 98 | +can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag). |
| 99 | +The dist-tags follow the naming convention `legacy-(version)`. |
| 100 | +For example, `npm install @google-cloud/memcache@legacy-8` installs client libraries |
| 101 | +for versions compatible with Node.js 8. |
| 102 | + |
| 103 | +## Versioning |
| 104 | + |
| 105 | +This library follows [Semantic Versioning](http://semver.org/). |
| 106 | + |
| 107 | +More Information: [Google Cloud Platform Launch Stages][launch_stages] |
| 108 | + |
| 109 | +[launch_stages]: https://cloud.google.com/terms/launch-stages |
| 110 | + |
| 111 | +## Contributing |
| 112 | + |
| 113 | +Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md). |
| 114 | + |
| 115 | +Please note that this `README.md` |
| 116 | +and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`) |
| 117 | +are generated from a central template. |
| 118 | + |
| 119 | +## License |
| 120 | + |
| 121 | +Apache Version 2.0 |
| 122 | + |
| 123 | +See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE) |
| 124 | + |
| 125 | +[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png |
| 126 | +[projects]: https://console.cloud.google.com/project |
| 127 | +[billing]: https://support.google.com/cloud/answer/6293499#enable-billing |
| 128 | +[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=memcache.googleapis.com |
| 129 | +[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local |
| 130 | +[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/samples |
| 131 | +[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache/CHANGELOG.md |
| 132 | +[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-memcache |
0 commit comments