ContextQMD
Back to Google Cloud Node

[Backup for GKE API: Nodejs Client][homepage]

packages/google-cloud-gkebackup/README.md

0.57.012.2 KB
Original Source

Backup for GKE API: Nodejs Client

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority

Backup for GKE API client for Node.js

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

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

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

Installing the client library

bash
npm install @google-cloud/gke-backup

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource Code
create backupsource code
create backup channelsource code
create backup plansource code
create restoresource code
create restore channelsource code
create restore plansource code
delete backupsource code
delete backup channelsource code
delete backup plansource code
delete restoresource code
delete restore channelsource code
delete restore plansource code
get backupsource code
get backup channelsource code
get backup index download urlsource code
get backup plansource code
get backup plan bindingsource code
get restoresource code
get restore channelsource code
get restore plansource code
get restore plan bindingsource code
get volume backupsource code
get volume restoresource code
list backup channelssource code
list backup plan bindingssource code
list backup planssource code
list backupssource code
list restore channelssource code
list restore plan bindingssource code
list restore planssource code
list restoressource code
list volume backupssource code
list volume restoressource code
update backupsource code
update backup channelsource code
update backup plansource code
update restoresource code
update restore channelsource code
update restore plansource code
cloudsource code

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-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, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/gke-backup@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE