An idiomatic C++ client library for theCloud Build API, a service that executes your builds on Google Cloud Platform's infrastructure.
While this library isGA, please note Google Cloud C++ client libraries donotfollowSemantic Versioning.
Quickstart
The following shows the code that you'll run in thegoogle/cloud/cloudbuild/quickstart/directory, which should give you a taste of the Cloud Build API C++ client library API.
#include "google/cloud/cloudbuild/v1/cloud_build_client.h"
#include <iostream>
int main(int argc, char* argv[]) try {
if (argc != 2) {
std::cerr << "Usage: " << argv[0] << " project-id\n";
return 1;
}
namespace cloudbuild = ::google::cloud::cloudbuild_v1;
auto client =
cloudbuild::CloudBuildClient(cloudbuild::MakeCloudBuildConnection());
auto const* filter = R"""(status="WORKING")"""; // List only running builds
for (auto b : client.ListBuilds(argv[1], filter)) {
if (!b) throw std::move(b).status();
std::cout << b->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*Clientclasses, which are listed below. Each one of these classes exposes all the RPCs for a gRPCserviceas 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*Clientclasses when testing your application.
The library automatically retries requests that fail with transient errors, and usesexponential backoffto backoff between retries. Application developers can override the default policies.
More Information
Error Handling- describes how the library reports errors.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the Cloud Build API C++ client library, which is used to execute builds on Google Cloud Platform's infrastructure.\u003c/p\u003e\n"],["\u003cp\u003eThe latest release candidate version is 2.37.0-rc, and the library's documentation includes versions ranging from 2.11.0 up to this release.\u003c/p\u003e\n"],["\u003cp\u003eThe library offers \u003ccode\u003eCloudBuildClient\u003c/code\u003e and \u003ccode\u003eRepositoryManagerClient\u003c/code\u003e classes, which expose all the RPCs for gRPC services as member functions.\u003c/p\u003e\n"],["\u003cp\u003eThe C++ client libraries do not follow Semantic Versioning, despite being in General Availability (GA).\u003c/p\u003e\n"],["\u003cp\u003eThe library includes automatic retries for transient errors and uses exponential backoff, with the option for application developers to customize these policies.\u003c/p\u003e\n"]]],[],null,["Version 2.12.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/cloudbuild/latest)\n- [2.41.0](/cpp/docs/reference/cloudbuild/2.41.0)\n- [2.40.0](/cpp/docs/reference/cloudbuild/2.40.0)\n- [2.39.0](/cpp/docs/reference/cloudbuild/2.39.0)\n- [2.38.0](/cpp/docs/reference/cloudbuild/2.38.0)\n- [2.37.0](/cpp/docs/reference/cloudbuild/2.37.0)\n- [2.36.0](/cpp/docs/reference/cloudbuild/2.36.0)\n- [2.35.0](/cpp/docs/reference/cloudbuild/2.35.0)\n- [2.34.0](/cpp/docs/reference/cloudbuild/2.34.0)\n- [2.33.0](/cpp/docs/reference/cloudbuild/2.33.0)\n- [2.32.0](/cpp/docs/reference/cloudbuild/2.32.0)\n- [2.31.0](/cpp/docs/reference/cloudbuild/2.31.0)\n- [2.30.0](/cpp/docs/reference/cloudbuild/2.30.0)\n- [2.29.0](/cpp/docs/reference/cloudbuild/2.29.0)\n- [2.28.0](/cpp/docs/reference/cloudbuild/2.28.0)\n- [2.27.0](/cpp/docs/reference/cloudbuild/2.27.0)\n- [2.26.0](/cpp/docs/reference/cloudbuild/2.26.0)\n- [2.25.1](/cpp/docs/reference/cloudbuild/2.25.1)\n- [2.24.0](/cpp/docs/reference/cloudbuild/2.24.0)\n- [2.23.0](/cpp/docs/reference/cloudbuild/2.23.0)\n- [2.22.1](/cpp/docs/reference/cloudbuild/2.22.1)\n- [2.21.0](/cpp/docs/reference/cloudbuild/2.21.0)\n- [2.20.0](/cpp/docs/reference/cloudbuild/2.20.0)\n- [2.19.0](/cpp/docs/reference/cloudbuild/2.19.0)\n- [2.18.0](/cpp/docs/reference/cloudbuild/2.18.0)\n- [2.17.0](/cpp/docs/reference/cloudbuild/2.17.0)\n- [2.16.0](/cpp/docs/reference/cloudbuild/2.16.0)\n- [2.15.1](/cpp/docs/reference/cloudbuild/2.15.1)\n- [2.14.0](/cpp/docs/reference/cloudbuild/2.14.0)\n- [2.13.0](/cpp/docs/reference/cloudbuild/2.13.0)\n- [2.12.0](/cpp/docs/reference/cloudbuild/2.12.0)\n- [2.11.0](/cpp/docs/reference/cloudbuild/2.11.0) \n\nCloud Build API C++ Client Library\n==================================\n\nAn idiomatic C++ client library for the [Cloud Build API](https://cloud.google.com/build), a service that executes your builds on Google Cloud Platform's infrastructure.\n\nWhile this library is **GA** , please note 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/cloudbuild/quickstart/` directory, which should give you a taste of the Cloud Build API C++ client library API. \n\n #include \"google/cloud/cloudbuild/v1/cloud_build_client.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 namespace cloudbuild = ::google::cloud::cloudbuild_v1;\n auto client =\n cloudbuild::CloudBuildClient(cloudbuild::MakeCloudBuildConnection());\n auto const* filter = R\"\"\"(status=\"WORKING\")\"\"\"; // List only running builds\n for (auto b : client.ListBuilds(argv[1], filter)) {\n if (!b) throw std::move(b).status();\n std::cout \u003c\u003c b-\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 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.\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- [`cloudbuild_v1::CloudBuildClient`](/cpp/docs/reference/cloudbuild/2.12.0/classgoogle_1_1cloud_1_1cloudbuild__v1_1_1CloudBuildClient)\n- [`cloudbuild_v2::RepositoryManagerClient`](/cpp/docs/reference/cloudbuild/2.12.0/classgoogle_1_1cloud_1_1cloudbuild__v2_1_1RepositoryManagerClient)\n\n### Retry, Backoff, and Idempotency Policies.\n\nThe library automatically retries requests that fail with transient errors, and uses [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) to backoff between retries. Application developers can override the default policies.\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/cloudbuild/2.12.0/cloudbuild-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/cloudbuild/2.12.0/cloudbuild-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Environment Variables](/cpp/docs/reference/cloudbuild/2.12.0/cloudbuild-env) - describes environment variables that can configure the behavior of the library."]]