An idiomatic C++ client library for Cloud TPU, a service that provides customers with access to Google TPU technology.
While this library is GA, please note that the Google Cloud C++ client libraries do not follow Semantic Versioning.
Quickstart
The following shows the code that you'll run in the google/cloud/tpu/quickstart/ directory, which should give you a taste of the Cloud TPU API C++ client library API.
#include "google/cloud/tpu/v2/tpu_client.h"
#include "google/cloud/location.h"
#include <iostream>
int main(int argc, char* argv[]) try {
if (argc != 2) {
std::cerr << "Usage: " << argv[0] << " project-id\n";
return 1;
}
auto const location = google::cloud::Location(argv[1], "-");
namespace tpu = ::google::cloud::tpu_v2;
auto client = tpu::TpuClient(tpu::MakeTpuConnection());
for (auto n : client.ListNodes(location.FullName())) {
if (!n) throw std::move(n).status();
std::cout << n->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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThis page provides documentation for the Cloud TPU API C++ client library, which allows users to interact with Google TPU technology.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the library is 2.37.0-rc, and there are multiple prior versions available, ranging from 2.36.0 down to 2.11.0.\u003c/p\u003e\n"],["\u003cp\u003eThe library is generally available (GA) but does not adhere to Semantic Versioning standards.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation includes a quickstart guide, information on main classes like \u003ccode\u003etpu_v1::TpuClient\u003c/code\u003e and \u003ccode\u003etpu_v2::TpuClient\u003c/code\u003e, and details on error handling and overriding default configurations.\u003c/p\u003e\n"],["\u003cp\u003eThe C++ library groups multiple services together as they are part of the same product or are frequently used in conjunction with each other.\u003c/p\u003e\n"]]],[],null,["Version latestkeyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/tpu/latest)\n- [2.41.0](/cpp/docs/reference/tpu/2.41.0)\n- [2.40.0](/cpp/docs/reference/tpu/2.40.0)\n- [2.39.0](/cpp/docs/reference/tpu/2.39.0)\n- [2.38.0](/cpp/docs/reference/tpu/2.38.0)\n- [2.37.0](/cpp/docs/reference/tpu/2.37.0)\n- [2.36.0](/cpp/docs/reference/tpu/2.36.0)\n- [2.35.0](/cpp/docs/reference/tpu/2.35.0)\n- [2.34.0](/cpp/docs/reference/tpu/2.34.0)\n- [2.33.0](/cpp/docs/reference/tpu/2.33.0)\n- [2.32.0](/cpp/docs/reference/tpu/2.32.0)\n- [2.31.0](/cpp/docs/reference/tpu/2.31.0)\n- [2.30.0](/cpp/docs/reference/tpu/2.30.0)\n- [2.29.0](/cpp/docs/reference/tpu/2.29.0)\n- [2.28.0](/cpp/docs/reference/tpu/2.28.0)\n- [2.27.0](/cpp/docs/reference/tpu/2.27.0)\n- [2.26.0](/cpp/docs/reference/tpu/2.26.0)\n- [2.25.1](/cpp/docs/reference/tpu/2.25.1)\n- [2.24.0](/cpp/docs/reference/tpu/2.24.0)\n- [2.23.0](/cpp/docs/reference/tpu/2.23.0)\n- [2.22.1](/cpp/docs/reference/tpu/2.22.1)\n- [2.21.0](/cpp/docs/reference/tpu/2.21.0)\n- [2.20.0](/cpp/docs/reference/tpu/2.20.0)\n- [2.19.0](/cpp/docs/reference/tpu/2.19.0)\n- [2.18.0](/cpp/docs/reference/tpu/2.18.0)\n- [2.17.0](/cpp/docs/reference/tpu/2.17.0)\n- [2.16.0](/cpp/docs/reference/tpu/2.16.0)\n- [2.15.1](/cpp/docs/reference/tpu/2.15.1)\n- [2.14.0](/cpp/docs/reference/tpu/2.14.0)\n- [2.13.0](/cpp/docs/reference/tpu/2.13.0)\n- [2.12.0](/cpp/docs/reference/tpu/2.12.0)\n- [2.11.0](/cpp/docs/reference/tpu/2.11.0) \n\nCloud TPU API C++ Client Library\n================================\n\nAn idiomatic C++ client library for [Cloud TPU](https://cloud.google.com/tpu), a service that provides customers with access to Google TPU technology.\n\nWhile this library is **GA** , please note that the Google Cloud C++ client libraries do **not** follow [Semantic Versioning](https://semver.org/).\n\n### Quickstart\n\nThe following shows the code that you'll run in the `google/cloud/tpu/quickstart/` directory, which should give you a taste of the Cloud TPU API C++ client library API. \n\n #include \"google/cloud/tpu/v2/tpu_client.h\"\n #include \"google/cloud/location.h\"\n #include \u003ciostream\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 2) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" project-id\\n\";\n return 1;\n }\n\n auto const location = google::cloud::Location(argv[1], \"-\");\n\n namespace tpu = ::google::cloud::tpu_v2;\n auto client = tpu::TpuClient(tpu::MakeTpuConnection());\n\n for (auto n : client.ListNodes(location.FullName())) {\n if (!n) throw std::move(n).status();\n std::cout \u003c\u003c n-\u003eDebugString() \u003c\u003c \"\\n\";\n }\n\n return 0;\n } catch (google::cloud::Status const& status) {\n std::cerr \u003c\u003c \"google::cloud::Status thrown: \" \u003c\u003c status \u003c\u003c \"\\n\";\n return 1;\n }\n\n### Main classes\n\nThis 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.\n\nThe library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the `*Client` classes when testing your application.\n\n- [`tpu_v1::TpuClient`](/cpp/docs/reference/tpu/latest/classgoogle_1_1cloud_1_1tpu__v1_1_1TpuClient)\n- [`tpu_v2::TpuClient`](/cpp/docs/reference/tpu/latest/classgoogle_1_1cloud_1_1tpu__v2_1_1TpuClient)\n\n### More Information\n\n- [Error Handling](https://cloud.google.com/cpp/docs/reference/common/latest/common-error-handling.html) - describes how the library reports errors.\n- [How to Override the Default Endpoint](/cpp/docs/reference/tpu/latest/tpu-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/tpu/latest/tpu-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Override Retry, Backoff, and Idempotency Policies](/cpp/docs/reference/tpu/latest/tpu-override-retry) - describes how to change the default retry policies.\n- [Environment Variables](/cpp/docs/reference/tpu/latest/tpu-env) - describes environment variables that can configure the behavior of the library."]]