Back to Google Cloud Node

[Storage Control API: Nodejs Client][homepage]

packages/google-storage-control/README.md

0.57.011.1 KB
Original Source

Storage Control API: Nodejs Client

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.

Storage Control 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 Storage Control API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

bash
npm install @google-cloud/storage-control

Samples

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

SampleSource Code
storagesource code
storagesource code
create bucketsource code
delete bucketsource code
get bucketsource code
list bucketssource code
lock bucket retention policysource code
update bucketsource code
create anywhere cachesource code
create foldersource code
create managed foldersource code
delete foldersource code
delete folder recursivesource code
delete managed foldersource code
disable anywhere cachesource code
get anywhere cachesource code
get foldersource code
get folder intelligence configsource code
get iam policysource code
get managed foldersource code
get organization intelligence configsource code
get project intelligence configsource code
get storage layoutsource code
list anywhere cachessource code
list folderssource code
list managed folderssource code
pause anywhere cachesource code
rename foldersource code
resume anywhere cachesource code
set iam policysource code
test iam permissionssource code
update anywhere cachesource code
update folder intelligence configsource code
update organization intelligence configsource code
update project intelligence configsource code

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/storage-control@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE