Cloud Asset Inventory: Node.js Client
Cloud Asset API client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG .
- Cloud Asset Inventory Node.js Client API Reference
- Cloud Asset Inventory Documentation
- github.com/googleapis/google-cloud-node/packages/google-cloud-asset
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
- Select or create a Cloud Platform project .
- Enable billing for your project .
- Enable the Cloud Asset Inventory 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/asset
Using the client library
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
// const assetTypes = 'storage.googleapis.com/Bucket,bigquery.googleapis.com/Table';
// const contentType = 'RESOURCE';
const util = require('util');
const {v1} = require(' @google-cloud/asset
');
const client = new v1. AssetServiceClient
();
const projectResource = `projects/${projectId}`;
// TODO(developer): Choose types of assets to list, such as 'storage.googleapis.com/Bucket':
// const assetTypes = 'storage.googleapis.com/Bucket,bigquery.googleapis.com/Table';
// Or simply use empty string to list all types of assets:
// const assetTypes = '';
const assetTypesList = assetTypes ? assetTypes.split(',') : [];
async function listAssets() {
const request = {
parent: projectResource,
assetTypes: assetTypesList,
contentType: contentType,
// (Optional) Add readTime parameter to list assets at the given time instead of current time:
// readTime: { seconds: 1593988758 },
};
// Call cloud.assets.v1.ListAssets API.
const result = await client.listAssets(request);
// Handle the response.
console.log(util.inspect(result, {depth: null}));
}
listAssets();
Samples
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
Sample | Source Code | Try it |
---|---|---|
Asset_service.analyze_iam_policy
|
source code | ![]() |
Asset_service.analyze_iam_policy_longrunning
|
source code | ![]() |
Asset_service.analyze_move
|
source code | ![]() |
Asset_service.analyze_org_policies
|
source code | ![]() |
Asset_service.analyze_org_policy_governed_assets
|
source code | ![]() |
Asset_service.analyze_org_policy_governed_containers
|
source code | ![]() |
Asset_service.batch_get_assets_history
|
source code | ![]() |
Asset_service.batch_get_effective_iam_policies
|
source code | ![]() |
Asset_service.create_feed
|
source code | ![]() |
Asset_service.create_saved_query
|
source code | ![]() |
Asset_service.delete_feed
|
source code | ![]() |
Asset_service.delete_saved_query
|
source code | ![]() |
Asset_service.export_assets
|
source code | ![]() |
Asset_service.get_feed
|
source code | ![]() |
Asset_service.get_saved_query
|
source code | ![]() |
Asset_service.list_assets
|
source code | ![]() |
Asset_service.list_feeds
|
source code | ![]() |
Asset_service.list_saved_queries
|
source code | ![]() |
Asset_service.query_assets
|
source code | ![]() |
Asset_service.search_all_iam_policies
|
source code | ![]() |
Asset_service.search_all_resources
|
source code | ![]() |
Asset_service.update_feed
|
source code | ![]() |
Asset_service.update_saved_query
|
source code | ![]() |
Asset_service.search_all_iam_policies
|
source code | ![]() |
Asset_service.search_all_resources
|
source code | ![]() |
Asset_service.create_feed
|
source code | ![]() |
Asset_service.delete_feed
|
source code | ![]() |
Asset_service.get_feed
|
source code | ![]() |
Asset_service.list_feeds
|
source code | ![]() |
Asset_service.update_feed
|
source code | ![]() |
Asset_service.analyze_iam_policy
|
source code | ![]() |
Asset_service.export_iam_policy_analysis
|
source code | ![]() |
Asset_service.list_assets
|
source code | ![]() |
Asset_service.export_assets
|
source code | ![]() |
List Assets
|
source code | ![]() |
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 stablelibraries 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