Some or all of the information on this page might not apply to Trusted Cloud by S3NS.
Class AlloyDBAdminConnection (2.41.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.41.0keyboard_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 CreateCluster(NoAwaitTag, google::cloud::alloydb::v1::CreateClusterRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::CreateClusterRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual CreateCluster(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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 UpdateCluster(NoAwaitTag, google::cloud::alloydb::v1::UpdateClusterRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::UpdateClusterRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual UpdateCluster(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation const &
Returns
Type
Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >
virtual ExportCluster(google::cloud::alloydb::v1::ExportClusterRequest const &)
Parameter
Name
Description
request
google::cloud::alloydb::v1::ExportClusterRequest const &
Returns
Type
Description
future< StatusOr< google::cloud::alloydb::v1::ExportClusterResponse > >
virtual ExportCluster(NoAwaitTag, google::cloud::alloydb::v1::ExportClusterRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::ExportClusterRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual ExportCluster(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation const &
Returns
Type
Description
future< StatusOr< google::cloud::alloydb::v1::ExportClusterResponse > >
virtual ImportCluster(google::cloud::alloydb::v1::ImportClusterRequest const &)
Parameter
Name
Description
request
google::cloud::alloydb::v1::ImportClusterRequest const &
Returns
Type
Description
future< StatusOr< google::cloud::alloydb::v1::ImportClusterResponse > >
virtual ImportCluster(NoAwaitTag, google::cloud::alloydb::v1::ImportClusterRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::ImportClusterRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual ImportCluster(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation const &
Returns
Type
Description
future< StatusOr< google::cloud::alloydb::v1::ImportClusterResponse > >
virtual UpgradeCluster(google::cloud::alloydb::v1::UpgradeClusterRequest const &)
Parameter
Name
Description
request
google::cloud::alloydb::v1::UpgradeClusterRequest const &
Returns
Type
Description
future< StatusOr< google::cloud::alloydb::v1::UpgradeClusterResponse > >
virtual UpgradeCluster(NoAwaitTag, google::cloud::alloydb::v1::UpgradeClusterRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::UpgradeClusterRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual UpgradeCluster(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation const &
Returns
Type
Description
future< StatusOr< google::cloud::alloydb::v1::UpgradeClusterResponse > >
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 DeleteCluster(NoAwaitTag, google::cloud::alloydb::v1::DeleteClusterRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::DeleteClusterRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual DeleteCluster(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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 PromoteCluster(NoAwaitTag, google::cloud::alloydb::v1::PromoteClusterRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::PromoteClusterRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual PromoteCluster(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation const &
Returns
Type
Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >
virtual SwitchoverCluster(google::cloud::alloydb::v1::SwitchoverClusterRequest const &)
Parameter
Name
Description
request
google::cloud::alloydb::v1::SwitchoverClusterRequest const &
Returns
Type
Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >
virtual SwitchoverCluster(NoAwaitTag, google::cloud::alloydb::v1::SwitchoverClusterRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::SwitchoverClusterRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual SwitchoverCluster(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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 RestoreCluster(NoAwaitTag, google::cloud::alloydb::v1::RestoreClusterRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::RestoreClusterRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual RestoreCluster(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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 CreateSecondaryCluster(NoAwaitTag, google::cloud::alloydb::v1::CreateSecondaryClusterRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::CreateSecondaryClusterRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual CreateSecondaryCluster(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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 CreateInstance(NoAwaitTag, google::cloud::alloydb::v1::CreateInstanceRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::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::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 CreateSecondaryInstance(NoAwaitTag, google::cloud::alloydb::v1::CreateSecondaryInstanceRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::CreateSecondaryInstanceRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual CreateSecondaryInstance(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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 BatchCreateInstances(NoAwaitTag, google::cloud::alloydb::v1::BatchCreateInstancesRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::BatchCreateInstancesRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual BatchCreateInstances(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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 UpdateInstance(NoAwaitTag, google::cloud::alloydb::v1::UpdateInstanceRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::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::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 DeleteInstance(NoAwaitTag, google::cloud::alloydb::v1::DeleteInstanceRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::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::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 FailoverInstance(NoAwaitTag, google::cloud::alloydb::v1::FailoverInstanceRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::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::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 InjectFault(NoAwaitTag, google::cloud::alloydb::v1::InjectFaultRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::InjectFaultRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual InjectFault(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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 RestartInstance(NoAwaitTag, google::cloud::alloydb::v1::RestartInstanceRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::RestartInstanceRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual RestartInstance(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation const &
Returns
Type
Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >
virtual ExecuteSql(google::cloud::alloydb::v1::ExecuteSqlRequest const &)
Parameter
Name
Description
request
google::cloud::alloydb::v1::ExecuteSqlRequest const &
Returns
Type
Description
StatusOr< google::cloud::alloydb::v1::ExecuteSqlResponse >
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 CreateBackup(NoAwaitTag, google::cloud::alloydb::v1::CreateBackupRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::CreateBackupRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual CreateBackup(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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 UpdateBackup(NoAwaitTag, google::cloud::alloydb::v1::UpdateBackupRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::UpdateBackupRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual UpdateBackup(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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 DeleteBackup(NoAwaitTag, google::cloud::alloydb::v1::DeleteBackupRequest const &)
Parameters
Name
Description
NoAwaitTag
request
google::cloud::alloydb::v1::DeleteBackupRequest const &
Returns
Type
Description
StatusOr< google::longrunning::Operation >
virtual DeleteBackup(google::longrunning::Operation const &)
Parameter
Name
Description
operation
google::longrunning::Operation 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
virtual ListDatabases(google::cloud::alloydb::v1::ListDatabasesRequest)
Parameter
Name
Description
request
google::cloud::alloydb::v1::ListDatabasesRequest
Returns
Type
Description
StreamRange< google::cloud::alloydb::v1::Database >
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."],[],[]]