Stackdriver Incident Response & Management API client for Node.js
npm install @google-cloud/irm[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "To regenerate it, use python -m synthtool."
_Note: The Stackdriver Incident Response and Management module has been
deprecated and the corresponding API has been shutdown._



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][client-docs]
* [Stackdriver Incident Response & Management Documentation][product-docs]
* 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][explained].
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
Table of contents:
* Quickstart
* Before you begin
* Installing the client library
* Samples
* Versioning
* Contributing
* License
1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the Stackdriver Incident Response & Management API][enable_api].
1. [Set up authentication with a service account][auth] so you can access the
API from your local workstation.
``bash`
npm install @google-cloud/irm
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 | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-irm&page=editor&open_in_editor=samples/annotateIncident.js,samples/README.md) |
| Change Severity | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-irm&page=editor&open_in_editor=samples/changeSeverity.js,samples/README.md) |
| Change Stage | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-irm&page=editor&open_in_editor=samples/changeStage.js,samples/README.md) |
| Create Incident | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-irm&page=editor&open_in_editor=samples/createIncident.js,samples/README.md) |
| Create Signal | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-irm&page=editor&open_in_editor=samples/createSignal.js,samples/README.md) |
The [Stackdriver Incident Response & Management Node.js Client API Reference][client-docs] documentation
also contains samples.
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.
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][launch_stages]
[launch_stages]: https://cloud.google.com/terms/launch-stages
Contributions welcome! See the Contributing Guide.
Please note that this README.md, the samples/README.md,.nycrc
and a variety of configuration files in this repository (including and tsconfig.json`)
are generated from a central template. To edit one of these files, make an edit
to its template in this
directory.
Apache Version 2.0
See LICENSE
[client-docs]: https://googleapis.dev/nodejs/irm/latest
[product-docs]: https://cloud.google.com/incident-response
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=irm.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/getting-started