Capacity Planner API: Node.js Client

Capacity Planner API client for Node.js

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

• Capacity Planner API Node.js Client API Reference
• Capacity Planner API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-capacityplanner

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

• 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 Capacity Planner API API.
4. Set up authentication so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/capacityplanner

Samples

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

Sample	Source Code	Try it
Capacity_planning_service.get_capacity_plan	source code
Capacity_planning_service.query_capacity_plan_insights	source code
Capacity_planning_service.query_capacity_plans	source code
Usage_service.export_forecasts	source code
Usage_service.export_reservations_usage	source code
Usage_service.export_usage_histories	source code
Usage_service.query_forecasts	source code
Usage_service.query_reservations	source code
Usage_service.query_usage_histories	source code

TheCapacity Planner 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/capacityplanner@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