automancursor / nodejs-resource

Node.js client for Google Cloud Resource Manager: Hierarchically manage resources by project, folder, and organization.

Google Cloud Resource Manager API: Node.js Client

Node.js idiomatic client for Cloud Resource Manager API.

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 Reference
• Google Cloud Resource Manager API Documentation
• github.com/googleapis/nodejs-resource

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
  • 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 Google Cloud Resource Manager API 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/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
Quickstart	source code

The Google Cloud Resource Manager API 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