Notebooks API C++ Client Library

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

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

Quickstart

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

 #include "google/cloud/notebooks/v1/managed_notebook_client.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;
  }

  namespace notebooks = ::google::cloud::notebooks_v1;
  auto client = notebooks::ManagedNotebookServiceClient(
      notebooks::MakeManagedNotebookServiceConnection());

  auto const parent =
      std::string{"projects/"} + argv[1] + "/locations/" + argv[2];
  for (auto r : client.ListRuntimes(parent)) {
    if (!r) throw std::move(r).status();
    std::cout << r->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.

More Information

Error Handling - describes how the library reports errors.
How to Override the Default Endpoint - describes how to override the default endpoint.
How to Override the Authentication Credentials - describes how to change the authentication credentials used by the library.
Override Retry, Backoff, and Idempotency Policies - describes how to change the default retry policies.
Environment Variables - describes environment variables that can configure the behavior of the library.