Class CloudRedisConnection (2.26.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 2.26.0keyboard_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(ExperimentalTag, NoAwaitTag, google::cloud::redis::v1::CreateInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::redis::v1::CreateInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual CreateInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::redis::v1::UpdateInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::redis::v1::UpdateInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpdateInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::redis::v1::UpgradeInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::redis::v1::UpgradeInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpgradeInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::redis::v1::ImportInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::redis::v1::ImportInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual ImportInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::redis::v1::ExportInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::redis::v1::ExportInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual ExportInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::redis::v1::FailoverInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::redis::v1::FailoverInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual FailoverInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::redis::v1::DeleteInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::redis::v1::DeleteInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual DeleteInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::redis::v1::RescheduleMaintenanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::redis::v1::RescheduleMaintenanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual RescheduleMaintenance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::redis::v1::Instance > >
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.
[[["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 details the \u003ccode\u003eCloudRedisConnection\u003c/code\u003e interface, which defines virtual methods for each user-facing overload set in \u003ccode\u003eCloudRedisClient\u003c/code\u003e, allowing for custom behavior injection during testing.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCloudRedisConnection\u003c/code\u003e class supports a range of operations, including listing, getting, creating, updating, upgrading, importing, exporting, failing over, deleting, and rescheduling maintenance for Redis instances.\u003c/p\u003e\n"],["\u003cp\u003eThe interface allows for creating concrete instances via \u003ccode\u003eMakeCloudRedisConnection()\u003c/code\u003e and mocking via \u003ccode\u003eredis_v1_mocks::MockCloudRedisConnection\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThere is a list of CloudRedisConnection versions going as far back as version 2.11.0, and as recently as 2.37.0-rc, with links to each individual version's documenation.\u003c/p\u003e\n"],["\u003cp\u003eThe interface includes functions that return \u003ccode\u003eStatusOr\u003c/code\u003e or \u003ccode\u003efuture< StatusOr<>>\u003c/code\u003e types, dealing with operations on Redis instances and offering experimental, no-await options.\u003c/p\u003e\n"]]],[],null,[]]
