Class AlloyDBAdminConnection (2.26.0)

Version 2.26.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

The AlloyDBAdminConnection object for AlloyDBAdminClient.

This interface defines virtual methods for each of the user-facing overload sets in AlloyDBAdminClient. This allows users to inject custom behavior (e.g., with a Google Mock object) when writing tests that use objects of type AlloyDBAdminClient.

To create a concrete instance, see MakeAlloyDBAdminConnection().

For mocking, see alloydb_v1_mocks::MockAlloyDBAdminConnection.

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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::CreateClusterRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::CreateClusterRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual CreateCluster(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::UpdateClusterRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::UpdateClusterRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual UpdateCluster(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
operation	google::longrunning::Operation 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 DeleteCluster(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::DeleteClusterRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::DeleteClusterRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual DeleteCluster(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::PromoteClusterRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::PromoteClusterRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual PromoteCluster(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::RestoreClusterRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::RestoreClusterRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual RestoreCluster(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::CreateSecondaryClusterRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::CreateSecondaryClusterRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual CreateSecondaryCluster(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::CreateInstanceRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::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::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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::CreateSecondaryInstanceRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::CreateSecondaryInstanceRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual CreateSecondaryInstance(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::BatchCreateInstancesRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::BatchCreateInstancesRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual BatchCreateInstances(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::UpdateInstanceRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::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::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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::DeleteInstanceRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::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::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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::FailoverInstanceRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::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::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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::InjectFaultRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::InjectFaultRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual InjectFault(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::RestartInstanceRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::RestartInstanceRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual RestartInstance(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
operation	google::longrunning::Operation 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 CreateBackup(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::CreateBackupRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::CreateBackupRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual CreateBackup(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::UpdateBackupRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::UpdateBackupRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual UpdateBackup(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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(ExperimentalTag, NoAwaitTag, google::cloud::alloydb::v1::DeleteBackupRequest const &)

Parameters
Name	Description
	ExperimentalTag
	NoAwaitTag
request	google::cloud::alloydb::v1::DeleteBackupRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual DeleteBackup(ExperimentalTag, google::longrunning::Operation const &)

Parameters
Name	Description
	ExperimentalTag
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