README.md

Compute Engine API C++ Client Library

This directory contains an idiomatic C++ client library for the Compute Engine API, a service that lets you create and run virtual machines on Google’s infrastructure.

Compute Engine's API has a large surface and is split into multiple services, in different subdirectories, each interacting with a specific Compute Engine resource. Additionally, Compute Engine is divided into multiple libraries, one per resource, to reduce binary size.

CMake targets follow the naming convention google-cloud-cpp::compute_${subdir}, such that the "disks" library is google-cloud-cpp::compute_disks and the "instance_group_managers" library is google-cloud-cpp::compute_instance_group_managers.

Bazel targets follow the naming convention compute_${subdir} such that the "disks" library is @google_cloud_cpp//:compute_disks and the "instance_group_managers" library is @google_cloud_cpp//:compute_instance_group_managers.

Quickstart

The quickstart/ directory contains a minimal environment to get started using this client library in a larger project. The following "Hello World" program is used in this quickstart, and should give you a taste of this library.

#include "google/cloud/compute/disks/v1/disks_client.h"
#include <iostream>

int main(int argc, char* argv[]) try {
  if (argc != 3) {
    std::cerr << "Usage: " << argv[0] << " project-id zone-id\n";
    return 1;
  }

  namespace disks = ::google::cloud::compute_disks_v1;
  auto client = disks::DisksClient(disks::MakeDisksConnectionRest());

  for (auto disk : client.ListDisks(argv[1], argv[2])) {
    if (!disk) throw std::move(disk).status();
    std::cout << disk->DebugString() << "\n";
  }

  return 0;
} catch (google::cloud::Status const& status) {
  std::cerr << "google::cloud::Status thrown: " << status << "\n";
  return 1;
}

More Information

• Official documentation about the Compute Engine API service
• Reference doxygen documentation for each release of this client library
• Detailed header comments in our public .h files