Service Health API: Node.js Client

Service Health API 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 Service Health API 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/servicehealth

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. Parent value using the form
 *  `projects/{project_id}/locations/{location}/events`.
 *  `project_id` - ID of the project for which to list service health
 *  events.
 *  `location` - The location to get the service health events from.
 *  To retrieve service health events of category = INCIDENT, use `location` =
 *  `global`.
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of events that should be returned.  Acceptable
 *  values are 1 to 100, inclusive. (The default value is 10.) If more results
 *  are available, the service returns a next_page_token that you can use to
 *  get the next page of results in subsequent list requests. The service may
 *  return fewer events than the requested page_size.
 */
// const pageSize = 1234
/**
 *  Optional. A token identifying a page of results the server should return.
 *  Provide Page token returned by a previous `ListEvents` call to retrieve the
 *  next page of results. When paginating, all other parameters provided to
 *  `ListEvents` must match the call that provided the page token.
 */
// const pageToken = 'abc123'
/**
 *  Optional. A filter expression that filters resources listed in the
 *  response. The expression takes the following forms: <br>
 *  *   field=value for `category` and `state`<br>
 *  *   field <, >, <=, or >= value for `update_time` <br>
 *  Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
 *  <br>
 *  Multiple filter queries are separated by spaces. Example:
 *  `category=INCIDENT state=ACTIVE`.
 *  By default, each expression is an AND expression. However, you can include
 *  AND and OR expressions explicitly.
 *  Filter is supported for the following fields: `category`, `state`,
 *  `update_time`
 */
// const filter = 'abc123'
/**
 *  Optional. Event fields to include in response.
 */
// const view = {}

// Imports the Servicehealth library
const {ServiceHealthClient} = require('@google-cloud/servicehealth').v1;

// Instantiates a client
const servicehealthClient = new ServiceHealthClient();

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

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

callListEvents();

Samples

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

Sample	Source Code	Try it
Service_health.get_event	source code
Service_health.get_organization_event	source code
Service_health.get_organization_impact	source code
Service_health.list_events	source code
Service_health.list_organization_events	source code
Service_health.list_organization_impacts	source code
Quickstart	source code

The Service Health 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/servicehealth@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