Advisory Notifications API: Node.js Client

Advisory Notifications API client for Node.js

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

• Advisory Notifications API Node.js Client API Reference
• Advisory Notifications API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-advisorynotifications

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
  • 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 Advisory Notifications API API .
4. 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/advisorynotifications 

Using the client library

 /**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent, which owns this collection of notifications.
 *  Must be of the form "organizations/{organization}/locations/{location}".
 */
// const parent = 'abc123'
/**
 *  The maximum number of notifications to return. The service may return
 *  fewer than this value. If unspecified or equal to 0, at most 50
 *  notifications will be returned. The maximum value is 50; values above 50
 *  will be coerced to 50.
 */
// const pageSize = 1234
/**
 *  A page token returned from a previous request.
 *  When paginating, all other parameters provided in the request
 *  must match the call that returned the page token.
 */
// const pageToken = 'abc123'
/**
 *  Specifies which parts of the notification resource should be returned
 *  in the response.
 */
// const view = {}
/**
 *  ISO code for requested localization language.  If unset, will be
 *  interpereted as "en". If the requested language is valid, but not supported
 *  for this notification, English will be returned with an "Not applicable"
 *  LocalizationState. If the ISO code is invalid (i.e. not a real language),
 *  this RPC will throw an error.
 */
// const languageCode = 'abc123'

// Imports the Advisorynotifications library
const {AdvisoryNotificationsServiceClient} =
  require(' @google-cloud/advisorynotifications 
').v1;

// Instantiates a client
const advisorynotificationsClient = new AdvisoryNotificationsServiceClient 
();

async function callListNotifications() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable =
    await advisorynotificationsClient. listNotificationsAsync 
(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListNotifications(); 

Samples

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

Sample	Source Code	Try it
Advisory_notifications_service.get_notification	source code
Advisory_notifications_service.get_settings	source code
Advisory_notifications_service.list_notifications	source code
Advisory_notifications_service.update_settings	source code
Quickstart	source code

The Advisory Notifications API 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/advisorynotifications@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

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