Storage Insights API: Node.js Client

Storage Insights API client for Node.js

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

• Storage Insights API Node.js Client API Reference
• Storage Insights API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-storageinsights

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient 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 Storage Insights API API.
4. Set up authentication so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/storageinsights

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. Parent value for ListReportConfigsRequest */// const parent = 'abc123'/** *  Requested page size. Server may return fewer items than requested. *  If unspecified, server will pick an appropriate default. */// const pageSize = 1234/** *  A token identifying a page of results the server should return. */// const pageToken = 'abc123'/** *  Filtering results */// const filter = 'abc123'/** *  Hint for how to order the results */// const orderBy = 'abc123'// Imports the Storageinsights libraryconst {StorageInsightsClient} = require('@google-cloud/storageinsights').v1;// Instantiates a clientconst storageinsightsClient = newStorageInsightsClient();async function callListReportConfigs() {  // Construct request  const request = {    parent,  };  // Run request  const iterable =    await storageinsightsClient.listReportConfigsAsync(request);  for await (const response of iterable) {    console.log(response);  }}callListReportConfigs();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

Sample	Source Code	Try it
Storage_insights.create_dataset_config	source code
Storage_insights.create_report_config	source code
Storage_insights.delete_dataset_config	source code
Storage_insights.delete_report_config	source code
Storage_insights.get_dataset_config	source code
Storage_insights.get_report_config	source code
Storage_insights.get_report_detail	source code
Storage_insights.link_dataset	source code
Storage_insights.list_dataset_configs	source code
Storage_insights.list_report_configs	source code
Storage_insights.list_report_details	source code
Storage_insights.unlink_dataset	source code
Storage_insights.update_dataset_config	source code
Storage_insights.update_report_config	source code
Quickstart	source code

TheStorage Insights API Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/storageinsights@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE