This module has been deprecated.
Note: The Stackdriver Incident Response and Management module has been deprecated and the corresponding API has been shutdown.
Stackdriver Incident Response & Management: Node.js Client
Stackdriver Incident Response is currently in private alpha, visit cloud.google.com/incident-response to sign up.
A comprehensive list of changes in each version may be found in the CHANGELOG.
- Stackdriver Incident Response & Management Node.js Client API Reference
- Stackdriver Incident Response & Management Documentation
- github.com/googleapis/nodejs-irm
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
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Stackdriver Incident Response & Management 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/irm
Samples
Samples are in the samples/
directory. The samples' README.md
has instructions for running the samples.
Sample | Source Code | Try it |
---|---|---|
Annotate Incident | source code | |
Change Severity | source code | |
Change Stage | source code | |
Create Incident | source code | |
Create Signal | source code |
The Stackdriver Incident Response & Management 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.
Client libraries targetting some end-of-life versions of Node.js are available, and
can be installed via npm dist-tags.
The dist-tags follow the naming convention legacy-(version)
.
Legacy Node.js versions are supported as a best effort:
- Legacy versions will not be tested in continuous integration.
- Some security patches may not be able to be backported.
- Dependencies will not be kept up-to-date, and features will not be backported.
Legacy tags available
legacy-8
: install client libraries from this dist-tag for versions compatible with Node.js 8.
Versioning
This library follows Semantic Versioning.
This library is considered to be in alpha. 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 template in this
directory.
License
Apache Version 2.0
See LICENSE