Class MockAlloyDBAdminConnection (2.23.0)

A class to mock AlloyDBAdminConnection.

Application developers may want to test their code with simulated responses, including errors, from an object of type AlloyDBAdminClient. To do so, construct an object of type AlloyDBAdminClient with an instance of this class. Then use the Google Test framework functions to program the behavior of this mock.

See Also

This example for how to test your application with GoogleTest. While the example showcases types from the BigQuery library, the underlying principles apply for any pair of *Client and *Connection.

Functions

virtual options()

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

Returns
Type Description
Options

virtual ListClusters(google::cloud::alloydb::v1::ListClustersRequest)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

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 &)

This function is implemented using gMock's MOCK_METHOD(). Consult the gMock documentation to use this mock in your tests.

Parameter
Name Description
request google::cloud::alloydb::v1::DeleteUserRequest const &
Returns
Type Description
Status