Package com.google.cloud.bigtable.grpc

Interface BigtableTableAdminClient

All Known Implementing Classes:

BigtableTableAdminGrpcClient

public interface BigtableTableAdminClient

A client for the Cloud Bigtable Table Admin API.

Version:

$Id: $Id

Author:

sduskis

Method Summary

Modifier and Type	Method	Description
void	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)	Creates a new table from a snapshot.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteSnapshotAsync(com.google.bigtable.admin.v2.DeleteSnapshotRequest request)	Permanently deletes the specified snapshot.
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.Snapshot>	getSnapshotAsync(com.google.bigtable.admin.v2.GetSnapshotRequest request)	Gets metadata information about the specified snapshot.
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.ListSnapshotsResponse>	listSnapshotsAsync(com.google.bigtable.admin.v2.ListSnapshotsRequest request)	Lists all snapshots associated with the specified cluster.
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>	snapshotTableAsync(com.google.bigtable.admin.v2.SnapshotTableRequest request)	Creates a new snapshot from a table in a specific cluster.
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

void 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.

snapshotTableAsync

com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> snapshotTableAsync(com.google.bigtable.admin.v2.SnapshotTableRequest request)

Creates a new snapshot from a table in a specific cluster.

Parameters:

request - a SnapshotTableRequest object.

Returns:

The long running Operation for the request.

getSnapshotAsync

com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Snapshot> getSnapshotAsync(com.google.bigtable.admin.v2.GetSnapshotRequest request)

Gets metadata information about the specified snapshot.

Parameters:

request - a GetSnapshotRequest object.

Returns:

The Snapshot definied by the request.

listSnapshotsAsync

com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.ListSnapshotsResponse> listSnapshotsAsync(com.google.bigtable.admin.v2.ListSnapshotsRequest request)

Lists all snapshots associated with the specified cluster.

Parameters:

request - a ListSnapshotsRequest object.

Returns:

The ListSnapshotsResponse which has the list of the snapshots in the cluster.

deleteSnapshotAsync

com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteSnapshotAsync(com.google.bigtable.admin.v2.DeleteSnapshotRequest request)

Permanently deletes the specified snapshot.

Parameters:

request - a DeleteSnapshotRequest object.

createTableFromSnapshotAsync

com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createTableFromSnapshotAsync(com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest request)

Creates a new table from a snapshot.

Parameters:

request - a CreateTableFromSnapshotRequest object.

Returns:

The long running Operation for the request.