Google Cloud Bigtable C++ Client  1.32.1
A C++ Client Library for Google Cloud Bigtable
Public Member Functions | Friends | List of all members
google::cloud::bigtable::v1::AdminClient Class Referenceabstract

Connects to Cloud Bigtable's table administration APIs. More...

#include <google/cloud/bigtable/admin_client.h>

Public Member Functions

virtual ~AdminClient ()=default
 
virtual std::string const & project () const =0
 The project that this AdminClient works on. More...
 
virtual std::shared_ptr< grpc::Channel > Channel ()=0
 Return a new channel to handle admin operations. More...
 
virtual void reset ()=0
 Reset and create new Channels. More...
 
virtual google::cloud::BackgroundThreadsFactory BackgroundThreadsFactory ()=0
 The thread factory this client was created with. More...
 

Protected Member Functions

The <tt>google.bigtable.admin.v2.TableAdmin</tt> operations.
virtual grpc::Status CreateTable (grpc::ClientContext *context, google::bigtable::admin::v2::CreateTableRequest const &request, google::bigtable::admin::v2::Table *response)=0
 
virtual grpc::Status ListTables (grpc::ClientContext *context, google::bigtable::admin::v2::ListTablesRequest const &request, google::bigtable::admin::v2::ListTablesResponse *response)=0
 
virtual grpc::Status GetTable (grpc::ClientContext *context, google::bigtable::admin::v2::GetTableRequest const &request, google::bigtable::admin::v2::Table *response)=0
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Table > > AsyncGetTable (grpc::ClientContext *context, google::bigtable::admin::v2::GetTableRequest const &request, grpc::CompletionQueue *cq)=0
 
virtual grpc::Status DeleteTable (grpc::ClientContext *context, google::bigtable::admin::v2::DeleteTableRequest const &request, google::protobuf::Empty *response)=0
 
virtual grpc::Status CreateBackup (grpc::ClientContext *context, google::bigtable::admin::v2::CreateBackupRequest const &request, google::longrunning::Operation *response)
 
virtual grpc::Status GetBackup (grpc::ClientContext *context, google::bigtable::admin::v2::GetBackupRequest const &request, google::bigtable::admin::v2::Backup *response)
 
virtual grpc::Status UpdateBackup (grpc::ClientContext *context, google::bigtable::admin::v2::UpdateBackupRequest const &request, google::bigtable::admin::v2::Backup *response)
 
virtual grpc::Status DeleteBackup (grpc::ClientContext *context, google::bigtable::admin::v2::DeleteBackupRequest const &request, google::protobuf::Empty *response)
 
virtual grpc::Status ListBackups (grpc::ClientContext *context, google::bigtable::admin::v2::ListBackupsRequest const &request, google::bigtable::admin::v2::ListBackupsResponse *response)
 
virtual grpc::Status RestoreTable (grpc::ClientContext *context, google::bigtable::admin::v2::RestoreTableRequest const &request, google::longrunning::Operation *response)
 
virtual grpc::Status ModifyColumnFamilies (grpc::ClientContext *context, google::bigtable::admin::v2::ModifyColumnFamiliesRequest const &request, google::bigtable::admin::v2::Table *response)=0
 
virtual grpc::Status DropRowRange (grpc::ClientContext *context, google::bigtable::admin::v2::DropRowRangeRequest const &request, google::protobuf::Empty *response)=0
 
virtual grpc::Status GenerateConsistencyToken (grpc::ClientContext *context, google::bigtable::admin::v2::GenerateConsistencyTokenRequest const &request, google::bigtable::admin::v2::GenerateConsistencyTokenResponse *response)=0
 
virtual grpc::Status CheckConsistency (grpc::ClientContext *context, google::bigtable::admin::v2::CheckConsistencyRequest const &request, google::bigtable::admin::v2::CheckConsistencyResponse *response)=0
 
virtual grpc::Status GetIamPolicy (grpc::ClientContext *context, google::iam::v1::GetIamPolicyRequest const &request, google::iam::v1::Policy *response)=0
 
virtual grpc::Status SetIamPolicy (grpc::ClientContext *context, google::iam::v1::SetIamPolicyRequest const &request, google::iam::v1::Policy *response)=0
 
virtual grpc::Status TestIamPermissions (grpc::ClientContext *context, google::iam::v1::TestIamPermissionsRequest const &request, google::iam::v1::TestIamPermissionsResponse *response)=0
 
The <tt>google.longrunning.Operations</tt> wrappers.
virtual grpc::Status GetOperation (grpc::ClientContext *context, google::longrunning::GetOperationRequest const &request, google::longrunning::Operation *response)=0
 
The <tt>google.bigtable.admin.v2.TableAdmin</tt> Async operations.
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Table > > AsyncCreateTable (grpc::ClientContext *context, google::bigtable::admin::v2::CreateTableRequest const &request, grpc::CompletionQueue *cq)=0
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::protobuf::Empty > > AsyncDeleteTable (grpc::ClientContext *context, google::bigtable::admin::v2::DeleteTableRequest const &request, grpc::CompletionQueue *cq)=0
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::longrunning::Operation > > AsyncCreateBackup (grpc::ClientContext *context, google::bigtable::admin::v2::CreateBackupRequest const &request, grpc::CompletionQueue *cq)
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Backup > > AsyncGetBackup (grpc::ClientContext *context, google::bigtable::admin::v2::GetBackupRequest const &request, grpc::CompletionQueue *cq)
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Backup > > AsyncUpdateBackup (grpc::ClientContext *context, google::bigtable::admin::v2::UpdateBackupRequest const &request, grpc::CompletionQueue *cq)
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::protobuf::Empty > > AsyncDeleteBackup (grpc::ClientContext *context, google::bigtable::admin::v2::DeleteBackupRequest const &request, grpc::CompletionQueue *cq)
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::ListBackupsResponse > > AsyncListBackups (grpc::ClientContext *context, google::bigtable::admin::v2::ListBackupsRequest const &request, grpc::CompletionQueue *cq)
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::longrunning::Operation > > AsyncRestoreTable (grpc::ClientContext *context, google::bigtable::admin::v2::RestoreTableRequest const &request, grpc::CompletionQueue *cq)
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Table > > AsyncModifyColumnFamilies (grpc::ClientContext *context, google::bigtable::admin::v2::ModifyColumnFamiliesRequest const &request, grpc::CompletionQueue *cq)=0
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::protobuf::Empty > > AsyncDropRowRange (grpc::ClientContext *context, google::bigtable::admin::v2::DropRowRangeRequest const &request, grpc::CompletionQueue *cq)=0
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::GenerateConsistencyTokenResponse > > AsyncGenerateConsistencyToken (grpc::ClientContext *context, google::bigtable::admin::v2::GenerateConsistencyTokenRequest const &request, grpc::CompletionQueue *cq)=0
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::CheckConsistencyResponse > > AsyncCheckConsistency (grpc::ClientContext *context, google::bigtable::admin::v2::CheckConsistencyRequest const &request, grpc::CompletionQueue *cq)=0
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::ListTablesResponse > > AsyncListTables (grpc::ClientContext *context, google::bigtable::admin::v2::ListTablesRequest const &request, grpc::CompletionQueue *cq)=0
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::iam::v1::Policy > > AsyncGetIamPolicy (grpc::ClientContext *context, google::iam::v1::GetIamPolicyRequest const &request, grpc::CompletionQueue *cq)=0
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::iam::v1::Policy > > AsyncSetIamPolicy (grpc::ClientContext *context, google::iam::v1::SetIamPolicyRequest const &request, grpc::CompletionQueue *cq)=0
 
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::iam::v1::TestIamPermissionsResponse > > AsyncTestIamPermissions (grpc::ClientContext *context, google::iam::v1::TestIamPermissionsRequest const &request, grpc::CompletionQueue *cq)=0
 
The <tt>google.longrunning.Operations</tt> async wrappers.
virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::longrunning::Operation > > AsyncGetOperation (grpc::ClientContext *context, google::longrunning::GetOperationRequest const &request, grpc::CompletionQueue *cq)=0
 

Friends

class TableAdmin
 

Detailed Description

Connects to Cloud Bigtable's table administration APIs.

This class is used by the Cloud Bigtable wrappers to access Cloud Bigtable. Multiple bigtable::TableAdmin objects may share a connection via a single AdminClient object. The AdminClient object is configured at construction time, this configuration includes the credentials, access endpoints, default timeouts, and other gRPC configuration options. This is an interface class because it is also used as a dependency injection point in some of the tests.

Cost
Applications should avoid unnecessarily creating new objects of type AdminClient. Creating a new object of this type typically requires connecting to the Cloud Bigtable servers, and performing the authentication workflows with Google Cloud Platform. These operations can take many milliseconds, therefore applications should try to reuse the same AdminClient instances when possible.

Definition at line 55 of file admin_client.h.

Constructor & Destructor Documentation

◆ ~AdminClient()

virtual google::cloud::bigtable::v1::AdminClient::~AdminClient ( )
virtualdefault

Member Function Documentation

◆ AsyncCheckConsistency()

virtual std::unique_ptr<grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::CheckConsistencyResponse> > google::cloud::bigtable::v1::AdminClient::AsyncCheckConsistency ( grpc::ClientContext *  context,
google::bigtable::admin::v2::CheckConsistencyRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncCreateBackup()

std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::longrunning::Operation > > google::cloud::bigtable::v1::AdminClient::AsyncCreateBackup ( grpc::ClientContext *  context,
google::bigtable::admin::v2::CreateBackupRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedvirtual

Definition at line 68 of file admin_client.cc.

◆ AsyncCreateTable()

virtual std::unique_ptr<grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Table> > google::cloud::bigtable::v1::AdminClient::AsyncCreateTable ( grpc::ClientContext *  context,
google::bigtable::admin::v2::CreateTableRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncDeleteBackup()

std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::protobuf::Empty > > google::cloud::bigtable::v1::AdminClient::AsyncDeleteBackup ( grpc::ClientContext *  context,
google::bigtable::admin::v2::DeleteBackupRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedvirtual

Definition at line 94 of file admin_client.cc.

◆ AsyncDeleteTable()

virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface<google::protobuf::Empty> > google::cloud::bigtable::v1::AdminClient::AsyncDeleteTable ( grpc::ClientContext *  context,
google::bigtable::admin::v2::DeleteTableRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncDropRowRange()

virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface<google::protobuf::Empty> > google::cloud::bigtable::v1::AdminClient::AsyncDropRowRange ( grpc::ClientContext *  context,
google::bigtable::admin::v2::DropRowRangeRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncGenerateConsistencyToken()

virtual std::unique_ptr<grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::GenerateConsistencyTokenResponse> > google::cloud::bigtable::v1::AdminClient::AsyncGenerateConsistencyToken ( grpc::ClientContext *  context,
google::bigtable::admin::v2::GenerateConsistencyTokenRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncGetBackup()

std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Backup > > google::cloud::bigtable::v1::AdminClient::AsyncGetBackup ( grpc::ClientContext *  context,
google::bigtable::admin::v2::GetBackupRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedvirtual

Definition at line 77 of file admin_client.cc.

◆ AsyncGetIamPolicy()

virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface<google::iam::v1::Policy> > google::cloud::bigtable::v1::AdminClient::AsyncGetIamPolicy ( grpc::ClientContext *  context,
google::iam::v1::GetIamPolicyRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncGetOperation()

virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface<google::longrunning::Operation> > google::cloud::bigtable::v1::AdminClient::AsyncGetOperation ( grpc::ClientContext *  context,
google::longrunning::GetOperationRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncGetTable()

virtual std::unique_ptr<grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Table> > google::cloud::bigtable::v1::AdminClient::AsyncGetTable ( grpc::ClientContext *  context,
google::bigtable::admin::v2::GetTableRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncListBackups()

std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::ListBackupsResponse > > google::cloud::bigtable::v1::AdminClient::AsyncListBackups ( grpc::ClientContext *  context,
google::bigtable::admin::v2::ListBackupsRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedvirtual

Definition at line 103 of file admin_client.cc.

◆ AsyncListTables()

virtual std::unique_ptr<grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::ListTablesResponse> > google::cloud::bigtable::v1::AdminClient::AsyncListTables ( grpc::ClientContext *  context,
google::bigtable::admin::v2::ListTablesRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncModifyColumnFamilies()

virtual std::unique_ptr<grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Table> > google::cloud::bigtable::v1::AdminClient::AsyncModifyColumnFamilies ( grpc::ClientContext *  context,
google::bigtable::admin::v2::ModifyColumnFamiliesRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncRestoreTable()

std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::longrunning::Operation > > google::cloud::bigtable::v1::AdminClient::AsyncRestoreTable ( grpc::ClientContext *  context,
google::bigtable::admin::v2::RestoreTableRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedvirtual

Definition at line 112 of file admin_client.cc.

◆ AsyncSetIamPolicy()

virtual std::unique_ptr< grpc::ClientAsyncResponseReaderInterface<google::iam::v1::Policy> > google::cloud::bigtable::v1::AdminClient::AsyncSetIamPolicy ( grpc::ClientContext *  context,
google::iam::v1::SetIamPolicyRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncTestIamPermissions()

virtual std::unique_ptr<grpc::ClientAsyncResponseReaderInterface< google::iam::v1::TestIamPermissionsResponse> > google::cloud::bigtable::v1::AdminClient::AsyncTestIamPermissions ( grpc::ClientContext *  context,
google::iam::v1::TestIamPermissionsRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedpure virtual

◆ AsyncUpdateBackup()

std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Backup > > google::cloud::bigtable::v1::AdminClient::AsyncUpdateBackup ( grpc::ClientContext *  context,
google::bigtable::admin::v2::UpdateBackupRequest const &  request,
grpc::CompletionQueue *  cq 
)
protectedvirtual

Definition at line 85 of file admin_client.cc.

◆ BackgroundThreadsFactory()

virtual google::cloud::BackgroundThreadsFactory google::cloud::bigtable::v1::AdminClient::BackgroundThreadsFactory ( )
pure virtual

The thread factory this client was created with.

◆ Channel()

virtual std::shared_ptr<grpc::Channel> google::cloud::bigtable::v1::AdminClient::Channel ( )
pure virtual

Return a new channel to handle admin operations.

Intended to access rarely used services in the same endpoints as the Bigtable admin interfaces, for example, the google.longrunning.Operations.

◆ CheckConsistency()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::CheckConsistency ( grpc::ClientContext *  context,
google::bigtable::admin::v2::CheckConsistencyRequest const &  request,
google::bigtable::admin::v2::CheckConsistencyResponse *  response 
)
protectedpure virtual

◆ CreateBackup()

grpc::Status google::cloud::bigtable::v1::AdminClient::CreateBackup ( grpc::ClientContext *  context,
google::bigtable::admin::v2::CreateBackupRequest const &  request,
google::longrunning::Operation *  response 
)
protectedvirtual

Definition at line 25 of file admin_client.cc.

◆ CreateTable()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::CreateTable ( grpc::ClientContext *  context,
google::bigtable::admin::v2::CreateTableRequest const &  request,
google::bigtable::admin::v2::Table *  response 
)
protectedpure virtual

◆ DeleteBackup()

grpc::Status google::cloud::bigtable::v1::AdminClient::DeleteBackup ( grpc::ClientContext *  context,
google::bigtable::admin::v2::DeleteBackupRequest const &  request,
google::protobuf::Empty *  response 
)
protectedvirtual

Definition at line 45 of file admin_client.cc.

◆ DeleteTable()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::DeleteTable ( grpc::ClientContext *  context,
google::bigtable::admin::v2::DeleteTableRequest const &  request,
google::protobuf::Empty *  response 
)
protectedpure virtual

◆ DropRowRange()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::DropRowRange ( grpc::ClientContext *  context,
google::bigtable::admin::v2::DropRowRangeRequest const &  request,
google::protobuf::Empty *  response 
)
protectedpure virtual

◆ GenerateConsistencyToken()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::GenerateConsistencyToken ( grpc::ClientContext *  context,
google::bigtable::admin::v2::GenerateConsistencyTokenRequest const &  request,
google::bigtable::admin::v2::GenerateConsistencyTokenResponse *  response 
)
protectedpure virtual

◆ GetBackup()

grpc::Status google::cloud::bigtable::v1::AdminClient::GetBackup ( grpc::ClientContext *  context,
google::bigtable::admin::v2::GetBackupRequest const &  request,
google::bigtable::admin::v2::Backup *  response 
)
protectedvirtual

Definition at line 32 of file admin_client.cc.

◆ GetIamPolicy()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::GetIamPolicy ( grpc::ClientContext *  context,
google::iam::v1::GetIamPolicyRequest const &  request,
google::iam::v1::Policy *  response 
)
protectedpure virtual

◆ GetOperation()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::GetOperation ( grpc::ClientContext *  context,
google::longrunning::GetOperationRequest const &  request,
google::longrunning::Operation *  response 
)
protectedpure virtual

◆ GetTable()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::GetTable ( grpc::ClientContext *  context,
google::bigtable::admin::v2::GetTableRequest const &  request,
google::bigtable::admin::v2::Table *  response 
)
protectedpure virtual

◆ ListBackups()

grpc::Status google::cloud::bigtable::v1::AdminClient::ListBackups ( grpc::ClientContext *  context,
google::bigtable::admin::v2::ListBackupsRequest const &  request,
google::bigtable::admin::v2::ListBackupsResponse *  response 
)
protectedvirtual

Definition at line 52 of file admin_client.cc.

◆ ListTables()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::ListTables ( grpc::ClientContext *  context,
google::bigtable::admin::v2::ListTablesRequest const &  request,
google::bigtable::admin::v2::ListTablesResponse *  response 
)
protectedpure virtual

◆ ModifyColumnFamilies()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::ModifyColumnFamilies ( grpc::ClientContext *  context,
google::bigtable::admin::v2::ModifyColumnFamiliesRequest const &  request,
google::bigtable::admin::v2::Table *  response 
)
protectedpure virtual

◆ project()

virtual std::string const& google::cloud::bigtable::v1::AdminClient::project ( ) const
pure virtual

The project that this AdminClient works on.

◆ reset()

virtual void google::cloud::bigtable::v1::AdminClient::reset ( )
pure virtual

Reset and create new Channels.

Currently this is only used in testing. In the future, we expect this, or a similar member function, will be needed to handle errors that require a new connection, or an explicit refresh of the credentials.

◆ RestoreTable()

grpc::Status google::cloud::bigtable::v1::AdminClient::RestoreTable ( grpc::ClientContext *  context,
google::bigtable::admin::v2::RestoreTableRequest const &  request,
google::longrunning::Operation *  response 
)
protectedvirtual

Definition at line 59 of file admin_client.cc.

◆ SetIamPolicy()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::SetIamPolicy ( grpc::ClientContext *  context,
google::iam::v1::SetIamPolicyRequest const &  request,
google::iam::v1::Policy *  response 
)
protectedpure virtual

◆ TestIamPermissions()

virtual grpc::Status google::cloud::bigtable::v1::AdminClient::TestIamPermissions ( grpc::ClientContext *  context,
google::iam::v1::TestIamPermissionsRequest const &  request,
google::iam::v1::TestIamPermissionsResponse *  response 
)
protectedpure virtual

◆ UpdateBackup()

grpc::Status google::cloud::bigtable::v1::AdminClient::UpdateBackup ( grpc::ClientContext *  context,
google::bigtable::admin::v2::UpdateBackupRequest const &  request,
google::bigtable::admin::v2::Backup *  response 
)
protectedvirtual

Definition at line 38 of file admin_client.cc.

Friends And Related Function Documentation

◆ TableAdmin

friend class TableAdmin
friend

Definition at line 90 of file admin_client.h.