Google Cloud Bigtable C++ Client  1.40.2
A C++ Client Library for Google Cloud Bigtable
Public Member Functions | Friends | List of all members
google::cloud::bigtable_admin::BigtableTableAdminClient Class Reference

Service for creating, configuring, and deleting Cloud Bigtable tables. More...

#include <google/cloud/bigtable/admin/bigtable_table_admin_client.h>

Public Member Functions

 BigtableTableAdminClient (std::shared_ptr< BigtableTableAdminConnection > connection, Options opts={})
 
 ~BigtableTableAdminClient ()
 
 BigtableTableAdminClient (BigtableTableAdminClient const &)=default
 
BigtableTableAdminClientoperator= (BigtableTableAdminClient const &)=default
 
 BigtableTableAdminClient (BigtableTableAdminClient &&)=default
 
BigtableTableAdminClientoperator= (BigtableTableAdminClient &&)=default
 
StatusOr< google::bigtable::admin::v2::Table > CreateTable (std::string const &parent, std::string const &table_id, google::bigtable::admin::v2::Table const &table, Options opts={})
 Creates a new table in the specified instance. More...
 
StatusOr< google::bigtable::admin::v2::Table > CreateTable (google::bigtable::admin::v2::CreateTableRequest const &request, Options opts={})
 Creates a new table in the specified instance. More...
 
StreamRange< google::bigtable::admin::v2::Table > ListTables (std::string const &parent, Options opts={})
 Lists all tables served from a specified instance. More...
 
StreamRange< google::bigtable::admin::v2::Table > ListTables (google::bigtable::admin::v2::ListTablesRequest request, Options opts={})
 Lists all tables served from a specified instance. More...
 
StatusOr< google::bigtable::admin::v2::Table > GetTable (std::string const &name, Options opts={})
 Gets metadata information about the specified table. More...
 
StatusOr< google::bigtable::admin::v2::Table > GetTable (google::bigtable::admin::v2::GetTableRequest const &request, Options opts={})
 Gets metadata information about the specified table. More...
 
Status DeleteTable (std::string const &name, Options opts={})
 Permanently deletes a specified table and all of its data. More...
 
Status DeleteTable (google::bigtable::admin::v2::DeleteTableRequest const &request, Options opts={})
 Permanently deletes a specified table and all of its data. More...
 
StatusOr< google::bigtable::admin::v2::Table > ModifyColumnFamilies (std::string const &name, std::vector< google::bigtable::admin::v2::ModifyColumnFamiliesRequest::Modification > const &modifications, Options opts={})
 Performs a series of column family modifications on the specified table. More...
 
StatusOr< google::bigtable::admin::v2::Table > ModifyColumnFamilies (google::bigtable::admin::v2::ModifyColumnFamiliesRequest const &request, Options opts={})
 Performs a series of column family modifications on the specified table. More...
 
Status DropRowRange (google::bigtable::admin::v2::DropRowRangeRequest const &request, Options opts={})
 Permanently drop/delete a row range from a specified table. More...
 
StatusOr< google::bigtable::admin::v2::GenerateConsistencyTokenResponse > GenerateConsistencyToken (std::string const &name, Options opts={})
 Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. More...
 
StatusOr< google::bigtable::admin::v2::GenerateConsistencyTokenResponse > GenerateConsistencyToken (google::bigtable::admin::v2::GenerateConsistencyTokenRequest const &request, Options opts={})
 Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. More...
 
StatusOr< google::bigtable::admin::v2::CheckConsistencyResponse > CheckConsistency (std::string const &name, std::string const &consistency_token, Options opts={})
 Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. More...
 
StatusOr< google::bigtable::admin::v2::CheckConsistencyResponse > CheckConsistency (google::bigtable::admin::v2::CheckConsistencyRequest const &request, Options opts={})
 Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. More...
 
future< StatusOr< google::bigtable::admin::v2::Backup > > CreateBackup (std::string const &parent, std::string const &backup_id, google::bigtable::admin::v2::Backup const &backup, Options opts={})
 Starts creating a new Cloud Bigtable Backup. More...
 
future< StatusOr< google::bigtable::admin::v2::Backup > > CreateBackup (google::bigtable::admin::v2::CreateBackupRequest const &request, Options opts={})
 Starts creating a new Cloud Bigtable Backup. More...
 
StatusOr< google::bigtable::admin::v2::Backup > GetBackup (std::string const &name, Options opts={})
 Gets metadata on a pending or completed Cloud Bigtable Backup. More...
 
StatusOr< google::bigtable::admin::v2::Backup > GetBackup (google::bigtable::admin::v2::GetBackupRequest const &request, Options opts={})
 Gets metadata on a pending or completed Cloud Bigtable Backup. More...
 
StatusOr< google::bigtable::admin::v2::Backup > UpdateBackup (google::bigtable::admin::v2::Backup const &backup, google::protobuf::FieldMask const &update_mask, Options opts={})
 Updates a pending or completed Cloud Bigtable Backup. More...
 
StatusOr< google::bigtable::admin::v2::Backup > UpdateBackup (google::bigtable::admin::v2::UpdateBackupRequest const &request, Options opts={})
 Updates a pending or completed Cloud Bigtable Backup. More...
 
Status DeleteBackup (std::string const &name, Options opts={})
 Deletes a pending or completed Cloud Bigtable backup. More...
 
Status DeleteBackup (google::bigtable::admin::v2::DeleteBackupRequest const &request, Options opts={})
 Deletes a pending or completed Cloud Bigtable backup. More...
 
StreamRange< google::bigtable::admin::v2::Backup > ListBackups (std::string const &parent, Options opts={})
 Lists Cloud Bigtable backups. More...
 
StreamRange< google::bigtable::admin::v2::Backup > ListBackups (google::bigtable::admin::v2::ListBackupsRequest request, Options opts={})
 Lists Cloud Bigtable backups. More...
 
future< StatusOr< google::bigtable::admin::v2::Table > > RestoreTable (google::bigtable::admin::v2::RestoreTableRequest const &request, Options opts={})
 Create a new table by restoring from a completed backup. More...
 
StatusOr< google::iam::v1::Policy > GetIamPolicy (std::string const &resource, Options opts={})
 Gets the access control policy for a Table or Backup resource. More...
 
StatusOr< google::iam::v1::Policy > GetIamPolicy (google::iam::v1::GetIamPolicyRequest const &request, Options opts={})
 Gets the access control policy for a Table or Backup resource. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (std::string const &resource, google::iam::v1::Policy const &policy, Options opts={})
 Sets the access control policy on a Table or Backup resource. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (std::string const &resource, IamUpdater const &updater, Options opts={})
 Updates the IAM policy for resource using an optimistic concurrency control loop. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (google::iam::v1::SetIamPolicyRequest const &request, Options opts={})
 Sets the access control policy on a Table or Backup resource. More...
 
StatusOr< google::iam::v1::TestIamPermissionsResponse > TestIamPermissions (std::string const &resource, std::vector< std::string > const &permissions, Options opts={})
 Returns permissions that the caller has on the specified Table or Backup resource. More...
 
StatusOr< google::iam::v1::TestIamPermissionsResponse > TestIamPermissions (google::iam::v1::TestIamPermissionsRequest const &request, Options opts={})
 Returns permissions that the caller has on the specified Table or Backup resource. More...
 
future< StatusOr< google::bigtable::admin::v2::CheckConsistencyResponse > > AsyncCheckConsistency (std::string const &name, std::string const &consistency_token, Options opts={})
 Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. More...
 
future< StatusOr< google::bigtable::admin::v2::CheckConsistencyResponse > > AsyncCheckConsistency (google::bigtable::admin::v2::CheckConsistencyRequest const &request, Options opts={})
 Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. More...
 

Friends

bool operator== (BigtableTableAdminClient const &a, BigtableTableAdminClient const &b)
 
bool operator!= (BigtableTableAdminClient const &a, BigtableTableAdminClient const &b)
 

Detailed Description

Service for creating, configuring, and deleting Cloud Bigtable tables.

Provides access to the table schemas only, not the data stored within the tables.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Definition at line 68 of file bigtable_table_admin_client.h.

Constructor & Destructor Documentation

◆ BigtableTableAdminClient() [1/3]

google::cloud::bigtable_admin::BigtableTableAdminClient::BigtableTableAdminClient ( std::shared_ptr< BigtableTableAdminConnection connection,
Options  opts = {} 
)
explicit

◆ ~BigtableTableAdminClient()

google::cloud::bigtable_admin::BigtableTableAdminClient::~BigtableTableAdminClient ( )

◆ BigtableTableAdminClient() [2/3]

google::cloud::bigtable_admin::BigtableTableAdminClient::BigtableTableAdminClient ( BigtableTableAdminClient const &  )
default

◆ BigtableTableAdminClient() [3/3]

google::cloud::bigtable_admin::BigtableTableAdminClient::BigtableTableAdminClient ( BigtableTableAdminClient &&  )
default

Member Function Documentation

◆ AsyncCheckConsistency() [1/2]

future<StatusOr<google::bigtable::admin::v2::CheckConsistencyResponse> > google::cloud::bigtable_admin::BigtableTableAdminClient::AsyncCheckConsistency ( google::bigtable::admin::v2::CheckConsistencyRequest const &  request,
Options  opts = {} 
)

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Parameters
requestgoogle::bigtable::admin::v2::CheckConsistencyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::CheckConsistencyResponse

◆ AsyncCheckConsistency() [2/2]

future<StatusOr<google::bigtable::admin::v2::CheckConsistencyResponse> > google::cloud::bigtable_admin::BigtableTableAdminClient::AsyncCheckConsistency ( std::string const &  name,
std::string const &  consistency_token,
Options  opts = {} 
)

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Parameters
nameRequired. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
consistency_tokenRequired. The token created using GenerateConsistencyToken for the Table.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::CheckConsistencyResponse

◆ CheckConsistency() [1/2]

StatusOr<google::bigtable::admin::v2::CheckConsistencyResponse> google::cloud::bigtable_admin::BigtableTableAdminClient::CheckConsistency ( google::bigtable::admin::v2::CheckConsistencyRequest const &  request,
Options  opts = {} 
)

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Parameters
requestgoogle::bigtable::admin::v2::CheckConsistencyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::CheckConsistencyResponse

◆ CheckConsistency() [2/2]

StatusOr<google::bigtable::admin::v2::CheckConsistencyResponse> google::cloud::bigtable_admin::BigtableTableAdminClient::CheckConsistency ( std::string const &  name,
std::string const &  consistency_token,
Options  opts = {} 
)

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Parameters
nameRequired. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
consistency_tokenRequired. The token created using GenerateConsistencyToken for the Table.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::CheckConsistencyResponse

◆ CreateBackup() [1/2]

future<StatusOr<google::bigtable::admin::v2::Backup> > google::cloud::bigtable_admin::BigtableTableAdminClient::CreateBackup ( google::bigtable::admin::v2::CreateBackupRequest const &  request,
Options  opts = {} 
)

Starts creating a new Cloud Bigtable Backup.

The returned backup [long-running operation][google.longrunning.Operation] can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.bigtable.admin.v2.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

Parameters
requestgoogle::bigtable::admin::v2::CreateBackupRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Backup

◆ CreateBackup() [2/2]

future<StatusOr<google::bigtable::admin::v2::Backup> > google::cloud::bigtable_admin::BigtableTableAdminClient::CreateBackup ( std::string const &  parent,
std::string const &  backup_id,
google::bigtable::admin::v2::Backup const &  backup,
Options  opts = {} 
)

Starts creating a new Cloud Bigtable Backup.

The returned backup [long-running operation][google.longrunning.Operation] can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.bigtable.admin.v2.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

Parameters
parentRequired. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.
backup_idRequired. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.
backupRequired. The backup to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Backup

◆ CreateTable() [1/2]

StatusOr<google::bigtable::admin::v2::Table> google::cloud::bigtable_admin::BigtableTableAdminClient::CreateTable ( google::bigtable::admin::v2::CreateTableRequest const &  request,
Options  opts = {} 
)

Creates a new table in the specified instance.

The table can be created with a full set of initial column families, specified in the request.

Parameters
requestgoogle::bigtable::admin::v2::CreateTableRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Table

◆ CreateTable() [2/2]

StatusOr<google::bigtable::admin::v2::Table> google::cloud::bigtable_admin::BigtableTableAdminClient::CreateTable ( std::string const &  parent,
std::string const &  table_id,
google::bigtable::admin::v2::Table const &  table,
Options  opts = {} 
)

Creates a new table in the specified instance.

The table can be created with a full set of initial column families, specified in the request.

Parameters
parentRequired. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance}.
table_idRequired. The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar. Maximum 50 characters.
tableRequired. The Table to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Table

◆ DeleteBackup() [1/2]

Status google::cloud::bigtable_admin::BigtableTableAdminClient::DeleteBackup ( google::bigtable::admin::v2::DeleteBackupRequest const &  request,
Options  opts = {} 
)

Deletes a pending or completed Cloud Bigtable backup.

Parameters
requestgoogle::bigtable::admin::v2::DeleteBackupRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteBackup() [2/2]

Status google::cloud::bigtable_admin::BigtableTableAdminClient::DeleteBackup ( std::string const &  name,
Options  opts = {} 
)

Deletes a pending or completed Cloud Bigtable backup.

Parameters
nameRequired. Name of the backup to delete. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteTable() [1/2]

Status google::cloud::bigtable_admin::BigtableTableAdminClient::DeleteTable ( google::bigtable::admin::v2::DeleteTableRequest const &  request,
Options  opts = {} 
)

Permanently deletes a specified table and all of its data.

Parameters
requestgoogle::bigtable::admin::v2::DeleteTableRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteTable() [2/2]

Status google::cloud::bigtable_admin::BigtableTableAdminClient::DeleteTable ( std::string const &  name,
Options  opts = {} 
)

Permanently deletes a specified table and all of its data.

Parameters
nameRequired. The unique name of the table to be deleted. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DropRowRange()

Status google::cloud::bigtable_admin::BigtableTableAdminClient::DropRowRange ( google::bigtable::admin::v2::DropRowRangeRequest const &  request,
Options  opts = {} 
)

Permanently drop/delete a row range from a specified table.

The request can specify whether to delete all rows in a table, or only those that match a particular prefix.

Parameters
requestgoogle::bigtable::admin::v2::DropRowRangeRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ GenerateConsistencyToken() [1/2]

StatusOr<google::bigtable::admin::v2::GenerateConsistencyTokenResponse> google::cloud::bigtable_admin::BigtableTableAdminClient::GenerateConsistencyToken ( google::bigtable::admin::v2::GenerateConsistencyTokenRequest const &  request,
Options  opts = {} 
)

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated.

The tokens will be available for 90 days.

Parameters
requestgoogle::bigtable::admin::v2::GenerateConsistencyTokenRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::GenerateConsistencyTokenResponse

◆ GenerateConsistencyToken() [2/2]

StatusOr<google::bigtable::admin::v2::GenerateConsistencyTokenResponse> google::cloud::bigtable_admin::BigtableTableAdminClient::GenerateConsistencyToken ( std::string const &  name,
Options  opts = {} 
)

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated.

The tokens will be available for 90 days.

Parameters
nameRequired. The unique name of the Table for which to create a consistency token. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::GenerateConsistencyTokenResponse

◆ GetBackup() [1/2]

StatusOr<google::bigtable::admin::v2::Backup> google::cloud::bigtable_admin::BigtableTableAdminClient::GetBackup ( google::bigtable::admin::v2::GetBackupRequest const &  request,
Options  opts = {} 
)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
requestgoogle::bigtable::admin::v2::GetBackupRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Backup

◆ GetBackup() [2/2]

StatusOr<google::bigtable::admin::v2::Backup> google::cloud::bigtable_admin::BigtableTableAdminClient::GetBackup ( std::string const &  name,
Options  opts = {} 
)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
nameRequired. Name of the backup. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Backup

◆ GetIamPolicy() [1/2]

StatusOr<google::iam::v1::Policy> google::cloud::bigtable_admin::BigtableTableAdminClient::GetIamPolicy ( google::iam::v1::GetIamPolicyRequest const &  request,
Options  opts = {} 
)

Gets the access control policy for a Table or Backup resource.

Returns an empty policy if the resource exists but does not have a policy set.

Parameters
requestgoogle::iam::v1::GetIamPolicyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ GetIamPolicy() [2/2]

StatusOr<google::iam::v1::Policy> google::cloud::bigtable_admin::BigtableTableAdminClient::GetIamPolicy ( std::string const &  resource,
Options  opts = {} 
)

Gets the access control policy for a Table or Backup resource.

Returns an empty policy if the resource exists but does not have a policy set.

Parameters
resourceREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ GetTable() [1/2]

StatusOr<google::bigtable::admin::v2::Table> google::cloud::bigtable_admin::BigtableTableAdminClient::GetTable ( google::bigtable::admin::v2::GetTableRequest const &  request,
Options  opts = {} 
)

Gets metadata information about the specified table.

Parameters
requestgoogle::bigtable::admin::v2::GetTableRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Table

◆ GetTable() [2/2]

StatusOr<google::bigtable::admin::v2::Table> google::cloud::bigtable_admin::BigtableTableAdminClient::GetTable ( std::string const &  name,
Options  opts = {} 
)

Gets metadata information about the specified table.

Parameters
nameRequired. The unique name of the requested table. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Table

◆ ListBackups() [1/2]

StreamRange<google::bigtable::admin::v2::Backup> google::cloud::bigtable_admin::BigtableTableAdminClient::ListBackups ( google::bigtable::admin::v2::ListBackupsRequest  request,
Options  opts = {} 
)

Lists Cloud Bigtable backups.

Returns both completed and pending backups.

Parameters
requestgoogle::bigtable::admin::v2::ListBackupsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Backup

◆ ListBackups() [2/2]

StreamRange<google::bigtable::admin::v2::Backup> google::cloud::bigtable_admin::BigtableTableAdminClient::ListBackups ( std::string const &  parent,
Options  opts = {} 
)

Lists Cloud Bigtable backups.

Returns both completed and pending backups.

Parameters
parentRequired. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use ‘{cluster} = ’-'to list backups for all clusters in an instance, e.g.,projects/{project}/instances/{instance}/clusters/-`.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Backup

◆ ListTables() [1/2]

StreamRange<google::bigtable::admin::v2::Table> google::cloud::bigtable_admin::BigtableTableAdminClient::ListTables ( google::bigtable::admin::v2::ListTablesRequest  request,
Options  opts = {} 
)

Lists all tables served from a specified instance.

Parameters
requestgoogle::bigtable::admin::v2::ListTablesRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Table

◆ ListTables() [2/2]

StreamRange<google::bigtable::admin::v2::Table> google::cloud::bigtable_admin::BigtableTableAdminClient::ListTables ( std::string const &  parent,
Options  opts = {} 
)

Lists all tables served from a specified instance.

Parameters
parentRequired. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Table

◆ ModifyColumnFamilies() [1/2]

StatusOr<google::bigtable::admin::v2::Table> google::cloud::bigtable_admin::BigtableTableAdminClient::ModifyColumnFamilies ( google::bigtable::admin::v2::ModifyColumnFamiliesRequest const &  request,
Options  opts = {} 
)

Performs a series of column family modifications on the specified table.

Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.

Parameters
requestgoogle::bigtable::admin::v2::ModifyColumnFamiliesRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Table

◆ ModifyColumnFamilies() [2/2]

StatusOr<google::bigtable::admin::v2::Table> google::cloud::bigtable_admin::BigtableTableAdminClient::ModifyColumnFamilies ( std::string const &  name,
std::vector< google::bigtable::admin::v2::ModifyColumnFamiliesRequest::Modification > const &  modifications,
Options  opts = {} 
)

Performs a series of column family modifications on the specified table.

Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.

Parameters
nameRequired. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
modificationsRequired. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Table

◆ operator=() [1/2]

BigtableTableAdminClient& google::cloud::bigtable_admin::BigtableTableAdminClient::operator= ( BigtableTableAdminClient &&  )
default

◆ operator=() [2/2]

BigtableTableAdminClient& google::cloud::bigtable_admin::BigtableTableAdminClient::operator= ( BigtableTableAdminClient const &  )
default

◆ RestoreTable()

future<StatusOr<google::bigtable::admin::v2::Table> > google::cloud::bigtable_admin::BigtableTableAdminClient::RestoreTable ( google::bigtable::admin::v2::RestoreTableRequest const &  request,
Options  opts = {} 
)

Create a new table by restoring from a completed backup.

The new table must be in the same project as the instance containing the backup. The returned table [long-running operation][google.longrunning.Operation] can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The [response][google.longrunning.Operation.response] type is Table, if successful.

Parameters
requestgoogle::bigtable::admin::v2::RestoreTableRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Table

◆ SetIamPolicy() [1/3]

StatusOr<google::iam::v1::Policy> google::cloud::bigtable_admin::BigtableTableAdminClient::SetIamPolicy ( google::iam::v1::SetIamPolicyRequest const &  request,
Options  opts = {} 
)

Sets the access control policy on a Table or Backup resource.

Replaces any existing policy.

Parameters
requestgoogle::iam::v1::SetIamPolicyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ SetIamPolicy() [2/3]

StatusOr<google::iam::v1::Policy> google::cloud::bigtable_admin::BigtableTableAdminClient::SetIamPolicy ( std::string const &  resource,
google::iam::v1::Policy const &  policy,
Options  opts = {} 
)

Sets the access control policy on a Table or Backup resource.

Replaces any existing policy.

Parameters
resourceREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policyREQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ SetIamPolicy() [3/3]

StatusOr<google::iam::v1::Policy> google::cloud::bigtable_admin::BigtableTableAdminClient::SetIamPolicy ( std::string const &  resource,
IamUpdater const &  updater,
Options  opts = {} 
)

Updates the IAM policy for resource using an optimistic concurrency control loop.

The loop fetches the current policy for resource, and passes it to updater, which should return the new policy. This new policy should use the current etag so that the read-modify-write cycle can detect races and rerun the update when there is a mismatch. If the new policy does not have an etag, the existing policy will be blindly overwritten. If updater does not yield a policy, the control loop is terminated and kCancelled is returned.

Parameters
resourceRequired. The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
updaterRequired. Functor to map the current policy to a new one.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ TestIamPermissions() [1/2]

StatusOr<google::iam::v1::TestIamPermissionsResponse> google::cloud::bigtable_admin::BigtableTableAdminClient::TestIamPermissions ( google::iam::v1::TestIamPermissionsRequest const &  request,
Options  opts = {} 
)

Returns permissions that the caller has on the specified Table or Backup resource.

Parameters
requestgoogle::iam::v1::TestIamPermissionsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::TestIamPermissionsResponse

◆ TestIamPermissions() [2/2]

StatusOr<google::iam::v1::TestIamPermissionsResponse> google::cloud::bigtable_admin::BigtableTableAdminClient::TestIamPermissions ( std::string const &  resource,
std::vector< std::string > const &  permissions,
Options  opts = {} 
)

Returns permissions that the caller has on the specified Table or Backup resource.

Parameters
resourceREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissionsThe set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::TestIamPermissionsResponse

◆ UpdateBackup() [1/2]

StatusOr<google::bigtable::admin::v2::Backup> google::cloud::bigtable_admin::BigtableTableAdminClient::UpdateBackup ( google::bigtable::admin::v2::Backup const &  backup,
google::protobuf::FieldMask const &  update_mask,
Options  opts = {} 
)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
backupRequired. The backup to update. backup.name, and the fields to be updated as specified by update_mask are required. Other fields are ignored. Update is only supported for the following fields:
  • backup.expire_time.
update_maskRequired. A mask specifying which fields (e.g. expire_time) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Backup

◆ UpdateBackup() [2/2]

StatusOr<google::bigtable::admin::v2::Backup> google::cloud::bigtable_admin::BigtableTableAdminClient::UpdateBackup ( google::bigtable::admin::v2::UpdateBackupRequest const &  request,
Options  opts = {} 
)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
requestgoogle::bigtable::admin::v2::UpdateBackupRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::bigtable::admin::v2::Backup

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( BigtableTableAdminClient const &  a,
BigtableTableAdminClient const &  b 
)
friend

Definition at line 90 of file bigtable_table_admin_client.h.

◆ operator==

bool operator== ( BigtableTableAdminClient const &  a,
BigtableTableAdminClient const &  b 
)
friend

Definition at line 86 of file bigtable_table_admin_client.h.