@google-cloud/compute v4.4.0

Google Compute Engine: Node.js Client

Google Compute Engine Client Library for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

• Google Compute Engine Node.js Client API Reference
• Google Compute Engine Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-compute

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

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';

const compute = require('@google-cloud/compute');

// List all instances in the specified project.
async function listAllInstances() {
  const instancesClient = new compute.InstancesClient();

  //Use the `maxResults` parameter to limit the number of results that the API returns per response page.
  const aggListRequest = instancesClient.aggregatedListAsync({
    project: projectId,
    maxResults: 5,
  });

  console.log('Instances found:');

  // Despite using the `maxResults` parameter, you don't need to handle the pagination
  // yourself. The returned object handles pagination automatically,
  // requesting next pages as you iterate over the results.
  for await (const [zone, instancesObject] of aggListRequest) {
    const instances = instancesObject.instances;

    if (instances && instances.length > 0) {
      console.log(` ${zone}`);
      for (const instance of instances) {
        console.log(` - ${instance.name} (${instance.machineType})`);
      }
    }
  }
}

listAllInstances();

Samples

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

Sample	Source Code	Try it
Accelerator_types.aggregated_list	source code
Accelerator_types.get	source code
Accelerator_types.list	source code
Addresses.aggregated_list	source code
Addresses.delete	source code
Addresses.get	source code
Addresses.insert	source code
Addresses.list	source code
Addresses.move	source code
Addresses.set_labels	source code
Autoscalers.aggregated_list	source code
Autoscalers.delete	source code
Autoscalers.get	source code
Autoscalers.insert	source code
Autoscalers.list	source code
Autoscalers.patch	source code
Autoscalers.update	source code
Backend_buckets.add_signed_url_key	source code
Backend_buckets.delete	source code
Backend_buckets.delete_signed_url_key	source code
Backend_buckets.get	source code
Backend_buckets.get_iam_policy	source code
Backend_buckets.insert	source code
Backend_buckets.list	source code
Backend_buckets.patch	source code
Backend_buckets.set_edge_security_policy	source code
Backend_buckets.set_iam_policy	source code
Backend_buckets.test_iam_permissions	source code
Backend_buckets.update	source code
Backend_services.add_signed_url_key	source code
Backend_services.aggregated_list	source code
Backend_services.delete	source code
Backend_services.delete_signed_url_key	source code
Backend_services.get	source code
Backend_services.get_health	source code
Backend_services.get_iam_policy	source code
Backend_services.insert	source code
Backend_services.list	source code
Backend_services.list_usable	source code
Backend_services.patch	source code
Backend_services.set_edge_security_policy	source code
Backend_services.set_iam_policy	source code
Backend_services.set_security_policy	source code
Backend_services.test_iam_permissions	source code
Backend_services.update	source code
Disk_types.aggregated_list	source code
Disk_types.get	source code
Disk_types.list	source code
Disks.add_resource_policies	source code
Disks.aggregated_list	source code
Disks.bulk_insert	source code
Disks.create_snapshot	source code
Disks.delete	source code
Disks.get	source code
Disks.get_iam_policy	source code
Disks.insert	source code
Disks.list	source code
Disks.remove_resource_policies	source code
Disks.resize	source code
Disks.set_iam_policy	source code
Disks.set_labels	source code
Disks.start_async_replication	source code
Disks.stop_async_replication	source code
Disks.stop_group_async_replication	source code
Disks.test_iam_permissions	source code
Disks.update	source code
External_vpn_gateways.delete	source code
External_vpn_gateways.get	source code
External_vpn_gateways.insert	source code
External_vpn_gateways.list	source code
External_vpn_gateways.set_labels	source code
External_vpn_gateways.test_iam_permissions	source code
Firewall_policies.add_association	source code
Firewall_policies.add_rule	source code
Firewall_policies.clone_rules	source code
Firewall_policies.delete	source code
Firewall_policies.get	source code
Firewall_policies.get_association	source code
Firewall_policies.get_iam_policy	source code
Firewall_policies.get_rule	source code
Firewall_policies.insert	source code
Firewall_policies.list	source code
Firewall_policies.list_associations	source code
Firewall_policies.move	source code
Firewall_policies.patch	source code
Firewall_policies.patch_rule	source code
Firewall_policies.remove_association	source code
Firewall_policies.remove_rule	source code
Firewall_policies.set_iam_policy	source code
Firewall_policies.test_iam_permissions	source code
Firewalls.delete	source code
Firewalls.get	source code
Firewalls.insert	source code
Firewalls.list	source code
Firewalls.patch	source code
Firewalls.update	source code
Forwarding_rules.aggregated_list	source code
Forwarding_rules.delete	source code
Forwarding_rules.get	source code
Forwarding_rules.insert	source code
Forwarding_rules.list	source code
Forwarding_rules.patch	source code
Forwarding_rules.set_labels	source code
Forwarding_rules.set_target	source code
Global_addresses.delete	source code
Global_addresses.get	source code
Global_addresses.insert	source code
Global_addresses.list	source code
Global_addresses.move	source code
Global_addresses.set_labels	source code
Global_forwarding_rules.delete	source code
Global_forwarding_rules.get	source code
Global_forwarding_rules.insert	source code
Global_forwarding_rules.list	source code
Global_forwarding_rules.patch	source code
Global_forwarding_rules.set_labels	source code
Global_forwarding_rules.set_target	source code
Global_network_endpoint_groups.attach_network_endpoints	source code
Global_network_endpoint_groups.delete	source code
Global_network_endpoint_groups.detach_network_endpoints	source code
Global_network_endpoint_groups.get	source code
Global_network_endpoint_groups.insert	source code
Global_network_endpoint_groups.list	source code
Global_network_endpoint_groups.list_network_endpoints	source code
Global_operations.aggregated_list	source code
Global_operations.delete	source code
Global_operations.get	source code	[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-compute/samples/generated/v1/global_operations.get.js,packages/google-cloud-