@google-cloud/chronicle v0.1.0

Chronicle API: Node.js Client

Chronicle API client for Node.js

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

• Chronicle API Node.js Client API Reference
• Chronicle API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-chronicle

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 Chronicle API API.
4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/chronicle

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 resource name of the reference list to retrieve.
 *  Format:
 *  `projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}`
 */
// const name = 'abc123'
/**
 *  How much of the ReferenceList to view. Defaults to
 *  REFERENCE_LIST_VIEW_FULL.
 */
// const view = {}

// Imports the Chronicle library
const {ReferenceListServiceClient} = require('@google-cloud/chronicle').v1;

// Instantiates a client
const chronicleClient = new ReferenceListServiceClient();

async function callGetReferenceList() {
  // Construct request
  const request = {
    name,
  };

  // Run request
  const response = await chronicleClient.getReferenceList(request);
  console.log(response);
}

callGetReferenceList();

Samples

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

Sample	Source Code	Try it
Data_access_control_service.create_data_access_label	source code
Data_access_control_service.create_data_access_scope	source code
Data_access_control_service.delete_data_access_label	source code
Data_access_control_service.delete_data_access_scope	source code
Data_access_control_service.get_data_access_label	source code
Data_access_control_service.get_data_access_scope	source code
Data_access_control_service.list_data_access_labels	source code
Data_access_control_service.list_data_access_scopes	source code
Data_access_control_service.update_data_access_label	source code
Data_access_control_service.update_data_access_scope	source code
Entity_service.create_watchlist	source code
Entity_service.delete_watchlist	source code
Entity_service.get_watchlist	source code
Entity_service.list_watchlists	source code
Entity_service.update_watchlist	source code
Instance_service.get_instance	source code
Reference_list_service.create_reference_list	source code
Reference_list_service.get_reference_list	source code
Reference_list_service.list_reference_lists	source code
Reference_list_service.update_reference_list	source code
Rule_service.create_retrohunt	source code
Rule_service.create_rule	source code
Rule_service.delete_rule	source code
Rule_service.get_retrohunt	source code
Rule_service.get_rule	source code
Rule_service.get_rule_deployment	source code
Rule_service.list_retrohunts	source code
Rule_service.list_rule_deployments	source code
Rule_service.list_rule_revisions	source code
Rule_service.list_rules	source code
Rule_service.update_rule	source code
Rule_service.update_rule_deployment	source code
Quickstart	source code

The Chronicle 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/chronicle@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