An idiomatic C++ client library for theBackup for GKE API, a managed Kubernetes workload backup and restore service for GKE clusters.
While this library isGA, please note that the Google Cloud C++ client libraries donotfollowSemantic Versioning.
Quickstart
The following shows the code that you'll run in thegoogle/cloud/gkebackup/quickstart/directory, which should give you a taste of the Backup for GKE API C++ client library API.
The main class in this library isgkebackup_v1::BackupForGKEClient. All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mockgkebackup_v1::BackupForGKEClientwhen testing your application.
Retry, Backoff, and Idempotency Policies.
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 Backup for GKE API C++ client library, a tool for managing Kubernetes workload backups and restores in GKE clusters.\u003c/p\u003e\n"],["\u003cp\u003eThe latest release candidate is version 2.37.0-rc, with numerous previous versions available, from 2.36.0 down to 2.12.0.\u003c/p\u003e\n"],["\u003cp\u003eThe primary class for interacting with the API is \u003ccode\u003egkebackup_v1::BackupForGKEClient\u003c/code\u003e, which exposes all RPCs as member functions.\u003c/p\u003e\n"],["\u003cp\u003eThe library automatically manages request retries with exponential backoff for transient errors, and default policies can be overridden.\u003c/p\u003e\n"],["\u003cp\u003eThe library is considered GA, however it is important to know that Google Cloud C++ client libraries do not follow semantic versioning practices.\u003c/p\u003e\n"]]],[],null,["Version 2.12.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/gkebackup/latest)\n- [2.41.0](/cpp/docs/reference/gkebackup/2.41.0)\n- [2.40.0](/cpp/docs/reference/gkebackup/2.40.0)\n- [2.39.0](/cpp/docs/reference/gkebackup/2.39.0)\n- [2.38.0](/cpp/docs/reference/gkebackup/2.38.0)\n- [2.37.0](/cpp/docs/reference/gkebackup/2.37.0)\n- [2.36.0](/cpp/docs/reference/gkebackup/2.36.0)\n- [2.35.0](/cpp/docs/reference/gkebackup/2.35.0)\n- [2.34.0](/cpp/docs/reference/gkebackup/2.34.0)\n- [2.33.0](/cpp/docs/reference/gkebackup/2.33.0)\n- [2.32.0](/cpp/docs/reference/gkebackup/2.32.0)\n- [2.31.0](/cpp/docs/reference/gkebackup/2.31.0)\n- [2.30.0](/cpp/docs/reference/gkebackup/2.30.0)\n- [2.29.0](/cpp/docs/reference/gkebackup/2.29.0)\n- [2.28.0](/cpp/docs/reference/gkebackup/2.28.0)\n- [2.27.0](/cpp/docs/reference/gkebackup/2.27.0)\n- [2.26.0](/cpp/docs/reference/gkebackup/2.26.0)\n- [2.25.1](/cpp/docs/reference/gkebackup/2.25.1)\n- [2.24.0](/cpp/docs/reference/gkebackup/2.24.0)\n- [2.23.0](/cpp/docs/reference/gkebackup/2.23.0)\n- [2.22.1](/cpp/docs/reference/gkebackup/2.22.1)\n- [2.21.0](/cpp/docs/reference/gkebackup/2.21.0)\n- [2.20.0](/cpp/docs/reference/gkebackup/2.20.0)\n- [2.19.0](/cpp/docs/reference/gkebackup/2.19.0)\n- [2.18.0](/cpp/docs/reference/gkebackup/2.18.0)\n- [2.17.0](/cpp/docs/reference/gkebackup/2.17.0)\n- [2.16.0](/cpp/docs/reference/gkebackup/2.16.0)\n- [2.15.1](/cpp/docs/reference/gkebackup/2.15.1)\n- [2.14.0](/cpp/docs/reference/gkebackup/2.14.0)\n- [2.13.0](/cpp/docs/reference/gkebackup/2.13.0)\n- [2.12.0](/cpp/docs/reference/gkebackup/2.12.0) \n\nBackup for GKE API C++ Client Library\n=====================================\n\nAn idiomatic C++ client library for the [Backup for GKE API](https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke), a managed Kubernetes workload backup and restore service for GKE clusters.\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/gkebackup/quickstart/` directory, which should give you a taste of the Backup for GKE API C++ client library API. \n\n #include \"google/cloud/gkebackup/v1/backup_for_gke_client.h\"\n #include \u003ciostream\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 3) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" project-id location-id\\n\";\n return 1;\n }\n\n namespace gkebackup = ::google::cloud::gkebackup_v1;\n auto client =\n gkebackup::BackupForGKEClient(gkebackup::MakeBackupForGKEConnection());\n\n auto const parent =\n std::string{\"projects/\"} + argv[1] + \"/locations/\" + argv[2];\n for (auto r : client.ListBackupPlans(parent)) {\n if (!r) throw std::move(r).status();\n std::cout \u003c\u003c r-\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\nThe main class in this library is [`gkebackup_v1::BackupForGKEClient`](/cpp/docs/reference/gkebackup/2.12.0/classgoogle_1_1cloud_1_1gkebackup__v1_1_1BackupForGKEClient). All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock [`gkebackup_v1::BackupForGKEClient`](/cpp/docs/reference/gkebackup/2.12.0/classgoogle_1_1cloud_1_1gkebackup__v1_1_1BackupForGKEClient) when testing your application.\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/gkebackup/2.12.0/gkebackup-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/gkebackup/2.12.0/gkebackup-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Environment Variables](/cpp/docs/reference/gkebackup/2.12.0/gkebackup-env) - describes environment variables that can configure the behavior of the library."]]