Struct BigtableTableAdmin 

pub struct BigtableTableAdmin { /* private fields */ }

Implements a client for the Cloud Bigtable Admin API.

Example

let client = BigtableTableAdmin::builder().build().await?;
// use `client` to make requests to the Cloud Bigtable Admin API.

Service Description

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

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

Configuration

To configure BigtableTableAdmin use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://bigtableadmin.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

BigtableTableAdmin holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap BigtableTableAdmin in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl BigtableTableAdmin

pub fn builder() -> ClientBuilder

Returns a builder for BigtableTableAdmin.

let client = BigtableTableAdmin::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: BigtableTableAdmin + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn create_table(&self) -> CreateTable

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.

pub fn create_table_from_snapshot(&self) -> CreateTableFromSnapshot

Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_tables(&self) -> ListTables

Lists all tables served from a specified instance.

pub fn get_table(&self) -> GetTable

Gets metadata information about the specified table.

pub fn update_table(&self) -> UpdateTable

Updates a specified table.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_table(&self) -> DeleteTable

Permanently deletes a specified table and all of its data.

pub fn undelete_table(&self) -> UndeleteTable

Restores a specified table which was accidentally deleted.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn create_authorized_view(&self) -> CreateAuthorizedView

Creates a new AuthorizedView in a table.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_authorized_views(&self) -> ListAuthorizedViews

Lists all AuthorizedViews from a specific table.

pub fn get_authorized_view(&self) -> GetAuthorizedView

Gets information from a specified AuthorizedView.

pub fn update_authorized_view(&self) -> UpdateAuthorizedView

Updates an AuthorizedView in a table.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_authorized_view(&self) -> DeleteAuthorizedView

Permanently deletes a specified AuthorizedView.

pub fn modify_column_families(&self) -> ModifyColumnFamilies

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.

pub fn drop_row_range(&self) -> DropRowRange

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.

pub fn generate_consistency_token(&self) -> GenerateConsistencyToken

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.

pub fn check_consistency(&self) -> CheckConsistency

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.

pub fn snapshot_table(&self) -> SnapshotTable

Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_snapshot(&self) -> GetSnapshot

Gets metadata information about the specified snapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

pub fn list_snapshots(&self) -> ListSnapshots

Lists all snapshots associated with the specified cluster.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

pub fn delete_snapshot(&self) -> DeleteSnapshot

Permanently deletes the specified snapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

pub fn create_backup(&self) -> CreateBackup

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_backup(&self) -> GetBackup

Gets metadata on a pending or completed Cloud Bigtable Backup.

pub fn update_backup(&self) -> UpdateBackup

Updates a pending or completed Cloud Bigtable Backup.

pub fn delete_backup(&self) -> DeleteBackup

Deletes a pending or completed Cloud Bigtable backup.

pub fn list_backups(&self) -> ListBackups

Lists Cloud Bigtable backups. Returns both completed and pending backups.

pub fn restore_table(&self) -> RestoreTable

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. The response type is Table, if successful.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn copy_backup(&self) -> CopyBackup

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

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on a Bigtable resource. Replaces any existing policy.

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that the caller has on the specified Bigtable resource.

pub fn create_schema_bundle(&self) -> CreateSchemaBundle

Creates a new schema bundle in the specified table.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_schema_bundle(&self) -> UpdateSchemaBundle

Updates a schema bundle in the specified table.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_schema_bundle(&self) -> GetSchemaBundle

Gets metadata information about the specified schema bundle.

pub fn list_schema_bundles(&self) -> ListSchemaBundles

Lists all schema bundles associated with the specified table.

pub fn delete_schema_bundle(&self) -> DeleteSchemaBundle

Deletes a schema bundle in the specified table.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for BigtableTableAdmin

fn clone(&self) -> BigtableTableAdmin

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BigtableTableAdmin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.