Recommender: Node.js Client

Recommender 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
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project .
Enable billing for your project .
Enable the Recommender API .
Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

 npm install @google-cloud/recommender

Using the client library

 async function listRecommendations() {
  const {RecommenderClient} = require(' @google-cloud/recommender 
');
  const recommender = new RecommenderClient 
();

  // parent = 'projects/my-project'; // Project to fetch recommendations for.
  // recommenderId = 'google.compute.instance.MachineTypeRecommender';

  const [recommendations] = await recommender.listRecommendations({
    parent: recommender.projectLocationRecommenderPath(
      project,
      'global',
      recommenderId
    ),
  });
  console.info(`recommendations for ${recommenderId}:`);
  for (const recommendation of recommendations) {
    console.info(recommendation);
  }
  return recommendations;
}
const recommendations = await listRecommendations();

Samples

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

Sample	Source Code	Try it
Recommender.get_insight	source code
Recommender.get_insight_type_config	source code
Recommender.get_recommendation	source code
Recommender.get_recommender_config	source code
Recommender.list_insights	source code
Recommender.list_recommendations	source code
Recommender.mark_insight_accepted	source code
Recommender.mark_recommendation_claimed	source code
Recommender.mark_recommendation_dismissed	source code
Recommender.mark_recommendation_failed	source code
Recommender.mark_recommendation_succeeded	source code
Recommender.update_insight_type_config	source code
Recommender.update_recommender_config	source code
Recommender.get_insight	source code
Recommender.get_insight_type_config	source code
Recommender.get_recommendation	source code
Recommender.get_recommender_config	source code
Recommender.list_insight_types	source code
Recommender.list_insights	source code
Recommender.list_recommendations	source code
Recommender.list_recommenders	source code
Recommender.mark_insight_accepted	source code
Recommender.mark_recommendation_claimed	source code
Recommender.mark_recommendation_failed	source code
Recommender.mark_recommendation_succeeded	source code
Recommender.update_insight_type_config	source code
Recommender.update_recommender_config	source code
Quickstart	source code

The Recommender Node.js Client API Reference 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/recommender@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

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 stablelibraries are addressed with the highest priority.

More Information: Google Cloud Platform 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