Google Cloud Memorystore for Redis API C++ Client Library
An idiomatic C++ client library for theGoogle Cloud Memorystore for Redis API, a service to create and manage Redis instances on the Google Cloud Platform.
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/redis/quickstart/directory, which should give you a taste of the Google Cloud Memorystore for Redis API C++ client library API.
#include "google/cloud/redis/v1/cloud_redis_client.h"
#include "google/cloud/project.h"
#include <iostream>
int main(int argc, char* argv[]) try {
if (argc != 2) {
std::cerr << "Usage: " << argv[0] << " project-id\n";
return 1;
}
namespace redis = ::google::cloud::redis_v1;
auto client = redis::CloudRedisClient(redis::MakeCloudRedisConnection());
auto const project_id = std::string(argv[1]);
auto const parent = "projects/" + project_id + "/locations/-";
for (auto r : client.ListInstances(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
The main class in this library isredis_v1::CloudRedisClient. All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mockredis_v1::CloudRedisClientwhen 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 page provides documentation for the Google Cloud Memorystore for Redis API C++ Client Library, which is generally available (GA) but does not follow Semantic Versioning.\u003c/p\u003e\n"],["\u003cp\u003eThe latest release candidate is version 2.37.0-rc, and the page lists a comprehensive history of versions dating back to 2.11.0 for the C++ client library.\u003c/p\u003e\n"],["\u003cp\u003eThe primary class of this library is \u003ccode\u003eredis_v1::CloudRedisClient\u003c/code\u003e, which provides access to all Remote Procedure Calls (RPCs), with additional classes included for assisting with testing.\u003c/p\u003e\n"],["\u003cp\u003eThe library features automatic retries with exponential backoff for transient errors, and allows developers to customize these default policies.\u003c/p\u003e\n"],["\u003cp\u003eThe page gives reference material such as error handling, how to override the default endpoint, how to change authentication credentials, and environment variables.\u003c/p\u003e\n"]]],[],null,["Version 2.11.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/redis/latest)\n- [2.41.0](/cpp/docs/reference/redis/2.41.0)\n- [2.40.0](/cpp/docs/reference/redis/2.40.0)\n- [2.39.0](/cpp/docs/reference/redis/2.39.0)\n- [2.38.0](/cpp/docs/reference/redis/2.38.0)\n- [2.37.0](/cpp/docs/reference/redis/2.37.0)\n- [2.36.0](/cpp/docs/reference/redis/2.36.0)\n- [2.35.0](/cpp/docs/reference/redis/2.35.0)\n- [2.34.0](/cpp/docs/reference/redis/2.34.0)\n- [2.33.0](/cpp/docs/reference/redis/2.33.0)\n- [2.32.0](/cpp/docs/reference/redis/2.32.0)\n- [2.31.0](/cpp/docs/reference/redis/2.31.0)\n- [2.30.0](/cpp/docs/reference/redis/2.30.0)\n- [2.29.0](/cpp/docs/reference/redis/2.29.0)\n- [2.28.0](/cpp/docs/reference/redis/2.28.0)\n- [2.27.0](/cpp/docs/reference/redis/2.27.0)\n- [2.26.0](/cpp/docs/reference/redis/2.26.0)\n- [2.25.1](/cpp/docs/reference/redis/2.25.1)\n- [2.24.0](/cpp/docs/reference/redis/2.24.0)\n- [2.23.0](/cpp/docs/reference/redis/2.23.0)\n- [2.22.1](/cpp/docs/reference/redis/2.22.1)\n- [2.21.0](/cpp/docs/reference/redis/2.21.0)\n- [2.20.0](/cpp/docs/reference/redis/2.20.0)\n- [2.19.0](/cpp/docs/reference/redis/2.19.0)\n- [2.18.0](/cpp/docs/reference/redis/2.18.0)\n- [2.17.0](/cpp/docs/reference/redis/2.17.0)\n- [2.16.0](/cpp/docs/reference/redis/2.16.0)\n- [2.15.1](/cpp/docs/reference/redis/2.15.1)\n- [2.14.0](/cpp/docs/reference/redis/2.14.0)\n- [2.13.0](/cpp/docs/reference/redis/2.13.0)\n- [2.12.0](/cpp/docs/reference/redis/2.12.0)\n- [2.11.0](/cpp/docs/reference/redis/2.11.0) \n\nGoogle Cloud Memorystore for Redis API C++ Client Library\n=========================================================\n\nAn idiomatic C++ client library for the [Google Cloud Memorystore for Redis API](https://cloud.google.com/memorystore/docs/redis), a service to create and manage Redis instances on the Google Cloud Platform.\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/redis/quickstart/` directory, which should give you a taste of the Google Cloud Memorystore for Redis API C++ client library API. \n\n #include \"google/cloud/redis/v1/cloud_redis_client.h\"\n #include \"google/cloud/project.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 redis = ::google::cloud::redis_v1;\n auto client = redis::CloudRedisClient(redis::MakeCloudRedisConnection());\n\n auto const project_id = std::string(argv[1]);\n auto const parent = \"projects/\" + project_id + \"/locations/-\";\n for (auto r : client.ListInstances(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 [`redis_v1::CloudRedisClient`](/cpp/docs/reference/redis/2.11.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisClient). All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock [`redis_v1::CloudRedisClient`](/cpp/docs/reference/redis/2.11.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisClient) 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/redis/2.11.0/redis-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/redis/2.11.0/redis-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Environment Variables](/cpp/docs/reference/redis/2.11.0/redis-env) - describes environment variables that can configure the behavior of the library."]]
