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 ()
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...
future< StatusOr< google::bigtable::admin::v2::Table > >	UpdateTable (google::bigtable::admin::v2::Table const &table, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates a specified table. More...
future< StatusOr< google::bigtable::admin::v2::Table > >	UpdateTable (google::bigtable::admin::v2::UpdateTableRequest const &request, Options opts={})
	Updates a 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...
future< StatusOr< google::bigtable::admin::v2::Table > >	UndeleteTable (std::string const &name, Options opts={})
	Restores a specified table which was accidentally deleted. More...
future< StatusOr< google::bigtable::admin::v2::Table > >	UndeleteTable (google::bigtable::admin::v2::UndeleteTableRequest const &request, Options opts={})
	Restores a specified table which was accidentally deleted. 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...
Copy and move support
	BigtableTableAdminClient (BigtableTableAdminClient const &)=default
BigtableTableAdminClient &	operator= (BigtableTableAdminClient const &)=default
	BigtableTableAdminClient (BigtableTableAdminClient &&)=default
BigtableTableAdminClient &	operator= (BigtableTableAdminClient &&)=default

Friends
Equality
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.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.CheckConsistencyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.CheckConsistencyResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

name	Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
consistency_token	Required. The token created using GenerateConsistencyToken for the Table.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.CheckConsistencyResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.CheckConsistencyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.CheckConsistencyResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

name	Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
consistency_token	Required. The token created using GenerateConsistencyToken for the Table.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.CheckConsistencyResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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 can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.CreateBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

A `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

Parameters

parent	Required. 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_id	Required. 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]*.
backup	Required. The backup to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

A `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.CreateTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

parent	Required. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance}.
table_id	Required. 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.
table	Required. The Table to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.DeleteBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

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

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

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.DeleteTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

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

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

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.DropRowRangeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.GenerateConsistencyTokenRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.GenerateConsistencyTokenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

name	Required. The unique name of the Table for which to create a consistency token. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.GenerateConsistencyTokenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.GetBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

name	Required. Name of the backup. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

resource	REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.GetTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

name	Required. The unique name of the requested table. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.ListBackupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.bigtable.admin.v2.Backup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

parent	Required. 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/-.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.bigtable.admin.v2.Backup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.ListTablesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.bigtable.admin.v2.Table, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

parent	Required. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance}.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.bigtable.admin.v2.Table, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.ModifyColumnFamiliesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

name	Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
modifications	Required. 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).
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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 can be used to track the progress of the operation, and to cancel it. The metadata field type is [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The response type is Table, if successful.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.RestoreTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

A `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Table proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

resource	REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy	REQUIRED: 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.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

resource	Required. The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
updater	Required. Functor to map the current policy to a new one.
opts	Optional. 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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

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

Returns

the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UndeleteTable() [1/2]

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

Restores a specified table which was accidentally deleted.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.UndeleteTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

A `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Table proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UndeleteTable() [2/2]

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

Restores a specified table which was accidentally deleted.

Parameters

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

Returns

A `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Table proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

backup	Required. 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_mask	Required. 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.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.UpdateBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.bigtable.admin.v2.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTable() [1/2]

future< StatusOr< google::bigtable::admin::v2::Table > > google::cloud::bigtable_admin::BigtableTableAdminClient::UpdateTable	(	google::bigtable::admin::v2::Table const &	table,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates a specified table.

Parameters

table	Required. The table to update. The table's name field is used to identify the table to update.
update_mask	Required. The list of fields to update. A mask specifying which fields (e.g. change_stream_config) in the table field should be updated. This mask is relative to the table field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: change_stream_config change_stream_config.retention_period deletion_protection If column_families is set in update_mask, it will return an UNIMPLEMENTED error.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

A `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Table proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTable() [2/2]

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

Updates a specified table.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.bigtable.admin.v2.UpdateTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

A `future` that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the `StatusOr` returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.bigtable.admin.v2.Table proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

Friends And Related Function Documentation

operator!=

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

friend

operator==

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

friend