OS Config API C++ Client Library

An idiomatic C++ client library for the OS Config API, a service for patch management, patch compliance, and configuration management on VM instances.

While this library is GA, please note Google Cloud C++ client libraries do not follow Semantic Versioning.


The following shows the code that you'll run in the google/cloud/osconfig/quickstart/ directory, which should give you a taste of the OS Config API C++ client library API.

#include "google/cloud/osconfig/v1/os_config_client.h"
#include "google/cloud/project.h"
#include <iostream>

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

  namespace osconfig = ::google::cloud::osconfig_v1;
  auto client = osconfig::OsConfigServiceClient(

  auto const project = google::cloud::Project(argv[1]);
  for (auto p : client.ListPatchJobs(project.FullName())) {
    if (!p) throw std::move(p).status();
    std::cout << p->DebugString() << "\n";

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

Main classes

This library offers multiple *Client classes, which are listed below. Each one of these classes exposes all the RPCs for a gRPC service as member functions of the class. This library groups multiple gRPC services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.

The library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the *Client classes when testing your application.

Retry, Backoff, and Idempotency Policies.

The library automatically retries requests that fail with transient errors, and uses exponential backoff to backoff between retries. Application developers can override the default policies.

More Information