[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "To regenerate it, use python -m synthtool."

Capacity Planner API: Node.js Client


Capacity Planner API client for Node.js

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

* [Capacity Planner API Node.js Client API Reference][client-docs]
* [Capacity Planner API Documentation][product-docs]
* github.com/googleapis/google-cloud-node/packages/google-cloud-capacityplanner

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

[explained]: https://cloud.google.com/apis/docs/client-libraries-explained

Table of contents:

* Quickstart
* Before you begin
* Installing the client library

* Samples
* Versioning
* Contributing
* License

Quickstart

$3

1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the Capacity Planner API API][enable_api].
1. [Set up authentication][auth] so you can access the
API from your local workstation.

$3

``bash
npm install @google-cloud/capacityplanner
`

Samples

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

| Sample | Source Code | Try it |
| --------------------------- | --------------------------------- | ------ |
| Capacity_planning_service.get_capacity_plan | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-capacityplanner/samples/generated/v1beta/capacity_planning_service.get_capacity_plan.js,packages/google-cloud-capacityplanner/samples/README.md) |
| Capacity_planning_service.query_capacity_plan_insights | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-capacityplanner/samples/generated/v1beta/capacity_planning_service.query_capacity_plan_insights.js,packages/google-cloud-capacityplanner/samples/README.md) |
| Capacity_planning_service.query_capacity_plans | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-capacityplanner/samples/generated/v1beta/capacity_planning_service.query_capacity_plans.js,packages/google-cloud-capacityplanner/samples/README.md) |
| Usage_service.export_forecasts | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-capacityplanner/samples/generated/v1beta/usage_service.export_forecasts.js,packages/google-cloud-capacityplanner/samples/README.md) |
| Usage_service.export_reservations_usage | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-capacityplanner/samples/generated/v1beta/usage_service.export_reservations_usage.js,packages/google-cloud-capacityplanner/samples/README.md) |
| Usage_service.export_usage_histories | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-capacityplanner/samples/generated/v1beta/usage_service.export_usage_histories.js,packages/google-cloud-capacityplanner/samples/README.md) |
| Usage_service.query_forecasts | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-capacityplanner/samples/generated/v1beta/usage_service.query_forecasts.js,packages/google-cloud-capacityplanner/samples/README.md) |
| Usage_service.query_reservations | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-capacityplanner/samples/generated/v1beta/usage_service.query_reservations.js,packages/google-cloud-capacityplanner/samples/README.md) |
| Usage_service.query_usage_histories | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-capacityplanner/samples/generated/v1beta/usage_service.query_usage_histories.js,packages/google-cloud-capacityplanner/samples/README.md) |

The [Capacity Planner API Node.js Client API Reference][client-docs] documentation
also contains samples.

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/capacityplanner@legacy-8 installs client libraries
for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be in preview. This means it is still a
work-in-progress and under active development. Any release is subject to
backwards-incompatible changes at any time.


More Information: [Google Cloud Platform Launch Stages][launch_stages]

[launch_stages]: https://cloud.google.com/terms/launch-stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md,
and a variety of configuration files in this repository (including .nycrc and tsconfig.json`)
are generated from a central template. To edit one of these files, make an edit
to its templates in
directory.

License

Apache Version 2.0

See LICENSE

[client-docs]: https://cloud.google.com/nodejs/docs/reference/capacityplanner/latest
[product-docs]: https://cloud.google.com/capacity-planner/docs
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=capacityplanner.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local

[//]: # "partials.introduction"