Class BigtableTableAdminClient (2.23.0-rc)

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.

Constructors

BigtableTableAdminClient(BigtableTableAdminClient const &)

Copy and move support

Parameter
Name	Description
	`BigtableTableAdminClient const &`

BigtableTableAdminClient(BigtableTableAdminClient &&)

Copy and move support

Parameter
Name	Description
	`BigtableTableAdminClient &&`

BigtableTableAdminClient(std::shared_ptr< BigtableTableAdminConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< BigtableTableAdminConnection >`
`opts`	`Options`

Operators

operator=(BigtableTableAdminClient const &)

Copy and move support

Parameter
Name	Description
	`BigtableTableAdminClient const &`

Returns
Type	Description
`BigtableTableAdminClient &`

operator=(BigtableTableAdminClient &&)

Copy and move support

Parameter
Name	Description
	`BigtableTableAdminClient &&`

Returns
Type	Description
`BigtableTableAdminClient &`

Functions

CreateTable(std::string const &, std::string const &, google::bigtable::admin::v2::Table const &, Options)

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
Name	Description
`parent`	`std::string const &` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
`table_id`	`std::string const &` 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`	`google::bigtable::admin::v2::Table const &` Required. The Table to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Table >`	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(google::bigtable::admin::v2::CreateTableRequest const &, Options)

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
Name	Description
`request`	`google::bigtable::admin::v2::CreateTableRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Table >`	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.

ListTables(std::string const &, Options)

Lists all tables served from a specified instance.

Parameters
Name	Description
`parent`	`std::string const &` Required. The unique name of the instance for which tables should be listed. Values are of the form `projects/{project}/instances/{instance}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::bigtable::admin::v2::Table >

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(google::bigtable::admin::v2::ListTablesRequest, Options)

Lists all tables served from a specified instance.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::ListTablesRequest` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::bigtable::admin::v2::Table >

GetTable(std::string const &, Options)

Gets metadata information about the specified table.

Parameters
Name	Description
`name`	`std::string const &` Required. The unique name of the requested table. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Table >`	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(google::bigtable::admin::v2::GetTableRequest const &, Options)

Gets metadata information about the specified table.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::GetTableRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Table >`	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.

UpdateTable(google::bigtable::admin::v2::Table const &, google::protobuf::FieldMask const &, Options)

Updates a specified table.

Parameters
Name	Description
`table`	`google::bigtable::admin::v2::Table const &` Required. The table to update. The table's `name` field is used to identify the table to update.
`update_mask`	`google::protobuf::FieldMask const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Table > >

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(google::bigtable::admin::v2::UpdateTableRequest const &, Options)

Updates a specified table.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::UpdateTableRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Table > >

DeleteTable(std::string const &, Options)

Permanently deletes a specified table and all of its data.

Parameters
Name	Description
`name`	`std::string const &` Required. The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

DeleteTable(google::bigtable::admin::v2::DeleteTableRequest const &, Options)

Permanently deletes a specified table and all of its data.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::DeleteTableRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

UndeleteTable(std::string const &, Options)

Restores a specified table which was accidentally deleted.

Parameters
Name	Description
`name`	`std::string const &` Required. The unique name of the table to be restored. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Table > >

UndeleteTable(google::bigtable::admin::v2::UndeleteTableRequest const &, Options)

Restores a specified table which was accidentally deleted.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::UndeleteTableRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Table > >

CreateAuthorizedView(std::string const &, google::bigtable::admin::v2::AuthorizedView const &, std::string const &, Options)

Creates a new AuthorizedView in a table.

Parameters
Name	Description
`parent`	`std::string const &` Required. This is the name of the table the AuthorizedView belongs to. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`authorized_view`	`google::bigtable::admin::v2::AuthorizedView const &` Required. The AuthorizedView to create.
`authorized_view_id`	`std::string const &` Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The `authorized_view_id` appended to `parent` forms the full AuthorizedView name of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::AuthorizedView > >

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.AuthorizedView proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAuthorizedView(google::bigtable::admin::v2::CreateAuthorizedViewRequest const &, Options)

Creates a new AuthorizedView in a table.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::CreateAuthorizedViewRequest const &` 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.CreateAuthorizedViewRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::AuthorizedView > >

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.AuthorizedView proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListAuthorizedViews(std::string const &, Options)

Lists all AuthorizedViews from a specific table.

Parameters
Name	Description
`parent`	`std::string const &` Required. The unique name of the table for which AuthorizedViews should be listed. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::bigtable::admin::v2::AuthorizedView >

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.AuthorizedView, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAuthorizedViews(google::bigtable::admin::v2::ListAuthorizedViewsRequest, Options)

Lists all AuthorizedViews from a specific table.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::ListAuthorizedViewsRequest` 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.ListAuthorizedViewsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::bigtable::admin::v2::AuthorizedView >

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.AuthorizedView, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetAuthorizedView(std::string const &, Options)

Gets information from a specified AuthorizedView.

Parameters
Name	Description
`name`	`std::string const &` Required. The unique name of the requested AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetAuthorizedView(google::bigtable::admin::v2::GetAuthorizedViewRequest const &, Options)

Gets information from a specified AuthorizedView.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::GetAuthorizedViewRequest const &` 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.GetAuthorizedViewRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateAuthorizedView(google::bigtable::admin::v2::AuthorizedView const &, google::protobuf::FieldMask const &, Options)

Updates an AuthorizedView in a table.

Parameters
Name	Description
`authorized_view`	`google::bigtable::admin::v2::AuthorizedView const &` Required. The AuthorizedView to update. The `name` in `authorized_view` is used to identify the AuthorizedView. AuthorizedView name must in this format `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`
`update_mask`	`google::protobuf::FieldMask const &` Optional. The list of fields to update. A mask specifying which fields in the AuthorizedView resource should be updated. This mask is relative to the AuthorizedView resource, not to the request message. A field will be overwritten if it is in the mask. If empty, all fields set in the request will be overwritten. A special value `*` means to overwrite all fields (including fields not set in the request).
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::AuthorizedView > >

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.AuthorizedView proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAuthorizedView(google::bigtable::admin::v2::UpdateAuthorizedViewRequest const &, Options)

Updates an AuthorizedView in a table.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::UpdateAuthorizedViewRequest const &` 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.UpdateAuthorizedViewRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::AuthorizedView > >

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.AuthorizedView proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAuthorizedView(std::string const &, Options)

Permanently deletes a specified AuthorizedView.

Parameters
Name	Description
`name`	`std::string const &` Required. The unique name of the AuthorizedView to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

DeleteAuthorizedView(google::bigtable::admin::v2::DeleteAuthorizedViewRequest const &, Options)

Permanently deletes a specified AuthorizedView.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::DeleteAuthorizedViewRequest const &` 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.DeleteAuthorizedViewRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

ModifyColumnFamilies(std::string const &, std::vector< google::bigtable::admin::v2::ModifyColumnFamiliesRequest::Modification > const &, Options)

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	Description
`name`	`std::string const &` Required. The unique name of the table whose families should be modified. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`modifications`	`std::vector< google::bigtable::admin::v2::ModifyColumnFamiliesRequest::Modification > const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Table >`	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(google::bigtable::admin::v2::ModifyColumnFamiliesRequest const &, Options)

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	Description
`request`	`google::bigtable::admin::v2::ModifyColumnFamiliesRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Table >`	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.

DropRowRange(google::bigtable::admin::v2::DropRowRangeRequest const &, Options)

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
Name	Description
`request`	`google::bigtable::admin::v2::DropRowRangeRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GenerateConsistencyToken(std::string const &, Options)

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	Description
`name`	`std::string const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::GenerateConsistencyTokenResponse >`	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(google::bigtable::admin::v2::GenerateConsistencyTokenRequest const &, Options)

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	Description
`request`	`google::bigtable::admin::v2::GenerateConsistencyTokenRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::GenerateConsistencyTokenResponse >`	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.

CheckConsistency(std::string const &, std::string const &, Options)

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	Description
`name`	`std::string const &` 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`	`std::string const &` Required. The token created using GenerateConsistencyToken for the Table.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::CheckConsistencyResponse >`	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(google::bigtable::admin::v2::CheckConsistencyRequest const &, Options)

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	Description
`request`	`google::bigtable::admin::v2::CheckConsistencyRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::CheckConsistencyResponse >`	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(std::string const &, std::string const &, google::bigtable::admin::v2::Backup const &, Options)

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
Name	Description
`parent`	`std::string const &` 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`	`std::string const &` 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`	`google::bigtable::admin::v2::Backup const &` Required. The backup to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Backup > >

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(google::bigtable::admin::v2::CreateBackupRequest const &, Options)

Starts creating a new Cloud Bigtable Backup.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::CreateBackupRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Backup > >

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.

GetBackup(std::string const &, Options)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Backup >`	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(google::bigtable::admin::v2::GetBackupRequest const &, Options)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::GetBackupRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Backup >`	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(google::bigtable::admin::v2::Backup const &, google::protobuf::FieldMask const &, Options)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
`backup`	`google::bigtable::admin::v2::Backup const &` 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`	`google::protobuf::FieldMask const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Backup >`	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(google::bigtable::admin::v2::UpdateBackupRequest const &, Options)

Updates a pending or completed Cloud Bigtable Backup.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::UpdateBackupRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::bigtable::admin::v2::Backup >`	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.

DeleteBackup(std::string const &, Options)

Deletes a pending or completed Cloud Bigtable backup.

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

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

DeleteBackup(google::bigtable::admin::v2::DeleteBackupRequest const &, Options)

Deletes a pending or completed Cloud Bigtable backup.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::DeleteBackupRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

ListBackups(std::string const &, Options)

Lists Cloud Bigtable backups.

Returns both completed and pending backups.

Parameters
Name	Description
`parent`	`std::string const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::bigtable::admin::v2::Backup >

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(google::bigtable::admin::v2::ListBackupsRequest, Options)

Lists Cloud Bigtable backups.

Returns both completed and pending backups.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::ListBackupsRequest` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::bigtable::admin::v2::Backup >

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.

RestoreTable(google::bigtable::admin::v2::RestoreTableRequest const &, Options)

Create a new table by restoring from a completed 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
Name	Description
`request`	`google::bigtable::admin::v2::RestoreTableRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Table > >

CopyBackup(std::string const &, std::string const &, std::string const &, google::protobuf::Timestamp const &, Options)

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the destination cluster that will contain the backup copy. The cluster must already exists. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`.
`backup_id`	`std::string const &` Required. The id of the new backup. The `backup_id` along with `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]*.
`source_backup`	`std::string const &` Required. The source backup to be copied from. The source backup needs to be in READY state for it to be copied. Copying a copied backup is not allowed. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
`expire_time`	`google::protobuf::Timestamp const &` Required. Required. The expiration time of the copied backup with microsecond granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Backup > >

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.

CopyBackup(google::bigtable::admin::v2::CopyBackupRequest const &, Options)

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Parameters
Name	Description
`request`	`google::bigtable::admin::v2::CopyBackupRequest const &` 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.CopyBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::bigtable::admin::v2::Backup > >

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.

GetIamPolicy(std::string const &, Options)

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
Name	Description
`resource`	`std::string const &` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	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(google::iam::v1::GetIamPolicyRequest const &, Options)

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
Name	Description
`request`	`google::iam::v1::GetIamPolicyRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	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(std::string const &, google::iam::v1::Policy const &, Options)

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

Replaces any existing policy.

Parameters
Name	Description
`resource`	`std::string const &` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`google::iam::v1::Policy const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	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(std::string const &, IamUpdater const &, Options)

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
Name	Description
`resource`	`std::string const &` Required. The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`updater`	`IamUpdater const &` Required. Functor to map the current policy to a new one.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	google::iam::v1::Policy

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

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

Replaces any existing policy.

Parameters
Name	Description
`request`	`google::iam::v1::SetIamPolicyRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	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.

TestIamPermissions(std::string const &, std::vector< std::string > const &, Options)

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

Parameters
Name	Description
`resource`	`std::string const &` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	`std::vector< std::string > const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::TestIamPermissionsResponse >`	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(google::iam::v1::TestIamPermissionsRequest const &, Options)

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

Parameters
Name	Description
`request`	`google::iam::v1::TestIamPermissionsRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::TestIamPermissionsResponse >`	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.

AsyncCheckConsistency(std::string const &, std::string const &, Options)

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	Description
`name`	`std::string const &` 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`	`std::string const &` Required. The token created using GenerateConsistencyToken for the Table.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`future< StatusOr< google::bigtable::admin::v2::CheckConsistencyResponse > >`	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(google::bigtable::admin::v2::CheckConsistencyRequest const &, Options)

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	Description
`request`	`google::bigtable::admin::v2::CheckConsistencyRequest const &` 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`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`future< StatusOr< google::bigtable::admin::v2::CheckConsistencyResponse > >`	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.