Send feedback
Class CloudRedisConnection (2.42.0-rc)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
Functions
virtual options()
Returns
Type Description
Options
virtual ListInstances(google::cloud::redis::v1::ListInstancesRequest)
Parameter
Name Description
request
google::cloud::redis::v1::ListInstancesRequest
Returns
Type Description
StreamRange< google::cloud::redis::v1::Instance >
virtual GetInstance(google::cloud::redis::v1::GetInstanceRequest const &)
Parameter
Name Description
request
google::cloud::redis::v1::GetInstanceRequest const &
Returns
Type Description
StatusOr< google::cloud::redis::v1::Instance >
virtual GetInstanceAuthString(google::cloud::redis::v1::GetInstanceAuthStringRequest const &)
Parameter
Name Description
request
google::cloud::redis::v1::GetInstanceAuthStringRequest const &
Returns
Type Description
StatusOr< google::cloud::redis::v1::InstanceAuthString >
virtual CreateInstance(google::cloud::redis::v1::CreateInstanceRequest const &)
Parameter
Name Description
request
google::cloud::redis::v1::CreateInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual CreateInstance(NoAwaitTag, google::cloud::redis::v1::CreateInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::redis::v1::CreateInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual CreateInstance(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual UpdateInstance(google::cloud::redis::v1::UpdateInstanceRequest const &)
Parameter
Name Description
request
google::cloud::redis::v1::UpdateInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual UpdateInstance(NoAwaitTag, google::cloud::redis::v1::UpdateInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::redis::v1::UpdateInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpdateInstance(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual UpgradeInstance(google::cloud::redis::v1::UpgradeInstanceRequest const &)
Parameter
Name Description
request
google::cloud::redis::v1::UpgradeInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual UpgradeInstance(NoAwaitTag, google::cloud::redis::v1::UpgradeInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::redis::v1::UpgradeInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpgradeInstance(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual ImportInstance(google::cloud::redis::v1::ImportInstanceRequest const &)
Parameter
Name Description
request
google::cloud::redis::v1::ImportInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual ImportInstance(NoAwaitTag, google::cloud::redis::v1::ImportInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::redis::v1::ImportInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual ImportInstance(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual ExportInstance(google::cloud::redis::v1::ExportInstanceRequest const &)
Parameter
Name Description
request
google::cloud::redis::v1::ExportInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual ExportInstance(NoAwaitTag, google::cloud::redis::v1::ExportInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::redis::v1::ExportInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual ExportInstance(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual FailoverInstance(google::cloud::redis::v1::FailoverInstanceRequest const &)
Parameter
Name Description
request
google::cloud::redis::v1::FailoverInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual FailoverInstance(NoAwaitTag, google::cloud::redis::v1::FailoverInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::redis::v1::FailoverInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual FailoverInstance(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual DeleteInstance(google::cloud::redis::v1::DeleteInstanceRequest const &)
Parameter
Name Description
request
google::cloud::redis::v1::DeleteInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::OperationMetadata > >
virtual DeleteInstance(NoAwaitTag, google::cloud::redis::v1::DeleteInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::redis::v1::DeleteInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual DeleteInstance(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::OperationMetadata > >
virtual RescheduleMaintenance(google::cloud::redis::v1::RescheduleMaintenanceRequest const &)
Parameter
Name Description
request
google::cloud::redis::v1::RescheduleMaintenanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual RescheduleMaintenance(NoAwaitTag, google::cloud::redis::v1::RescheduleMaintenanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::redis::v1::RescheduleMaintenanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual RescheduleMaintenance(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
virtual ListLocations(google::cloud::location::ListLocationsRequest)
Parameter
Name Description
request
google::cloud::location::ListLocationsRequest
Returns
Type Description
StreamRange< google::cloud::location::Location >
virtual GetLocation(google::cloud::location::GetLocationRequest const &)
Parameter
Name Description
request
google::cloud::location::GetLocationRequest const &
Returns
Type Description
StatusOr< google::cloud::location::Location >
virtual ListOperations(google::longrunning::ListOperationsRequest)
Parameter
Name Description
request
google::longrunning::ListOperationsRequest
Returns
Type Description
StreamRange< google::longrunning::Operation >
virtual GetOperation(google::longrunning::GetOperationRequest const &)
Parameter
Name Description
request
google::longrunning::GetOperationRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual DeleteOperation(google::longrunning::DeleteOperationRequest const &)
Parameter
Name Description
request
google::longrunning::DeleteOperationRequest const &
Returns
Type Description
Status
virtual CancelOperation(google::longrunning::CancelOperationRequest const &)
Parameter
Name Description
request
google::longrunning::CancelOperationRequest const &
Returns
Type Description
Status
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-14 UTC.
Need to tell us more?
[[["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-08-14 UTC."],[[["\u003cp\u003eThis document details the \u003ccode\u003eCloudRedisConnection\u003c/code\u003e object, which acts as an interface defining virtual methods for various user-facing operations within \u003ccode\u003eCloudRedisClient\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCloudRedisConnection\u003c/code\u003e allows users to customize behavior in tests by injecting mock objects, such as \u003ccode\u003eMockCloudRedisConnection\u003c/code\u003e, into \u003ccode\u003eCloudRedisClient\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the \u003ccode\u003eCloudRedisConnection\u003c/code\u003e interface is \u003ccode\u003e2.37.0-rc\u003c/code\u003e, and numerous previous versions, down to \u003ccode\u003e2.11.0\u003c/code\u003e, are also documented and available.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCloudRedisConnection\u003c/code\u003e functions include managing Redis instances through operations like creating, listing, getting, updating, upgrading, importing, exporting, failing over, deleting, and rescheduling maintenance, each with defined parameters and return types.\u003c/p\u003e\n"],["\u003cp\u003eThe document also outlines methods for managing locations and operations, including listing, getting, deleting, and canceling, within the context of \u003ccode\u003eCloudRedisConnection\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Class CloudRedisConnection (2.42.0-rc)\n\nVersion latestkeyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/redis/latest/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.41.0](/cpp/docs/reference/redis/2.41.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.40.0](/cpp/docs/reference/redis/2.40.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.39.0](/cpp/docs/reference/redis/2.39.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.38.0](/cpp/docs/reference/redis/2.38.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.37.0](/cpp/docs/reference/redis/2.37.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.36.0](/cpp/docs/reference/redis/2.36.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.35.0](/cpp/docs/reference/redis/2.35.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.34.0](/cpp/docs/reference/redis/2.34.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.33.0](/cpp/docs/reference/redis/2.33.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.32.0](/cpp/docs/reference/redis/2.32.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.31.0](/cpp/docs/reference/redis/2.31.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.30.0](/cpp/docs/reference/redis/2.30.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.29.0](/cpp/docs/reference/redis/2.29.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.28.0](/cpp/docs/reference/redis/2.28.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.27.0](/cpp/docs/reference/redis/2.27.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.26.0](/cpp/docs/reference/redis/2.26.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.25.1](/cpp/docs/reference/redis/2.25.1/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.24.0](/cpp/docs/reference/redis/2.24.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.23.0](/cpp/docs/reference/redis/2.23.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.22.1](/cpp/docs/reference/redis/2.22.1/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.21.0](/cpp/docs/reference/redis/2.21.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.20.0](/cpp/docs/reference/redis/2.20.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.19.0](/cpp/docs/reference/redis/2.19.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.18.0](/cpp/docs/reference/redis/2.18.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.17.0](/cpp/docs/reference/redis/2.17.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.16.0](/cpp/docs/reference/redis/2.16.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.15.1](/cpp/docs/reference/redis/2.15.1/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.14.0](/cpp/docs/reference/redis/2.14.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.13.0](/cpp/docs/reference/redis/2.13.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.12.0](/cpp/docs/reference/redis/2.12.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection)\n- [2.11.0](/cpp/docs/reference/redis/2.11.0/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection) \nThe [`CloudRedisConnection`](/cpp/docs/reference/redis/latest/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisConnection) object for [`CloudRedisClient`](/cpp/docs/reference/redis/latest/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisClient). \nThis interface defines virtual methods for each of the user-facing overload sets in [`CloudRedisClient`](/cpp/docs/reference/redis/latest/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisClient). This allows users to inject custom behavior (e.g., with a Google Mock object) when writing tests that use objects of type [`CloudRedisClient`](/cpp/docs/reference/redis/latest/classgoogle_1_1cloud_1_1redis__v1_1_1CloudRedisClient).\n\nTo create a concrete instance, see [`MakeCloudRedisConnection()`](/cpp/docs/reference/redis/latest/namespacegoogle_1_1cloud_1_1redis__v1).\n\nFor mocking, see [`redis_v1_mocks::MockCloudRedisConnection`](/cpp/docs/reference/redis/latest/classgoogle_1_1cloud_1_1redis__v1__mocks_1_1MockCloudRedisConnection).\n\nFunctions\n---------\n\n### virtual options()\n\n### virtual ListInstances(google::cloud::redis::v1::ListInstancesRequest)\n\n### virtual GetInstance(google::cloud::redis::v1::GetInstanceRequest const \\&)\n\n### virtual GetInstanceAuthString(google::cloud::redis::v1::GetInstanceAuthStringRequest const \\&)\n\n### virtual CreateInstance(google::cloud::redis::v1::CreateInstanceRequest const \\&)\n\n### virtual CreateInstance(NoAwaitTag, google::cloud::redis::v1::CreateInstanceRequest const \\&)\n\n### virtual CreateInstance(google::longrunning::Operation const \\&)\n\n### virtual UpdateInstance(google::cloud::redis::v1::UpdateInstanceRequest const \\&)\n\n### virtual UpdateInstance(NoAwaitTag, google::cloud::redis::v1::UpdateInstanceRequest const \\&)\n\n### virtual UpdateInstance(google::longrunning::Operation const \\&)\n\n### virtual UpgradeInstance(google::cloud::redis::v1::UpgradeInstanceRequest const \\&)\n\n### virtual UpgradeInstance(NoAwaitTag, google::cloud::redis::v1::UpgradeInstanceRequest const \\&)\n\n### virtual UpgradeInstance(google::longrunning::Operation const \\&)\n\n### virtual ImportInstance(google::cloud::redis::v1::ImportInstanceRequest const \\&)\n\n### virtual ImportInstance(NoAwaitTag, google::cloud::redis::v1::ImportInstanceRequest const \\&)\n\n### virtual ImportInstance(google::longrunning::Operation const \\&)\n\n### virtual ExportInstance(google::cloud::redis::v1::ExportInstanceRequest const \\&)\n\n### virtual ExportInstance(NoAwaitTag, google::cloud::redis::v1::ExportInstanceRequest const \\&)\n\n### virtual ExportInstance(google::longrunning::Operation const \\&)\n\n### virtual FailoverInstance(google::cloud::redis::v1::FailoverInstanceRequest const \\&)\n\n### virtual FailoverInstance(NoAwaitTag, google::cloud::redis::v1::FailoverInstanceRequest const \\&)\n\n### virtual FailoverInstance(google::longrunning::Operation const \\&)\n\n### virtual DeleteInstance(google::cloud::redis::v1::DeleteInstanceRequest const \\&)\n\n### virtual DeleteInstance(NoAwaitTag, google::cloud::redis::v1::DeleteInstanceRequest const \\&)\n\n### virtual DeleteInstance(google::longrunning::Operation const \\&)\n\n### virtual RescheduleMaintenance(google::cloud::redis::v1::RescheduleMaintenanceRequest const \\&)\n\n### virtual RescheduleMaintenance(NoAwaitTag, google::cloud::redis::v1::RescheduleMaintenanceRequest const \\&)\n\n### virtual RescheduleMaintenance(google::longrunning::Operation const \\&)\n\n### virtual ListLocations(google::cloud::location::ListLocationsRequest)\n\n### virtual GetLocation(google::cloud::location::GetLocationRequest const \\&)\n\n### virtual ListOperations(google::longrunning::ListOperationsRequest)\n\n### virtual GetOperation(google::longrunning::GetOperationRequest const \\&)\n\n### virtual DeleteOperation(google::longrunning::DeleteOperationRequest const \\&)\n\n### virtual CancelOperation(google::longrunning::CancelOperationRequest const \\&)"]]
