Google Cloud Spanner C++ Client  1.32.1
A C++ Client Library for Google Cloud Spanner
Classes | Public Member Functions | List of all members
google::cloud::spanner::v1::DatabaseAdminConnection Class Referenceabstract

A connection to the Cloud Spanner instance administration service. More...

#include <google/cloud/spanner/database_admin_connection.h>

Classes

struct  CreateBackupParams
 Wrap the arguments for CreateBackup(). More...
 
struct  CreateDatabaseParams
 Wrap the arguments for CreateDatabase(). More...
 
struct  DeleteBackupParams
 Wrap the arguments for DeleteBackup(). More...
 
struct  DropDatabaseParams
 Wrap the arguments for DropDatabase(). More...
 
struct  GetBackupParams
 Wrap the arguments for GetBackup(). More...
 
struct  GetDatabaseDdlParams
 Wrap the arguments for GetDatabaseDdl(). More...
 
struct  GetDatabaseParams
 Wrap the arguments for GetDatabase(). More...
 
struct  GetIamPolicyParams
 Wrap the arguments for GetIamPolicy(). More...
 
struct  ListBackupOperationsParams
 Wrap the arguments for ListBackupOperations(). More...
 
struct  ListBackupsParams
 Wrap the arguments for ListBackups(). More...
 
struct  ListDatabaseOperationsParams
 Wrap the arguments for ListDatabaseOperations(). More...
 
struct  ListDatabasesParams
 Wrap the arguments for ListDatabases(). More...
 
struct  RestoreDatabaseParams
 Wrap the arguments for RestoreDatabase(). More...
 
struct  SetIamPolicyParams
 Wrap the arguments for SetIamPolicy(). More...
 
struct  TestIamPermissionsParams
 Wrap the arguments for TestIamPermissions(). More...
 
struct  UpdateBackupParams
 Wrap the arguments for UpdateBackup(). More...
 
struct  UpdateDatabaseParams
 Wrap the arguments for UpdateDatabase(). More...
 

Public Member Functions

virtual ~DatabaseAdminConnection ()=0
 
Define the arguments for each member function.

Applications may define classes derived from DatabaseAdminConnection, for example, because they want to mock the class.

To avoid breaking all such derived classes when we change the number or type of the arguments to the member functions we define light weight structures to pass the arguments.

virtual future< StatusOr< google::spanner::admin::database::v1::Database > > CreateDatabase (CreateDatabaseParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.CreateDatabase RPC. More...
 
virtual StatusOr< google::spanner::admin::database::v1::Database > GetDatabase (GetDatabaseParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.GetDatabase RPC. More...
 
virtual StatusOr< google::spanner::admin::database::v1::GetDatabaseDdlResponse > GetDatabaseDdl (GetDatabaseDdlParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.GetDatabaseDdl RPC. More...
 
virtual future< StatusOr< google::spanner::admin::database::v1::UpdateDatabaseDdlMetadata > > UpdateDatabase (UpdateDatabaseParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.UpdateDatabase RPC. More...
 
virtual Status DropDatabase (DropDatabaseParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.DropDatabase RPC. More...
 
virtual ListDatabaseRange ListDatabases (ListDatabasesParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.DropDatabase RPC. More...
 
virtual future< StatusOr< google::spanner::admin::database::v1::Database > > RestoreDatabase (RestoreDatabaseParams)
 Define the interface for a google.spanner.v1.DatabaseAdmin.RestoreDatabase RPC. More...
 
virtual StatusOr< google::iam::v1::Policy > GetIamPolicy (GetIamPolicyParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.GetIamPolicy RPC. More...
 
virtual StatusOr< google::iam::v1::Policy > SetIamPolicy (SetIamPolicyParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.SetIamPolicy RPC. More...
 
virtual StatusOr< google::iam::v1::TestIamPermissionsResponse > TestIamPermissions (TestIamPermissionsParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.TestIamPermissions RPC. More...
 
virtual future< StatusOr< google::spanner::admin::database::v1::Backup > > CreateBackup (CreateBackupParams)
 Define the interface for a google.spanner.v1.DatabaseAdmin.CreateBackup RPC. More...
 
virtual StatusOr< google::spanner::admin::database::v1::Backup > GetBackup (GetBackupParams)
 Define the interface for a google.spanner.v1.DatabaseAdmin.GetBackup RPC. More...
 
virtual Status DeleteBackup (DeleteBackupParams)
 Define the interface for a google.spanner.v1.DatabaseAdmin.DeleteBackup RPC. More...
 
virtual ListBackupsRange ListBackups (ListBackupsParams)
 Define the interface for a google.spanner.v1.DatabaseAdmin.ListBackups RPC. More...
 
virtual StatusOr< google::spanner::admin::database::v1::Backup > UpdateBackup (UpdateBackupParams)
 Define the interface for a google.spanner.v1.DatabaseAdmin.UpdateBackup RPC. More...
 
virtual ListBackupOperationsRange ListBackupOperations (ListBackupOperationsParams)
 Define the interface for a google.spanner.v1.DatabaseAdmin.ListBackupOperations RPC. More...
 
virtual ListDatabaseOperationsRange ListDatabaseOperations (ListDatabaseOperationsParams)
 Define the interface for a google.spanner.v1.DatabaseAdmin.ListDatabaseOperations RPC. More...
 

Detailed Description

A connection to the Cloud Spanner instance administration service.

This interface defines pure-virtual methods for each of the user-facing overload sets in DatabaseAdminClient. This allows users to inject custom behavior (e.g., with a Google Mock object) in a DatabaseAdminClient object for use in their own tests.

To create a concrete instance that connects you to a real Cloud Spanner instance administration service, see MakeDatabaseAdminConnection().

Definition at line 100 of file database_admin_connection.h.

Constructor & Destructor Documentation

◆ ~DatabaseAdminConnection()

google::cloud::spanner::v1::DatabaseAdminConnection::~DatabaseAdminConnection ( )
pure virtualdefault

Member Function Documentation

◆ CreateBackup()

future< StatusOr< google::spanner::admin::database::v1::Backup > > google::cloud::spanner::v1::DatabaseAdminConnection::CreateBackup ( CreateBackupParams  )
virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.CreateBackup RPC.

Definition at line 41 of file database_admin_connection.cc.

◆ CreateDatabase()

virtual future<StatusOr<google::spanner::admin::database::v1::Database> > google::cloud::spanner::v1::DatabaseAdminConnection::CreateDatabase ( CreateDatabaseParams  )
pure virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.CreateDatabase RPC.

◆ DeleteBackup()

Status google::cloud::spanner::v1::DatabaseAdminConnection::DeleteBackup ( DeleteBackupParams  )
virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.DeleteBackup RPC.

Definition at line 60 of file database_admin_connection.cc.

◆ DropDatabase()

virtual Status google::cloud::spanner::v1::DatabaseAdminConnection::DropDatabase ( DropDatabaseParams  )
pure virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.DropDatabase RPC.

◆ GetBackup()

StatusOr< google::spanner::admin::database::v1::Backup > google::cloud::spanner::v1::DatabaseAdminConnection::GetBackup ( GetBackupParams  )
virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.GetBackup RPC.

Definition at line 55 of file database_admin_connection.cc.

◆ GetDatabase()

virtual StatusOr<google::spanner::admin::database::v1::Database> google::cloud::spanner::v1::DatabaseAdminConnection::GetDatabase ( GetDatabaseParams  )
pure virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.GetDatabase RPC.

◆ GetDatabaseDdl()

virtual StatusOr<google::spanner::admin::database::v1::GetDatabaseDdlResponse> google::cloud::spanner::v1::DatabaseAdminConnection::GetDatabaseDdl ( GetDatabaseDdlParams  )
pure virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.GetDatabaseDdl RPC.

◆ GetIamPolicy()

virtual StatusOr<google::iam::v1::Policy> google::cloud::spanner::v1::DatabaseAdminConnection::GetIamPolicy ( GetIamPolicyParams  )
pure virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.GetIamPolicy RPC.

◆ ListBackupOperations()

ListBackupOperationsRange google::cloud::spanner::v1::DatabaseAdminConnection::ListBackupOperations ( ListBackupOperationsParams  )
virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.ListBackupOperations RPC.

Definition at line 83 of file database_admin_connection.cc.

◆ ListBackups()

ListBackupsRange google::cloud::spanner::v1::DatabaseAdminConnection::ListBackups ( ListBackupsParams  )
virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.ListBackups RPC.

Definition at line 65 of file database_admin_connection.cc.

◆ ListDatabaseOperations()

ListDatabaseOperationsRange google::cloud::spanner::v1::DatabaseAdminConnection::ListDatabaseOperations ( ListDatabaseOperationsParams  )
virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.ListDatabaseOperations RPC.

Definition at line 98 of file database_admin_connection.cc.

◆ ListDatabases()

virtual ListDatabaseRange google::cloud::spanner::v1::DatabaseAdminConnection::ListDatabases ( ListDatabasesParams  )
pure virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.DropDatabase RPC.

◆ RestoreDatabase()

future< StatusOr< google::spanner::admin::database::v1::Database > > google::cloud::spanner::v1::DatabaseAdminConnection::RestoreDatabase ( RestoreDatabaseParams  )
virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.RestoreDatabase RPC.

Definition at line 48 of file database_admin_connection.cc.

◆ SetIamPolicy()

virtual StatusOr<google::iam::v1::Policy> google::cloud::spanner::v1::DatabaseAdminConnection::SetIamPolicy ( SetIamPolicyParams  )
pure virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.SetIamPolicy RPC.

◆ TestIamPermissions()

virtual StatusOr<google::iam::v1::TestIamPermissionsResponse> google::cloud::spanner::v1::DatabaseAdminConnection::TestIamPermissions ( TestIamPermissionsParams  )
pure virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.TestIamPermissions RPC.

◆ UpdateBackup()

StatusOr< google::spanner::admin::database::v1::Backup > google::cloud::spanner::v1::DatabaseAdminConnection::UpdateBackup ( UpdateBackupParams  )
virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.UpdateBackup RPC.

Definition at line 79 of file database_admin_connection.cc.

◆ UpdateDatabase()

virtual future< StatusOr<google::spanner::admin::database::v1::UpdateDatabaseDdlMetadata> > google::cloud::spanner::v1::DatabaseAdminConnection::UpdateDatabase ( UpdateDatabaseParams  )
pure virtual

Define the interface for a google.spanner.v1.DatabaseAdmin.UpdateDatabase RPC.