Class MockAlloyDBAdminConnection (2.32.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::longrunning::Operation const &)

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >

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

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >

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

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >

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

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >

virtual SwitchoverCluster(google::longrunning::Operation const &)

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >

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

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Cluster > >

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

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

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)

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::longrunning::Operation const &)

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >

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

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >

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

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::BatchCreateInstancesResponse > >

virtual UpdateInstance(google::longrunning::Operation const &)

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >

virtual DeleteInstance(google::longrunning::Operation const &)

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >

virtual FailoverInstance(google::longrunning::Operation const &)

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >

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

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Instance > >

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

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

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

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::ExecuteSqlRequest const &
Returns
Type Description
StatusOr< google::cloud::alloydb::v1::ExecuteSqlResponse >

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::longrunning::Operation const &)

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Backup > >

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

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

Parameter
Name Description
operation google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::alloydb::v1::Backup > >

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

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

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)

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

virtual ListDatabases(google::cloud::alloydb::v1::ListDatabasesRequest)

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::ListDatabasesRequest
Returns
Type Description
StreamRange< google::cloud::alloydb::v1::Database >

virtual ListLocations(google::cloud::location::ListLocationsRequest)

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::location::ListLocationsRequest
Returns
Type Description
StreamRange< google::cloud::location::Location >

virtual GetLocation(google::cloud::location::GetLocationRequest 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::location::GetLocationRequest const &
Returns
Type Description
StatusOr< google::cloud::location::Location >

virtual ListOperations(google::longrunning::ListOperationsRequest)

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::longrunning::ListOperationsRequest
Returns
Type Description
StreamRange< google::longrunning::Operation >

virtual GetOperation(google::longrunning::GetOperationRequest 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::longrunning::GetOperationRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >

virtual DeleteOperation(google::longrunning::DeleteOperationRequest 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::longrunning::DeleteOperationRequest const &
Returns
Type Description
Status

virtual CancelOperation(google::longrunning::CancelOperationRequest 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::longrunning::CancelOperationRequest const &
Returns
Type Description
Status