Notebooks API C++ Client Library

An idiomatic C++ client library for theNotebooks API. Use this API to programmatically manage notebooks in Google Cloud. Learn more about notebooks at theVertex AI Workbench site.

While this library isGA, please note Google Cloud C++ client libraries donot followSemantic Versioning.

Quickstart

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

#include "google/cloud/notebooks/v2/notebook_client.h"#include "google/cloud/location.h"#include <iostream>int main(int argc, char* argv[]) try {  if (argc != 3) {    std::cerr << "Usage: " << argv[0] << " project-id location-id\n";    return 1;  }  auto const location = google::cloud::Location(argv[1], argv[2]);  namespace notebooks = ::google::cloud::notebooks_v2;  auto client = notebooks::NotebookServiceClient(      notebooks::MakeNotebookServiceConnection());  for (auto i : client.ListInstances(location.FullName())) {    if (!i) throw std::move(i).status();    std::cout << i->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 service as member functions of the class. This library groups multiple 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.

More Information

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-18 UTC.