Send feedback
Class AlloyDBAdminConnection (2.17.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.17.0 keyboard_arrow_down
Functions
virtual options()
Returns
Type Description
Options
virtual ListClusters(google::cloud::alloydb::v1::ListClustersRequest)
Parameter
Name Description
request
google::cloud::alloydb::v1::ListClustersRequest
Returns
Type Description
StreamRange< google::cloud::alloydb::v1::Cluster >
virtual GetCluster(google::cloud::alloydb::v1::GetClusterRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::GetClusterRequest const &
Returns
Type Description
StatusOr< google::cloud::alloydb::v1::Cluster >
virtual CreateCluster(google::cloud::alloydb::v1::CreateClusterRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::CreateClusterRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >
virtual UpdateCluster(google::cloud::alloydb::v1::UpdateClusterRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::UpdateClusterRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >
virtual DeleteCluster(google::cloud::alloydb::v1::DeleteClusterRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::DeleteClusterRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >
virtual PromoteCluster(google::cloud::alloydb::v1::PromoteClusterRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::PromoteClusterRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >
virtual RestoreCluster(google::cloud::alloydb::v1::RestoreClusterRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::RestoreClusterRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >
virtual CreateSecondaryCluster(google::cloud::alloydb::v1::CreateSecondaryClusterRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::CreateSecondaryClusterRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >
virtual ListInstances(google::cloud::alloydb::v1::ListInstancesRequest)
Parameter
Name Description
request
google::cloud::alloydb::v1::ListInstancesRequest
Returns
Type Description
StreamRange< google::cloud::alloydb::v1::Instance >
virtual GetInstance(google::cloud::alloydb::v1::GetInstanceRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::GetInstanceRequest const &
Returns
Type Description
StatusOr< google::cloud::alloydb::v1::Instance >
virtual CreateInstance(google::cloud::alloydb::v1::CreateInstanceRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::CreateInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >
virtual CreateSecondaryInstance(google::cloud::alloydb::v1::CreateSecondaryInstanceRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::CreateSecondaryInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >
virtual BatchCreateInstances(google::cloud::alloydb::v1::BatchCreateInstancesRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::BatchCreateInstancesRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::BatchCreateInstancesResponse > >
virtual UpdateInstance(google::cloud::alloydb::v1::UpdateInstanceRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::UpdateInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >
virtual DeleteInstance(google::cloud::alloydb::v1::DeleteInstanceRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::DeleteInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >
virtual FailoverInstance(google::cloud::alloydb::v1::FailoverInstanceRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::FailoverInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >
virtual InjectFault(google::cloud::alloydb::v1::InjectFaultRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::InjectFaultRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >
virtual RestartInstance(google::cloud::alloydb::v1::RestartInstanceRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::RestartInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >
virtual ListBackups(google::cloud::alloydb::v1::ListBackupsRequest)
Parameter
Name Description
request
google::cloud::alloydb::v1::ListBackupsRequest
Returns
Type Description
StreamRange< google::cloud::alloydb::v1::Backup >
virtual GetBackup(google::cloud::alloydb::v1::GetBackupRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::GetBackupRequest const &
Returns
Type Description
StatusOr< google::cloud::alloydb::v1::Backup >
virtual CreateBackup(google::cloud::alloydb::v1::CreateBackupRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::CreateBackupRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Backup > >
virtual UpdateBackup(google::cloud::alloydb::v1::UpdateBackupRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::UpdateBackupRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Backup > >
virtual DeleteBackup(google::cloud::alloydb::v1::DeleteBackupRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::DeleteBackupRequest const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >
virtual ListSupportedDatabaseFlags(google::cloud::alloydb::v1::ListSupportedDatabaseFlagsRequest)
Parameter
Name Description
request
google::cloud::alloydb::v1::ListSupportedDatabaseFlagsRequest
Returns
Type Description
StreamRange< google::cloud::alloydb::v1::SupportedDatabaseFlag >
virtual GenerateClientCertificate(google::cloud::alloydb::v1::GenerateClientCertificateRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::GenerateClientCertificateRequest const &
Returns
Type Description
StatusOr< google::cloud::alloydb::v1::GenerateClientCertificateResponse >
virtual GetConnectionInfo(google::cloud::alloydb::v1::GetConnectionInfoRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::GetConnectionInfoRequest const &
Returns
Type Description
StatusOr< google::cloud::alloydb::v1::ConnectionInfo >
virtual ListUsers(google::cloud::alloydb::v1::ListUsersRequest)
Parameter
Name Description
request
google::cloud::alloydb::v1::ListUsersRequest
Returns
Type Description
StreamRange< google::cloud::alloydb::v1::User >
virtual GetUser(google::cloud::alloydb::v1::GetUserRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::GetUserRequest const &
Returns
Type Description
StatusOr< google::cloud::alloydb::v1::User >
virtual CreateUser(google::cloud::alloydb::v1::CreateUserRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::CreateUserRequest const &
Returns
Type Description
StatusOr< google::cloud::alloydb::v1::User >
virtual UpdateUser(google::cloud::alloydb::v1::UpdateUserRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::UpdateUserRequest const &
Returns
Type Description
StatusOr< google::cloud::alloydb::v1::User >
virtual DeleteUser(google::cloud::alloydb::v1::DeleteUserRequest const &)
Parameter
Name Description
request
google::cloud::alloydb::v1::DeleteUserRequest 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-03-21 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-03-21 UTC."],[[["This document details the `AlloyDBAdminConnection` object, which provides an interface for interacting with `AlloyDBAdminClient` functionalities and allows for the injection of custom behaviors during testing."],["The document includes an extensive list of virtual methods for managing AlloyDB resources, such as clusters, instances, backups, users, and supported database flags, each with detailed parameter and return type information."],["Users can utilize the `MakeAlloyDBAdminConnection()` function to create concrete instances of the `AlloyDBAdminConnection`, while `MockAlloyDBAdminConnection` is available for mocking purposes during testing."],["A comprehensive list of available versions for `AlloyDBAdminConnection` is provided, starting from version 2.11.0 up to the latest release candidate, 2.37.0-rc."],["The functions described allows for creating, updating, deleting, and retrieving information for the many entities of AlloyDB, including clusters, backups, and users."]]],[]]
