Google Cloud Platform logo

Cloud Asset Inventory: Node.js Client

release level npm version codecov

Cloud Asset API client for Node.js

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 = client.projectPath(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. The samples' README.md has instructions for running the samples.

Sample Source Code Try it
Export Assets source code Open in Cloud Shell
Get Batch Asset History source code Open in Cloud Shell
Asset History Quickstart source code Open in Cloud Shell

The Cloud Asset Inventory Node.js Client API Reference documentation also contains samples.

Versioning

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

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE