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 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
Global_operations.list	source code
Global_operations.wait	source code
Global_organization_operations.delete	source code
Global_organization_operations.get	source code
Global_organization_operations.list	source code
Global_public_delegated_prefixes.delete	source code
Global_public_delegated_prefixes.get	source code
Global_public_delegated_prefixes.insert	source code
Global_public_delegated_prefixes.list	source code
Global_public_delegated_prefixes.patch	source code
Health_checks.aggregated_list	source code
Health_checks.delete	source code
Health_checks.get	source code
Health_checks.insert	source code
Health_checks.list	source code
Health_checks.patch	source code
Health_checks.update	source code
Image_family_views.get	source code
Images.delete	source code
Images.deprecate	source code
Images.get	source code
Images.get_from_family	source code
Images.get_iam_policy	source code
Images.insert	source code
Images.list	source code
Images.patch	source code
Images.set_iam_policy	source code
Images.set_labels	source code
Images.test_iam_permissions	source code
Instance_group_manager_resize_requests.cancel	source code
Instance_group_manager_resize_requests.delete	source code
Instance_group_manager_resize_requests.get	source code
Instance_group_manager_resize_requests.insert	source code
Instance_group_manager_resize_requests.list	source code
Instance_group_managers.abandon_instances	source code
Instance_group_managers.aggregated_list	source code
Instance_group_managers.apply_updates_to_instances	source code
Instance_group_managers.create_instances	source code
Instance_group_managers.delete	source code
Instance_group_managers.delete_instances	source code
Instance_group_managers.delete_per_instance_configs	source code
Instance_group_managers.get	source code
Instance_group_managers.insert	source code
Instance_group_managers.list	source code
Instance_group_managers.list_errors	source code
Instance_group_managers.list_managed_instances	source code
Instance_group_managers.list_per_instance_configs	source code
Instance_group_managers.patch	source code
Instance_group_managers.patch_per_instance_configs	source code
Instance_group_managers.recreate_instances	source code
Instance_group_managers.resize	source code
Instance_group_managers.resume_instances	source code
Instance_group_managers.set_instance_template	source code
Instance_group_managers.set_target_pools	source code
Instance_group_managers.start_instances	source code
Instance_group_managers.stop_instances	source code
Instance_group_managers.suspend_instances	source code
Instance_group_managers.update_per_instance_configs	source code
Instance_groups.add_instances	source code
Instance_groups.aggregated_list	source code
Instance_groups.delete	source code
Instance_groups.get	source code
Instance_groups.insert	source code
Instance_groups.list	source code
Instance_groups.list_instances	source code
Instance_groups.remove_instances	source code
Instance_groups.set_named_ports	source code
Instance_settings_service.get	source code
Instance_settings_service.patch	source code
Instance_templates.aggregated_list	source code
Instance_templates.delete	source code
Instance_templates.get	source code
Instance_templates.get_iam_policy	source code
Instance_templates.insert	source code
Instance_templates.list	source code
Instance_templates.set_iam_policy	source code
Instance_templates.test_iam_permissions	source code
Instances.add_access_config	source code
Instances.add_resource_policies	source code
Instances.aggregated_list	source code
Instances.attach_disk	source code
Instances.bulk_insert	source code
Instances.delete	source code
Instances.delete_access_config	source code
Instances.detach_disk	source code
Instances.get	source code
Instances.get_effective_firewalls	source code
Instances.get_guest_attributes	source code
Instances.get_iam_policy	source code
Instances.get_screenshot	source code
Instances.get_serial_port_output	source code
Instances.get_shielded_instance_identity	source code
Instances.insert	source code
Instances.list	source code
Instances.list_referrers	source code
Instances.perform_maintenance	source code
Instances.remove_resource_policies	source code
Instances.reset	source code
Instances.resume	source code
Instances.send_diagnostic_interrupt	source code
Instances.set_deletion_protection	source code
Instances.set_disk_auto_delete	source code
Instances.set_iam_policy	source code
Instances.set_labels	source code
Instances.set_machine_resources	source code
Instances.set_machine_type	source code
Instances.set_metadata	source code
Instances.set_min_cpu_platform	source code
Instances.set_name	source code
Instances.set_scheduling	source code
Instances.set_security_policy	source code
Instances.set_service_account	source code
Instances.set_shielded_instance_integrity_policy	source code
Instances.set_tags	source code
Instances.simulate_maintenance_event	source code
Instances.start	source code
Instances.start_with_encryption_key	source code
Instances.stop	source code
Instances.suspend	source code
Instances.test_iam_permissions	source code
Instances.update	source code
Instances.update_access_config	source code
Instances.update_display_device	source code
Instances.update_network_interface	source code
Instances.update_shielded_instance_config	source code
Instant_snapshots.aggregated_list	source code
Instant_snapshots.delete	source code
Instant_snapshots.get	source code
Instant_snapshots.get_iam_policy	source code
Instant_snapshots.insert	source code
Instant_snapshots.list	source code
Instant_snapshots.set_iam_policy	source code
Instant_snapshots.set_labels	source code
Instant_snapshots.test_iam_permissions	source code
Interconnect_attachments.aggregated_list	source code
Interconnect_attachments.delete	source code
Interconnect_attachments.get	source code
Interconnect_attachments.insert	source code
Interconnect_attachments.list	source code
Interconnect_attachments.patch	source code
Interconnect_attachments.set_labels	source code
Interconnect_locations.get	source code
Interconnect_locations.list	source code
Interconnect_remote_locations.get	source code
Interconnect_remote_locations.list	source code
Interconnects.delete	source code
Interconnects.get	source code
Interconnects.get_diagnostics	source code
Interconnects.get_macsec_config	source code
Interconnects.insert	source code
Interconnects.list	source code
Interconnects.patch	source code
Interconnects.set_labels	source code
License_codes.get	source code
License_codes.test_iam_permissions	source code
Licenses.delete	source code
Licenses.get	source code
Licenses.get_iam_policy	source code
Licenses.insert	source code
Licenses.list	source code
Licenses.set_iam_policy	source code
Licenses.test_iam_permissions	source code
Machine_images.delete	source code
Machine_images.get	source code
Machine_images.get_iam_policy	source code
Machine_images.insert	source code
Machine_images.list	source code
Machine_images.set_iam_policy	source code
Machine_images.test_iam_permissions	source code
Machine_types.aggregated_list	source code
Machine_types.get	source code
Machine_types.list	source code
Network_attachments.aggregated_list	source code
Network_attachments.delete	source code
Network_attachments.get	source code
Network_attachments.get_iam_policy	source code
Network_attachments.insert	source code
Network_attachments.list	source code
Network_attachments.patch	source code
Network_attachments.set_iam_policy	source code
Network_attachments.test_iam_permissions	source code
Network_edge_security_services.aggregated_list	source code
Network_edge_security_services.delete	source code
Network_edge_security_services.get	source code
Network_edge_security_services.insert	source code
Network_edge_security_services.patch	source code
Network_endpoint_groups.aggregated_list	source code
Network_endpoint_groups.attach_network_endpoints	source code
Network_endpoint_groups.delete	source code
Network_endpoint_groups.detach_network_endpoints	source code
Network_endpoint_groups.get	source code
Network_endpoint_groups.insert	source code
Network_endpoint_groups.list	source code
Network_endpoint_groups.list_network_endpoints	source code
Network_endpoint_groups.test_iam_permissions	source code
Network_firewall_policies.add_association	source code
Network_firewall_policies.add_rule	source code
Network_firewall_policies.clone_rules	source code
Network_firewall_policies.delete	source code
Network_firewall_policies.get	source code
Network_firewall_policies.get_association	source code
Network_firewall_policies.get_iam_policy	source code
Network_firewall_policies.get_rule	source code
Network_firewall_policies.insert	source code
Network_firewall_policies.list	source code
Network_firewall_policies.patch	source code
Network_firewall_policies.patch_rule	source code
Network_firewall_policies.remove_association	source code
Network_firewall_policies.remove_rule	source code
Network_firewall_policies.set_iam_policy	source code
Network_firewall_policies.test_iam_permissions	source code
Network_profiles.get	source code
Network_profiles.list	source code
Networks.add_peering	source code
Networks.delete	source code
Networks.get	source code
Networks.get_effective_firewalls	source code
Networks.insert	source code
Networks.list	source code
Networks.list_peering_routes	source code
Networks.patch	source code
Networks.remove_peering	source code
Networks.switch_to_custom_mode	source code
Networks.update_peering	source code
Node_groups.add_nodes	source code
Node_groups.aggregated_list	source code
Node_groups.delete	source code
Node_groups.delete_nodes	source code
Node_groups.get	source code
Node_groups.get_iam_policy	source code
Node_groups.insert	source code
Node_groups.list	source code
Node_groups.list_nodes	source code
Node_groups.patch	source code
Node_groups.perform_maintenance	source code
Node_groups.set_iam_policy	source code
Node_groups.set_node_template	source code
Node_groups.simulate_maintenance_event	source code
Node_groups.test_iam_permissions	source code
Node_templates.aggregated_list	source code
Node_templates.delete	source code
Node_templates.get	source code
Node_templates.get_iam_policy	source code
Node_templates.insert	source code
Node_templates.list	source code
Node_templates.set_iam_policy	source code
Node_templates.test_iam_permissions	source code
Node_types.aggregated_list	source code
Node_types.get	source code
Node_types.list	source code
Packet_mirrorings.aggregated_list	source code
Packet_mirrorings.delete	source code
Packet_mirrorings.get	source code
Packet_mirrorings.insert	source code
Packet_mirrorings.list	source code
Packet_mirrorings.patch	source code
Packet_mirrorings.test_iam_permissions	source code
Projects.disable_xpn_host	source code
Projects.disable_xpn_resource	source code
Projects.enable_xpn_host	source code
Projects.enable_xpn_resource	source code
Projects.get	source code
Projects.get_xpn_host	source code
Projects.get_xpn_resources	source code
Projects.list_xpn_hosts	source code
Projects.move_disk	source code
Projects.move_instance	source code
Projects.set_cloud_armor_tier	source code
Projects.set_common_instance_metadata	source code
Projects.set_default_network_tier	source code
Projects.set_usage_export_bucket	source code
Public_advertised_prefixes.announce	source code
Public_advertised_prefixes.delete	source code
Public_advertised_prefixes.get	source code
Public_advertised_prefixes.insert	source code
Public_advertised_prefixes.list	source code
Public_advertised_prefixes.patch	source code
Public_advertised_prefixes.withdraw	source code
Public_delegated_prefixes.aggregated_list	source code
Public_delegated_prefixes.announce	source code
Public_delegated_prefixes.delete	source code
Public_delegated_prefixes.get	source code
Public_delegated_prefixes.insert	source code
Public_delegated_prefixes.list	source code
Public_delegated_prefixes.patch	source code
Public_delegated_prefixes.withdraw	source code
Region_autoscalers.delete	source code
Region_autoscalers.get	source code
Region_autoscalers.insert	source code
Region_autoscalers.list	source code
Region_autoscalers.patch	source code
Region_autoscalers.update	source code
Region_backend_services.delete	source code
Region_backend_services.get	source code
Region_backend_services.get_health	source code
Region_backend_services.get_iam_policy	source code
Region_backend_services.insert	source code
Region_backend_services.list	source code
Region_backend_services.list_usable	source code
Region_backend_services.patch	source code
Region_backend_services.set_iam_policy	source code
Region_backend_services.set_security_policy	source code
Region_backend_services.test_iam_permissions	source code
Region_backend_services.update	source code
Region_commitments.aggregated_list	source code
Region_commitments.get	source code
Region_commitments.insert	source code
Region_commitments.list	source code
Region_commitments.update	source code
Region_disk_types.get	source code
Region_disk_types.list	source code
Region_disks.add_resource_policies	source code
Region_disks.bulk_insert	source code
Region_disks.create_snapshot	source code
Region_disks.delete	source code
Region_disks.get	source code
Region_disks.get_iam_policy	source code
Region_disks.insert	source code
Region_disks.list	source code
Region_disks.remove_resource_policies	source code
Region_disks.resize	source code
Region_disks.set_iam_policy	source code
Region_disks.set_labels	source code
Region_disks.start_async_replication	source code
Region_disks.stop_async_replication	source code
Region_disks.stop_group_async_replication	source code
Region_disks.test_iam_permissions	source code
Region_disks.update	source code
Region_health_check_services.delete	source code
Region_health_check_services.get	source code
Region_health_check_services.insert	source code
Region_health_check_services.list	source code
Region_health_check_services.patch	source code
Region_health_checks.delete	source code
Region_health_checks.get	source code
Region_health_checks.insert	source code
Region_health_checks.list	source code
Region_health_checks.patch	source code
Region_health_checks.update	source code
Region_instance_group_managers.abandon_instances	source code
Region_instance_group_managers.apply_updates_to_instances	source code
Region_instance_group_managers.create_instances	source code
Region_instance_group_managers.delete	source code
Region_instance_group_managers.delete_instances	source code
Region_instance_group_managers.delete_per_instance_configs	source code
Region_instance_group_managers.get	source code
Region_instance_group_managers.insert	source code
Region_instance_group_managers.list	source code
Region_instance_group_managers.list_errors	source code
Region_instance_group_managers.list_managed_instances	source code
Region_instance_group_managers.list_per_instance_configs	source code
Region_instance_group_managers.patch	source code
Region_instance_group_managers.patch_per_instance_configs	source code
Region_instance_group_managers.recreate_instances	source code
Region_instance_group_managers.resize	source code
Region_instance_group_managers.resume_instances	source code
Region_instance_group_managers.set_instance_template	source code
Region_instance_group_managers.set_target_pools	source code
Region_instance_group_managers.start_instances	source code
Region_instance_group_managers.stop_instances	source code
Region_instance_group_managers.suspend_instances	source code
Region_instance_group_managers.update_per_instance_configs	source code
Region_instance_groups.get	source code
Region_instance_groups.list	source code
Region_instance_groups.list_instances	source code
Region_instance_groups.set_named_ports	source code
Region_instance_templates.delete	source code
Region_instance_templates.get	source code
Region_instance_templates.insert	source code
Region_instance_templates.list	source code
Region_instances.bulk_insert	source code
Region_instant_snapshots.delete	source code
Region_instant_snapshots.get	source code
Region_instant_snapshots.get_iam_policy	source code
Region_instant_snapshots.insert	source code
Region_instant_snapshots.list	source code
Region_instant_snapshots.set_iam_policy	source code
Region_instant_snapshots.set_labels	source code
Region_instant_snapshots.test_iam_permissions	source code
Region_network_endpoint_groups.attach_network_endpoints	source code
Region_network_endpoint_groups.delete	source code
Region_network_endpoint_groups.detach_network_endpoints	source code
Region_network_endpoint_groups.get	source code
Region_network_endpoint_groups.insert	source code
Region_network_endpoint_groups.list	source code
Region_network_endpoint_groups.list_network_endpoints	source code
Region_network_firewall_policies.add_association	source code
Region_network_firewall_policies.add_rule	source code
Region_network_firewall_policies.clone_rules	source code
Region_network_firewall_policies.delete	source code
Region_network_firewall_policies.get	source code
Region_network_firewall_policies.get_association	source code
Region_network_firewall_policies.get_effective_firewalls	source code
Region_network_firewall_policies.get_iam_policy	source code
Region_network_firewall_policies.get_rule	source code
Region_network_firewall_policies.insert	source code
Region_network_firewall_policies.list	source code
Region_network_firewall_policies.patch	source code
Region_network_firewall_policies.patch_rule	source code
Region_network_firewall_policies.remove_association	source code
Region_network_firewall_policies.remove_rule	source code
Region_network_firewall_policies.set_iam_policy	source code
Region_network_firewall_policies.test_iam_permissions	source code
Region_notification_endpoints.delete	source code
Region_notification_endpoints.get	source code
Region_notification_endpoints.insert	source code
Region_notification_endpoints.list	source code
Region_operations.delete	source code
Region_operations.get	source code
Region_operations.list	source code
Region_operations.wait	source code
Region_security_policies.add_rule	source code
Region_security_policies.delete	source code
Region_security_policies.get	source code
Region_security_policies.get_rule	source code
Region_security_policies.insert	source code
Region_security_policies.list	source code
Region_security_policies.patch	source code
Region_security_policies.patch_rule	source code
Region_security_policies.remove_rule	source code
Region_security_policies.set_labels	source code
Region_ssl_certificates.delete	source code
Region_ssl_certificates.get	source code
Region_ssl_certificates.insert	source code
Region_ssl_certificates.list	source code
Region_ssl_policies.delete	source code
Region_ssl_policies.get	source code
Region_ssl_policies.insert	source code
Region_ssl_policies.list	source code
Region_ssl_policies.list_available_features	source code
Region_ssl_policies.patch	source code
Region_target_http_proxies.delete	source code
Region_target_http_proxies.get	source code
Region_target_http_proxies.insert	source code
Region_target_http_proxies.list	source code
Region_target_http_proxies.set_url_map	source code
Region_target_https_proxies.delete	source code
Region_target_https_proxies.get	source code
Region_target_https_proxies.insert	source code
Region_target_https_proxies.list	source code
Region_target_https_proxies.patch	source code
Region_target_https_proxies.set_ssl_certificates	source code
Region_target_https_proxies.set_url_map	source code
Region_target_tcp_proxies.delete	source code
Region_target_tcp_proxies.get	source code
Region_target_tcp_proxies.insert	source code
Region_target_tcp_proxies.list	source code
Region_url_maps.delete	source code
Region_url_maps.get	source code
Region_url_maps.insert	source code
Region_url_maps.list	source code
Region_url_maps.patch	source code
Region_url_maps.update	source code
Region_url_maps.validate	source code
Region_zones.list	source code
Regions.get	source code
Regions.list	source code
Reservations.aggregated_list	source code
Reservations.delete	source code
Reservations.get	source code
Reservations.get_iam_policy	source code
Reservations.insert	source code
Reservations.list	source code
Reservations.resize	source code
Reservations.set_iam_policy	source code
Reservations.test_iam_permissions	source code
Reservations.update	source code
Resource_policies.aggregated_list	source code
Resource_policies.delete	source code
Resource_policies.get	source code
Resource_policies.get_iam_policy	source code
Resource_policies.insert	source code
Resource_policies.list	source code
Resource_policies.patch	source code
Resource_policies.set_iam_policy	source code
Resource_policies.test_iam_permissions	source code
Routers.aggregated_list	source code
Routers.delete	source code
Routers.get	source code
Routers.get_nat_ip_info	source code
Routers.get_nat_mapping_info	source code
Routers.get_router_status	source code
Routers.insert	source code
Routers.list	source code
Routers.patch	source code
Routers.preview	source code
Routers.update	source code
Routes.delete	source code
Routes.get	source code
Routes.insert	source code
Routes.list	source code
Security_policies.add_rule	source code
Security_policies.aggregated_list	source code
Security_policies.delete	source code
Security_policies.get	source code
Security_policies.get_rule	source code
Security_policies.insert	source code
Security_policies.list	source code
Security_policies.list_preconfigured_expression_sets	source code
Security_policies.patch	source code
Security_policies.patch_rule	source code
Security_policies.remove_rule	source code
Security_policies.set_labels	source code
Service_attachments.aggregated_list	source code
Service_attachments.delete	source code
Service_attachments.get	source code
Service_attachments.get_iam_policy	source code
Service_attachments.insert	source code
Service_attachments.list	source code
Service_attachments.patch	source code
Service_attachments.set_iam_policy	source code
Service_attachments.test_iam_permissions	source code
Snapshot_settings_service.get	source code
Snapshot_settings_service.patch	source code
Snapshots.delete	source code
Snapshots.get	source code
Snapshots.get_iam_policy	source code
Snapshots.insert	source code
Snapshots.list	source code
Snapshots.set_iam_policy	source code
Snapshots.set_labels	source code
Snapshots.test_iam_permissions	source code
Ssl_certificates.aggregated_list	source code
Ssl_certificates.delete	source code
Ssl_certificates.get	source code
Ssl_certificates.insert	source code
Ssl_certificates.list	source code
Ssl_policies.aggregated_list	source code
Ssl_policies.delete	source code
Ssl_policies.get	source code
Ssl_policies.insert	source code
Ssl_policies.list	source code
Ssl_policies.list_available_features	source code
Ssl_policies.patch	source code
Storage_pool_types.aggregated_list	source code
Storage_pool_types.get	source code
Storage_pool_types.list	source code
Storage_pools.aggregated_list	source code
Storage_pools.delete	source code
Storage_pools.get	source code
Storage_pools.get_iam_policy	source code
Storage_pools.insert	source code
Storage_pools.list	source code
Storage_pools.list_disks	source code
Storage_pools.set_iam_policy	source code
Storage_pools.test_iam_permissions	source code
Storage_pools.update	source code
Subnetworks.aggregated_list	source code
Subnetworks.delete	source code
Subnetworks.expand_ip_cidr_range	source code
Subnetworks.get	source code
Subnetworks.get_iam_policy	source code
Subnetworks.insert	source code
Subnetworks.list	source code
Subnetworks.list_usable	source code
Subnetworks.patch	source code
Subnetworks.set_iam_policy	source code
Subnetworks.set_private_ip_google_access	source code
Subnetworks.test_iam_permissions	source code
Target_grpc_proxies.delete	source code
Target_grpc_proxies.get	source code
Target_grpc_proxies.insert	source code
Target_grpc_proxies.list	source code
Target_grpc_proxies.patch	source code
Target_http_proxies.aggregated_list	source code
Target_http_proxies.delete	source code
Target_http_proxies.get	source code
Target_http_proxies.insert	source code
Target_http_proxies.list	source code
Target_http_proxies.patch	source code
Target_http_proxies.set_url_map	source code
Target_https_proxies.aggregated_list	source code
Target_https_proxies.delete	source code
Target_https_proxies.get	source code
Target_https_proxies.insert	source code
Target_https_proxies.list	source code
Target_https_proxies.patch	source code
Target_https_proxies.set_certificate_map	source code
Target_https_proxies.set_quic_override	source code
Target_https_proxies.set_ssl_certificates	source code
Target_https_proxies.set_ssl_policy	source code
Target_https_proxies.set_url_map	source code
Target_instances.aggregated_list	source code
Target_instances.delete	source code
Target_instances.get	source code
Target_instances.insert	source code
Target_instances.list	source code
Target_instances.set_security_policy	source code
Target_pools.add_health_check	source code
Target_pools.add_instance	source code
Target_pools.aggregated_list	source code
Target_pools.delete	source code
Target_pools.get	source code
Target_pools.get_health	source code
Target_pools.insert	source code
Target_pools.list	source code
Target_pools.remove_health_check	source code
Target_pools.remove_instance	source code
Target_pools.set_backup	source code
Target_pools.set_security_policy	source code
Target_ssl_proxies.delete	source code
Target_ssl_proxies.get	source code
Target_ssl_proxies.insert	source code
Target_ssl_proxies.list	source code
Target_ssl_proxies.set_backend_service	source code
Target_ssl_proxies.set_certificate_map	source code
Target_ssl_proxies.set_proxy_header	source code
Target_ssl_proxies.set_ssl_certificates	source code
Target_ssl_proxies.set_ssl_policy	source code
Target_tcp_proxies.aggregated_list	source code
Target_tcp_proxies.delete	source code
Target_tcp_proxies.get	source code
Target_tcp_proxies.insert	source code
Target_tcp_proxies.list	source code
Target_tcp_proxies.set_backend_service	source code
Target_tcp_proxies.set_proxy_header	source code
Target_vpn_gateways.aggregated_list	source code
Target_vpn_gateways.delete	source code
Target_vpn_gateways.get	source code
Target_vpn_gateways.insert	source code
Target_vpn_gateways.list	source code
Target_vpn_gateways.set_labels	source code
Url_maps.aggregated_list	source code
Url_maps.delete	source code
Url_maps.get	source code
Url_maps.insert	source code
Url_maps.invalidate_cache	source code
Url_maps.list	source code
Url_maps.patch	source code
Url_maps.update	source code
Url_maps.validate	source code
Vpn_gateways.aggregated_list	source code
Vpn_gateways.delete	source code
Vpn_gateways.get	source code
Vpn_gateways.get_status	source code
Vpn_gateways.insert	source code
Vpn_gateways.list	source code
Vpn_gateways.set_labels	source code
Vpn_gateways.test_iam_permissions	source code
Vpn_tunnels.aggregated_list	source code
Vpn_tunnels.delete	source code
Vpn_tunnels.get	source code
Vpn_tunnels.insert	source code
Vpn_tunnels.list	source code
Vpn_tunnels.set_labels	source code
Zone_operations.delete	source code
Zone_operations.get	source code
Zone_operations.list	source code
Zone_operations.wait	source code
Zones.get	source code
Zones.list	source code
Addresses.aggregated_list	source code
Addresses.delete	source code
Addresses.insert	source code
Addresses.list	source code
Region_operations.get	source code
Region_operations.wait	source code
Quickstart	source code

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. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/compute@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

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