Chronicle API: Nodejs Client

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.

Chronicle 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
- Before you begin
- Installing the client library
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Chronicle API API.
Set up authentication so you can access the API from your local workstation.

Installing the client library

bash

npm install @google-cloud/chronicle

Samples

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

Sample	Source Code
create data access label	source code
create data access scope	source code
delete data access label	source code
delete data access scope	source code
get data access label	source code
get data access scope	source code
list data access labels	source code
list data access scopes	source code
update data access label	source code
update data access scope	source code
create watchlist	source code
delete watchlist	source code
get watchlist	source code
list watchlists	source code
update watchlist	source code
get instance	source code
create reference list	source code
get reference list	source code
list reference lists	source code
update reference list	source code
create retrohunt	source code
create rule	source code
delete rule	source code
get retrohunt	source code
get rule	source code
get rule deployment	source code
list retrohunts	source code
list rule deployments	source code
list rule revisions	source code
list rules	source code
update rule	source code
update rule deployment	source code
cloud	source code

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/chronicle@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE

[Chronicle API: Nodejs Client][homepage]