KMS Inventory API: Node.js Client

Inventory 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 KMS Inventory 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/kms-inventory

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 Google Cloud project for which to retrieve key metadata, in
 *  the format `projects/*`
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of keys to return. The service may return
 *  fewer than this value. If unspecified, at most 1000 keys will be returned.
 *  The maximum value is 1000; values above 1000 will be coerced to 1000.
 */
// const pageSize = 1234
/**
 *  Optional. Pass this into a subsequent request in order to receive the next
 *  page of results.
 */
// const pageToken = 'abc123'

// Imports the Inventory library
const {KeyDashboardServiceClient} = require(' @google-cloud/kms-inventory 
').v1;

// Instantiates a client
const inventoryClient = new KeyDashboardServiceClient 
();

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

  // Run request
  const [response] = await inventoryClient.listCryptoKeys(request, {
    maxResults: 1,
    autoPaginate: false,
  });
  console.log(response);
}

callListCryptoKeys();

Samples

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

Sample	Source Code	Try it
Key_dashboard_service.list_crypto_keys	source code
Key_tracking_service.get_protected_resources_summary	source code
Key_tracking_service.search_protected_resources	source code
Quickstart	source code

The KMS Inventory 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/kms-inventory@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