Recommender: Node.js Client

Recommender client for Node.js

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

• Recommender Node.js Client API Reference
• Recommender Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-recommender

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
  • Using 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 Recommender API.
4. Set up authentication so you can access theAPI 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 = newRecommenderClient();  // 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 thesamples/ directory. Each sample'sREADME.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

TheRecommender 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/recommender@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

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