Negligible Psychological Misery
    Have ideas to improve npm?Join in the discussion! »

    @google-cloud/compute

    2.5.1 • Public • Published

    Google Cloud Platform logo

    Google Compute Engine: Node.js Client

    release level npm version codecov

    Google Compute Engine Client Library 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 Google Compute Engine 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/compute

    Using the client library

    // Imports the Google Cloud client library
    const Compute = require('@google-cloud/compute');
    
    // Creates a client
    const compute = new Compute();
    
    async function quickstart() {
      // Create a new VM using the latest OS image of your choice.
      const zone = compute.zone('us-central1-c');
    
      // TODO(developer): choose a name for the VM
      // const vmName = 'vm-name';
    
      // Start the VM create task
      const [vm, operation] = await zone.createVM(vmName, {os: 'ubuntu'});
      console.log(vm);
    
      // `operation` lets you check the status of long-running tasks.
      await operation.promise();
    
      // Complete!
      console.log('Virtual machine created!');
    }
    quickstart();

    Samples

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

    Sample Source Code Try it
    Create VM source code Open in Cloud Shell
    Delete VM source code Open in Cloud Shell
    List VMs source code Open in Cloud Shell
    Mailjet source code Open in Cloud Shell
    Quickstart source code Open in Cloud Shell
    Sendgrid source code Open in Cloud Shell
    Startup Script source code Open in Cloud Shell
    Vms source code Open in Cloud Shell

    The Google Compute Engine 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 template in this directory.

    License

    Apache Version 2.0

    See LICENSE

    Install

    npm i @google-cloud/compute

    DownloadsWeekly Downloads

    20,037

    Version

    2.5.1

    License

    Apache-2.0

    Unpacked Size

    445 kB

    Total Files

    24

    Last publish

    Collaborators

    • avatar