@google-cloud/resource

Node.js idiomatic client for Cloud Resource Manager APIproduct-docs.

Google Cloud Platform provides container resources such as Organizations and Projects, that allow you to group and hierarchically organize other Cloud Platform resources. This hierarchical organization lets you easily manage common aspects of your resources such as access control and configuration settings. The Cloud Resource Manager API enables you to programmatically manage these container resources.

• Google Cloud Resource Manager API Node.js Client API Referenceclient-docs
• Google Cloud Resource Manager API Documentationproduct-docs
• github.com/googleapis/nodejs-resource

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explainedexplained.
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 projectprojects.
2. Enable billing for your projectbilling.
3. Enable the Google Cloud Resource Manager API APIenableapi.
4. Set up authentication with a service accountauth so you can access the

API from your local workstation.

Installing the client library

npm install @google-cloud/resource

Using the client library

// Imports the Google Cloud client library
const {Resource} = require('@google-cloud/resource');

// Creates a client
const resource = new Resource();

async function quickstart() {
  // Lists current projects
  const [projects] = await resource.getProjects();

  console.log('Projects:');
  projects.forEach(project => console.log(project.id));
}
quickstart();

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.
| Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | List Projects | source code | !Open in Cloud Shellshellimg | | Quickstart | source code | !Open in Cloud Shellshellimg |
The Google Cloud Resource Manager API Node.js Client API Referenceclient-docs 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.
Client libraries targetting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).
Legacy Node.js versions are supported as a best effort:

• Legacy versions will not be tested in continuous integration.
• Some security patches may not be able to be backported.
• Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

• legacy-8: install client libraries from this dist-tag for versions

compatible with Node.js 8.

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 Stageslaunchstages

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 template in this directory.

License

Apache Version 2.0
See LICENSE