@google-cloud/resource-manager
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    Google Cloud Platform logo

    Google Cloud Resource Manager API: Node.js Client

    release level npm version codecov

    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.

    IMPORTANT NOTE

    Version 2.0.0 renames @google-cloud/resource to @google-cloud/resource-manager on npm.

    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 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-manager

    Using the client library

    // Imports the Google Cloud client library
    const {ProjectsClient} = require('@google-cloud/resource-manager');
    
    // Creates a client
    const client = new ProjectsClient();
    
    async function quickstart() {
      // Lists current projects
      const projects = client.searchProjectsAsync();
      console.log('Projects:');
      for await (const project of projects) {
        console.info(project);
      }
    }
    quickstart();

    Samples

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

    Sample Source Code Try it
    List Projects source code Open in Cloud Shell
    Quickstart source code Open in Cloud Shell

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

    Client libraries targeting 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 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

    Install

    npm i @google-cloud/resource-manager

    DownloadsWeekly Downloads

    2,164

    Version

    3.0.0

    License

    Apache-2.0

    Unpacked Size

    3.42 MB

    Total Files

    43

    Last publish

    Collaborators

    • ofrobots
    • google-wombot
    • google-admin
    • soldair