Google Cloud Bigtable C++ Client  1.32.1
A C++ Client Library for Google Cloud Bigtable
Classes | Public Types | Public Member Functions | List of all members
google::cloud::bigtable::v1::DefaultAdminClient Class Reference

An AdminClient for single-threaded programs that refreshes credentials on all gRPC errors. More...

Public Types

using AdminStubPtr = Impl::StubPtr
 

Public Member Functions

 DefaultAdminClient (std::string project, Options options)
 
std::string const & project () const override
 
std::shared_ptr< grpc::Channel > Channel () override
 
void reset () override
 
grpc::Status CreateTable (grpc::ClientContext *context, btadmin::CreateTableRequest const &request, btadmin::Table *response) override
 
grpc::Status ListTables (grpc::ClientContext *context, btadmin::ListTablesRequest const &request, btadmin::ListTablesResponse *response) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::ListTablesResponse > > AsyncListTables (grpc::ClientContext *context, google::bigtable::admin::v2::ListTablesRequest const &request, grpc::CompletionQueue *cq) override
 
grpc::Status GetTable (grpc::ClientContext *context, btadmin::GetTableRequest const &request, btadmin::Table *response) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Table > > AsyncGetTable (grpc::ClientContext *context, google::bigtable::admin::v2::GetTableRequest const &request, grpc::CompletionQueue *cq) override
 
grpc::Status DeleteTable (grpc::ClientContext *context, btadmin::DeleteTableRequest const &request, google::protobuf::Empty *response) override
 
grpc::Status CreateBackup (grpc::ClientContext *context, google::bigtable::admin::v2::CreateBackupRequest const &request, google::longrunning::Operation *response) override
 
grpc::Status GetBackup (grpc::ClientContext *context, google::bigtable::admin::v2::GetBackupRequest const &request, google::bigtable::admin::v2::Backup *response) override
 
grpc::Status UpdateBackup (grpc::ClientContext *context, google::bigtable::admin::v2::UpdateBackupRequest const &request, google::bigtable::admin::v2::Backup *response) override
 
grpc::Status DeleteBackup (grpc::ClientContext *context, google::bigtable::admin::v2::DeleteBackupRequest const &request, google::protobuf::Empty *response) override
 
grpc::Status ListBackups (grpc::ClientContext *context, google::bigtable::admin::v2::ListBackupsRequest const &request, google::bigtable::admin::v2::ListBackupsResponse *response) override
 
grpc::Status RestoreTable (grpc::ClientContext *context, google::bigtable::admin::v2::RestoreTableRequest const &request, google::longrunning::Operation *response) override
 
grpc::Status ModifyColumnFamilies (grpc::ClientContext *context, btadmin::ModifyColumnFamiliesRequest const &request, btadmin::Table *response) override
 
grpc::Status DropRowRange (grpc::ClientContext *context, btadmin::DropRowRangeRequest const &request, google::protobuf::Empty *response) override
 
grpc::Status GenerateConsistencyToken (grpc::ClientContext *context, btadmin::GenerateConsistencyTokenRequest const &request, btadmin::GenerateConsistencyTokenResponse *response) override
 
grpc::Status CheckConsistency (grpc::ClientContext *context, btadmin::CheckConsistencyRequest const &request, btadmin::CheckConsistencyResponse *response) override
 
grpc::Status GetOperation (grpc::ClientContext *context, google::longrunning::GetOperationRequest const &request, google::longrunning::Operation *response) override
 
grpc::Status GetIamPolicy (grpc::ClientContext *context, google::iam::v1::GetIamPolicyRequest const &request, google::iam::v1::Policy *response) override
 
grpc::Status SetIamPolicy (grpc::ClientContext *context, google::iam::v1::SetIamPolicyRequest const &request, google::iam::v1::Policy *response) override
 
grpc::Status TestIamPermissions (grpc::ClientContext *context, google::iam::v1::TestIamPermissionsRequest const &request, google::iam::v1::TestIamPermissionsResponse *response) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Table > > AsyncCreateTable (grpc::ClientContext *context, google::bigtable::admin::v2::CreateTableRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< ::grpc::ClientAsyncResponseReaderInterface<::google::protobuf::Empty > > AsyncDeleteTable (grpc::ClientContext *context, google::bigtable::admin::v2::DeleteTableRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::longrunning::Operation > > AsyncCreateBackup (grpc::ClientContext *context, google::bigtable::admin::v2::CreateBackupRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Backup > > AsyncGetBackup (grpc::ClientContext *context, google::bigtable::admin::v2::GetBackupRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Backup > > AsyncUpdateBackup (grpc::ClientContext *context, google::bigtable::admin::v2::UpdateBackupRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::protobuf::Empty > > AsyncDeleteBackup (grpc::ClientContext *context, google::bigtable::admin::v2::DeleteBackupRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::ListBackupsResponse > > AsyncListBackups (grpc::ClientContext *context, google::bigtable::admin::v2::ListBackupsRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::longrunning::Operation > > AsyncRestoreTable (grpc::ClientContext *context, google::bigtable::admin::v2::RestoreTableRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::Table > > AsyncModifyColumnFamilies (grpc::ClientContext *context, google::bigtable::admin::v2::ModifyColumnFamiliesRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::protobuf::Empty > > AsyncDropRowRange (grpc::ClientContext *context, google::bigtable::admin::v2::DropRowRangeRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::GenerateConsistencyTokenResponse > > AsyncGenerateConsistencyToken (grpc::ClientContext *context, google::bigtable::admin::v2::GenerateConsistencyTokenRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::bigtable::admin::v2::CheckConsistencyResponse > > AsyncCheckConsistency (grpc::ClientContext *context, google::bigtable::admin::v2::CheckConsistencyRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::iam::v1::Policy > > AsyncGetIamPolicy (grpc::ClientContext *context, google::iam::v1::GetIamPolicyRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::iam::v1::Policy > > AsyncSetIamPolicy (grpc::ClientContext *context, google::iam::v1::SetIamPolicyRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::iam::v1::TestIamPermissionsResponse > > AsyncTestIamPermissions (grpc::ClientContext *context, google::iam::v1::TestIamPermissionsRequest const &request, grpc::CompletionQueue *cq) override
 
std::unique_ptr< grpc::ClientAsyncResponseReaderInterface< google::longrunning::Operation > > AsyncGetOperation (grpc::ClientContext *context, google::longrunning::GetOperationRequest const &request, grpc::CompletionQueue *cq) override
 

Detailed Description

An AdminClient for single-threaded programs that refreshes credentials on all gRPC errors.

This class should not be used by multiple threads, it makes no attempt to protect its critical sections. While it is rare that the admin interface will be used by multiple threads, we should use the same approach here and in the regular client to support multi-threaded programs.

The class also aggressively reconnects on any gRPC errors. A future version should only reconnect on those errors that indicate the credentials or connections need refreshing.

Definition at line 134 of file admin_client.cc.

Member Typedef Documentation

◆ AdminStubPtr

Definition at line 148 of file admin_client.cc.

Constructor & Destructor Documentation

◆ DefaultAdminClient()

google::cloud::bigtable::v1::DefaultAdminClient::DefaultAdminClient ( std::string  project,
Options  options 
)
inline

Definition at line 150 of file admin_client.cc.

Member Function Documentation

◆ AsyncCheckConsistency()

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

Definition at line 394 of file admin_client.cc.

◆ AsyncCreateBackup()

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

Definition at line 313 of file admin_client.cc.

◆ AsyncCreateTable()

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

Definition at line 295 of file admin_client.cc.

◆ AsyncDeleteBackup()

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

Definition at line 339 of file admin_client.cc.

◆ AsyncDeleteTable()

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

Definition at line 304 of file admin_client.cc.

◆ AsyncDropRowRange()

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

Definition at line 375 of file admin_client.cc.

◆ AsyncGenerateConsistencyToken()

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

Definition at line 384 of file admin_client.cc.

◆ AsyncGetBackup()

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

Definition at line 322 of file admin_client.cc.

◆ AsyncGetIamPolicy()

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

Definition at line 403 of file admin_client.cc.

◆ AsyncGetOperation()

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

Definition at line 428 of file admin_client.cc.

◆ AsyncGetTable()

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

Definition at line 185 of file admin_client.cc.

◆ AsyncListBackups()

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

Definition at line 348 of file admin_client.cc.

◆ AsyncListTables()

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

Definition at line 171 of file admin_client.cc.

◆ AsyncModifyColumnFamilies()

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

Definition at line 366 of file admin_client.cc.

◆ AsyncRestoreTable()

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

Definition at line 357 of file admin_client.cc.

◆ AsyncSetIamPolicy()

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

Definition at line 411 of file admin_client.cc.

◆ AsyncTestIamPermissions()

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

Definition at line 419 of file admin_client.cc.

◆ AsyncUpdateBackup()

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

Definition at line 330 of file admin_client.cc.

◆ Channel()

std::shared_ptr<grpc::Channel> google::cloud::bigtable::v1::DefaultAdminClient::Channel ( )
inlineoverride

Definition at line 154 of file admin_client.cc.

◆ CheckConsistency()

grpc::Status google::cloud::bigtable::v1::DefaultAdminClient::CheckConsistency ( grpc::ClientContext *  context,
btadmin::CheckConsistencyRequest const &  request,
btadmin::CheckConsistencyResponse *  response 
)
inlineoverride

Definition at line 259 of file admin_client.cc.

◆ CreateBackup()

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

Definition at line 197 of file admin_client.cc.

◆ CreateTable()

grpc::Status google::cloud::bigtable::v1::DefaultAdminClient::CreateTable ( grpc::ClientContext *  context,
btadmin::CreateTableRequest const &  request,
btadmin::Table *  response 
)
inlineoverride

Definition at line 157 of file admin_client.cc.

◆ DeleteBackup()

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

Definition at line 218 of file admin_client.cc.

◆ DeleteTable()

grpc::Status google::cloud::bigtable::v1::DefaultAdminClient::DeleteTable ( grpc::ClientContext *  context,
btadmin::DeleteTableRequest const &  request,
google::protobuf::Empty *  response 
)
inlineoverride

Definition at line 191 of file admin_client.cc.

◆ DropRowRange()

grpc::Status google::cloud::bigtable::v1::DefaultAdminClient::DropRowRange ( grpc::ClientContext *  context,
btadmin::DropRowRangeRequest const &  request,
google::protobuf::Empty *  response 
)
inlineoverride

Definition at line 246 of file admin_client.cc.

◆ GenerateConsistencyToken()

grpc::Status google::cloud::bigtable::v1::DefaultAdminClient::GenerateConsistencyToken ( grpc::ClientContext *  context,
btadmin::GenerateConsistencyTokenRequest const &  request,
btadmin::GenerateConsistencyTokenResponse *  response 
)
inlineoverride

Definition at line 252 of file admin_client.cc.

◆ GetBackup()

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

Definition at line 204 of file admin_client.cc.

◆ GetIamPolicy()

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

Definition at line 274 of file admin_client.cc.

◆ GetOperation()

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

Definition at line 266 of file admin_client.cc.

◆ GetTable()

grpc::Status google::cloud::bigtable::v1::DefaultAdminClient::GetTable ( grpc::ClientContext *  context,
btadmin::GetTableRequest const &  request,
btadmin::Table *  response 
)
inlineoverride

Definition at line 177 of file admin_client.cc.

◆ ListBackups()

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

Definition at line 225 of file admin_client.cc.

◆ ListTables()

grpc::Status google::cloud::bigtable::v1::DefaultAdminClient::ListTables ( grpc::ClientContext *  context,
btadmin::ListTablesRequest const &  request,
btadmin::ListTablesResponse *  response 
)
inlineoverride

Definition at line 163 of file admin_client.cc.

◆ ModifyColumnFamilies()

grpc::Status google::cloud::bigtable::v1::DefaultAdminClient::ModifyColumnFamilies ( grpc::ClientContext *  context,
btadmin::ModifyColumnFamiliesRequest const &  request,
btadmin::Table *  response 
)
inlineoverride

Definition at line 239 of file admin_client.cc.

◆ project()

std::string const& google::cloud::bigtable::v1::DefaultAdminClient::project ( ) const
inlineoverride

Definition at line 153 of file admin_client.cc.

◆ reset()

void google::cloud::bigtable::v1::DefaultAdminClient::reset ( )
inlineoverride

Definition at line 155 of file admin_client.cc.

◆ RestoreTable()

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

Definition at line 232 of file admin_client.cc.

◆ SetIamPolicy()

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

Definition at line 280 of file admin_client.cc.

◆ TestIamPermissions()

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

Definition at line 286 of file admin_client.cc.

◆ UpdateBackup()

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

Definition at line 211 of file admin_client.cc.