Stay organized with collections Save and categorize content based on your preferences.

Cloud Asset Inventory: Node.js Client

release level npm version

Cloud Asset 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

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Cloud Asset Inventory API.
  4. 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/asset

Using the client library

const util = require('util');
const {AssetServiceClient} = require('@google-cloud/asset');

const client = new AssetServiceClient();

async function quickstart() {
  const projectId = await client.getProjectId();
  const projectResource = `projects/${projectId}`;
  // TODO(developer): Choose asset names, such as //storage.googleapis.com/[YOUR_BUCKET_NAME].
  // const assetNames = ['ASSET_NAME1', 'ASSET_NAME2', ...];

  const request = {
    parent: projectResource,
    assetNames: assetNames.split(','),
    contentType: 'RESOURCE',
    readTimeWindow: {
      startTime: {
        seconds: Math.floor(new Date().getTime() / 1000),
      },
    },
  };

  // Handle the operation using the promise pattern.
  const result = await client.batchGetAssetsHistory(request);
  // Do things with with the response.
  console.log(util.inspect(result, {depth: null}));

Samples

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

SampleSource CodeTry it
Analyze Iam Policysource codeOpen in Cloud Shell
Analyze Iam Policy Longrunning and write results to Bigquerysource codeOpen in Cloud Shell
Analyze Iam Policy Longrunning and write results to GCSsource codeOpen in Cloud Shell
Create Feedsource codeOpen in Cloud Shell
Delete Feedsource codeOpen in Cloud Shell
Export Assetssource codeOpen in Cloud Shell
Export Assets To BigQuerysource codeOpen in Cloud Shell
Get Batch Asset Historysource codeOpen in Cloud Shell
Batch Get Effective Iam Policiessource codeOpen in Cloud Shell
Get Feedsource codeOpen in Cloud Shell
List Assetssource codeOpen in Cloud Shell
List Feedssource codeOpen in Cloud Shell
Asset History Quickstartsource codeOpen in Cloud Shell
Search All Iam Policiessource codeOpen in Cloud Shell
Search All Resourcessource codeOpen in Cloud Shell
Update Feedsource codeOpen in Cloud Shell

The Cloud Asset Inventory 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/asset@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

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