Class CloudRedisConnection (2.42.0-rc)
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 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
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 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,[]]
