BigtableTableAdminClient (Cloud Bigtable HBase Client for Java 1.16.0 API)

All Known Implementing Classes:

BigtableTableAdminGrpcClient
```
@InternalExtensionOnly
public interface BigtableTableAdminClient
```
A client for the Cloud Bigtable Table Admin API.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>`	`createBackupAsync(com.google.bigtable.admin.v2.CreateBackupRequest request)` Creates a new backup from a table in a specific cluster.
`com.google.bigtable.admin.v2.Table`	`createTable(com.google.bigtable.admin.v2.CreateTableRequest request)` Creates a new table.
`com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Table>`	`createTableAsync(com.google.bigtable.admin.v2.CreateTableRequest request)` Creates a new table asynchronously.
`com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>`	`createTableFromSnapshotAsync(com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest request)` Deprecated. Snapshots will be removed in the future
`com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>`	`deleteBackupAsync(com.google.bigtable.admin.v2.DeleteBackupRequest request)` Permanently deletes the specified backup.
`com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>`	`deleteSnapshotAsync(com.google.bigtable.admin.v2.DeleteSnapshotRequest request)` Deprecated. Snapshots will be removed in the future
`void`	`deleteTable(com.google.bigtable.admin.v2.DeleteTableRequest request)` Permanently deletes a specified table and all of its data.
`com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>`	`deleteTableAsync(com.google.bigtable.admin.v2.DeleteTableRequest request)` Permanently deletes a specified table and all of its data.
`void`	`dropRowRange(com.google.bigtable.admin.v2.DropRowRangeRequest request)` Permanently deletes all rows in a range.
`com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>`	`dropRowRangeAsync(com.google.bigtable.admin.v2.DropRowRangeRequest request)` Permanently deletes all rows in a range.
`com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Backup>`	`getBackupAsync(com.google.bigtable.admin.v2.GetBackupRequest request)` Gets metadata information about the specified backup.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Get an IAM policy.
`com.google.longrunning.Operation`	`getOperation(com.google.longrunning.GetOperationRequest request)` Gets the latest state of a long-running operation.
`com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Snapshot>`	`getSnapshotAsync(com.google.bigtable.admin.v2.GetSnapshotRequest request)` Deprecated. Snapshots will be removed in the future
`com.google.bigtable.admin.v2.Table`	`getTable(com.google.bigtable.admin.v2.GetTableRequest request)` Gets the details of a table.
`com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Table>`	`getTableAsync(com.google.bigtable.admin.v2.GetTableRequest request)` Gets the details of a table asynchronously.
`com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.ListBackupsResponse>`	`listBackupsAsync(com.google.bigtable.admin.v2.ListBackupsRequest request)` Lists all backups associated with the specified cluster.
`com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.ListSnapshotsResponse>`	`listSnapshotsAsync(com.google.bigtable.admin.v2.ListSnapshotsRequest request)` Deprecated. Snapshots will be removed in the future
`com.google.bigtable.admin.v2.ListTablesResponse`	`listTables(com.google.bigtable.admin.v2.ListTablesRequest request)` Lists the names of all tables in an instance.
`com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.ListTablesResponse>`	`listTablesAsync(com.google.bigtable.admin.v2.ListTablesRequest request)` Lists the names of all tables in an instance asynchronously.
`com.google.bigtable.admin.v2.Table`	`modifyColumnFamily(com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest request)` Creates, modifies or deletes a new column family within a specified table.
`com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Table>`	`modifyColumnFamilyAsync(com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest request)` Creates, modifies or deletes a new column family within a specified table.
`com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>`	`restoreTableAsync(com.google.bigtable.admin.v2.RestoreTableRequest request)` Creates a new table from a backup.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Set an IAM policy.
`com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>`	`snapshotTableAsync(com.google.bigtable.admin.v2.SnapshotTableRequest request)` Deprecated. Snapshots will be removed in the future
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Tests an IAM policy.
`com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Backup>`	`updateBackupAsync(com.google.bigtable.admin.v2.UpdateBackupRequest request)` Updates the specified backup.
`com.google.longrunning.Operation`	`waitForOperation(com.google.longrunning.Operation operation)` Waits for the long running operation to complete by polling with exponential backoff.
`com.google.longrunning.Operation`	`waitForOperation(com.google.longrunning.Operation operation, long timeout, TimeUnit timeUnit)` Waits for the long running operation to complete by polling with exponential backoff.
`void`	`waitForReplication(BigtableTableName tableName, long timeout)` Blocks until replication has caught up to the point this method was called or timeout is reached.

- Method Detail
  - createTable
```
com.google.bigtable.admin.v2.Table createTable(com.google.bigtable.admin.v2.CreateTableRequest request)
```
    Creates a new table. The table can be created with a full set of initial column families, specified in the request.
    
    Parameters:
    
    request - a CreateTableRequest object.
  - createTableAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Table> createTableAsync(com.google.bigtable.admin.v2.CreateTableRequest request)
```
    Creates a new table asynchronously. The table can be created with a full set of initial column families, specified in the request.
    
    Parameters:
    
    request - a CreateTableRequest object.
  - getTable
```
com.google.bigtable.admin.v2.Table getTable(com.google.bigtable.admin.v2.GetTableRequest request)
```
    Gets the details of a table.
    
    Parameters:
    
    request - a GetTableRequest object.
    
    Returns:
    
    a Table object.
  - getTableAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Table> getTableAsync(com.google.bigtable.admin.v2.GetTableRequest request)
```
    Gets the details of a table asynchronously.
    
    Parameters:
    
    request - a GetTableRequest object.
    
    Returns:
    
    a ListenableFuture that returns a Table object.
  - listTables
```
com.google.bigtable.admin.v2.ListTablesResponse listTables(com.google.bigtable.admin.v2.ListTablesRequest request)
```
    Lists the names of all tables in an instance.
    
    Parameters:
    
    request - a ListTablesRequest object.
    
    Returns:
    
    a ListTablesResponse object.
  - listTablesAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.ListTablesResponse> listTablesAsync(com.google.bigtable.admin.v2.ListTablesRequest request)
```
    Lists the names of all tables in an instance asynchronously.
    
    Parameters:
    
    request - a ListTablesRequest object.
    
    Returns:
    
    a ListenableFuture that returns a ListTablesResponse object.
  - deleteTable
```
void deleteTable(com.google.bigtable.admin.v2.DeleteTableRequest request)
```
    Permanently deletes a specified table and all of its data.
    
    Parameters:
    
    request - a DeleteTableRequest object.
  - deleteTableAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteTableAsync(com.google.bigtable.admin.v2.DeleteTableRequest request)
```
    Permanently deletes a specified table and all of its data.
    
    Parameters:
    
    request - a DeleteTableRequest object.
    
    Returns:
    
    a ListenableFuture that returns Empty object.
  - modifyColumnFamily
```
com.google.bigtable.admin.v2.Table modifyColumnFamily(com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest request)
```
    Creates, modifies or deletes a new column family within a specified table.
    
    Parameters:
    
    request - a ModifyColumnFamiliesRequest object.
    
    Returns:
    
    return Table object that contains the updated table structure.
  - modifyColumnFamilyAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Table> modifyColumnFamilyAsync(com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest request)
```
    Creates, modifies or deletes a new column family within a specified table.
    
    Parameters:
    
    request - a ModifyColumnFamiliesRequest object.
    
    Returns:
    
    a ListenableFuture that returns Table object that contains the updated table structure.
  - dropRowRange
```
void dropRowRange(com.google.bigtable.admin.v2.DropRowRangeRequest request)
```
    Permanently deletes all rows in a range.
    
    Parameters:
    
    request - a DropRowRangeRequest object.
  - dropRowRangeAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> dropRowRangeAsync(com.google.bigtable.admin.v2.DropRowRangeRequest request)
```
    Permanently deletes all rows in a range.
    
    Parameters:
    
    request - a DropRowRangeRequest object.
    
    Returns:
    
    a ListenableFuture that returns Empty object.
  - waitForReplication
```
void waitForReplication(BigtableTableName tableName,
                        long timeout)
                 throws InterruptedException,
                        TimeoutException
```
    Blocks until replication has caught up to the point this method was called or timeout is reached.
    
    Parameters:
    
    tableName - the name of the table to wait for replication.
    
    timeout - the maximum time to wait in seconds.
    
    Throws:
    
    InterruptedException - if call is interrupted while waiting to recheck if replication has caught up.
    
    TimeoutException - if timeout is reached.
  - getIamPolicy
```
com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
```
    Get an IAM policy.
    
    Parameters:
    
    request - a GetIamPolicyRequest object.
    
    Returns:
    
    a Policy object.
    
    See Also:
    
    Cloud Bigtable access control
  - setIamPolicy
```
com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
```
    Set an IAM policy.
    
    Parameters:
    
    request - a SetIamPolicyRequest object.
    
    Returns:
    
    a Policy object.
    
    See Also:
    
    Cloud Bigtable access control
  - testIamPermissions
```
com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
```
    Tests an IAM policy.
    
    Parameters:
    
    request - a TestIamPermissionsRequest object.
    
    Returns:
    
    a TestIamPermissionsResponse object.
    
    See Also:
    
    Cloud Bigtable access control
  - snapshotTableAsync
```
@Deprecated
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> snapshotTableAsync(com.google.bigtable.admin.v2.SnapshotTableRequest request)
```
    Deprecated. Snapshots will be removed in the future
  - getSnapshotAsync
```
@Deprecated
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Snapshot> getSnapshotAsync(com.google.bigtable.admin.v2.GetSnapshotRequest request)
```
    Deprecated. Snapshots will be removed in the future
  - listSnapshotsAsync
```
@Deprecated
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.ListSnapshotsResponse> listSnapshotsAsync(com.google.bigtable.admin.v2.ListSnapshotsRequest request)
```
    Deprecated. Snapshots will be removed in the future
  - deleteSnapshotAsync
```
@Deprecated
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteSnapshotAsync(com.google.bigtable.admin.v2.DeleteSnapshotRequest request)
```
    Deprecated. Snapshots will be removed in the future
  - createTableFromSnapshotAsync
```
@Deprecated
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createTableFromSnapshotAsync(com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest request)
```
    Deprecated. Snapshots will be removed in the future
  - createBackupAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createBackupAsync(com.google.bigtable.admin.v2.CreateBackupRequest request)
```
    Creates a new backup from a table in a specific cluster.
    
    Parameters:
    
    request - a CreateBackupRequest object.
    
    Returns:
    
    The long running Operation for the request.
  - getBackupAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Backup> getBackupAsync(com.google.bigtable.admin.v2.GetBackupRequest request)
```
    Gets metadata information about the specified backup.
    
    Parameters:
    
    request - a GetBackupRequest object.
    
    Returns:
    
    The Backup defined by the request.
  - updateBackupAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Backup> updateBackupAsync(com.google.bigtable.admin.v2.UpdateBackupRequest request)
```
    Updates the specified backup.
    
    Parameters:
    
    request - the request to update the Backup.
  - listBackupsAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.ListBackupsResponse> listBackupsAsync(com.google.bigtable.admin.v2.ListBackupsRequest request)
```
    Lists all backups associated with the specified cluster.
    
    Parameters:
    
    request - a GetBackupRequest object.
    
    Returns:
    
    The ListBackupsResponse which has the list of the backups in the cluster.
  - deleteBackupAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteBackupAsync(com.google.bigtable.admin.v2.DeleteBackupRequest request)
```
    Permanently deletes the specified backup.
    
    Parameters:
    
    request - a DeleteBackupRequest object.
  - restoreTableAsync
```
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> restoreTableAsync(com.google.bigtable.admin.v2.RestoreTableRequest request)
```
    Creates a new table from a backup.
    
    Parameters:
    
    request - a RestoreTableRequest object.
    
    Returns:
    
    The long running Operation for the request.
  - getOperation
```
com.google.longrunning.Operation getOperation(com.google.longrunning.GetOperationRequest request)
```
    Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.
    createBackupAsync(CreateBackupRequest) and restoreTableAsync(RestoreTableRequest) will return a Operation. Use this method and pass in the Operation's name in the request to see if the Operation is done via Operation.getDone(). The backup will not be available until that happens.
    
    Parameters:
    
    request - a GetOperationRequest object.
    
    Returns:
    
    a Operation object.
  - waitForOperation
```
com.google.longrunning.Operation waitForOperation(com.google.longrunning.Operation operation)
                                           throws TimeoutException,
                                                  IOException
```
    Waits for the long running operation to complete by polling with exponential backoff. A default timeout of 10 minutes is used.
    
    Parameters:
    
    operation -
    
    Throws:
    
    IOException
    
    TimeoutException - If the timeout is exceeded.
  - waitForOperation
```
com.google.longrunning.Operation waitForOperation(com.google.longrunning.Operation operation,
                                                  long timeout,
                                                  TimeUnit timeUnit)
                                           throws IOException,
                                                  TimeoutException
```
    Waits for the long running operation to complete by polling with exponential backoff.
    
    Parameters:
    
    operation -
    
    timeout -
    
    timeUnit -
    
    Throws:
    
    IOException
    
    TimeoutException - If the timeout is exceeded.

Interface BigtableTableAdminClient

Method Summary

Method Detail

createTable

createTableAsync

getTable

getTableAsync

listTables

listTablesAsync

deleteTable

deleteTableAsync

modifyColumnFamily

modifyColumnFamilyAsync

dropRowRange

dropRowRangeAsync

waitForReplication

getIamPolicy

setIamPolicy

testIamPermissions

snapshotTableAsync

getSnapshotAsync

listSnapshotsAsync

deleteSnapshotAsync

createTableFromSnapshotAsync

createBackupAsync

getBackupAsync

updateBackupAsync

listBackupsAsync

deleteBackupAsync

restoreTableAsync

getOperation

waitForOperation

waitForOperation