com.google.cloud.bigtable.grpc

Class BigtableTableAdminGrpcClient

java.lang.Object

com.google.cloud.bigtable.grpc.BigtableTableAdminGrpcClient

All Implemented Interfaces:

BigtableTableAdminClient

public class BigtableTableAdminGrpcClient
extends Object
implements BigtableTableAdminClient

A gRPC client for accessing the Bigtable Table Admin API.

Version:

$Id: $Id

Author:

sduskis

Constructor Summary

Constructors

Constructor and Description
BigtableTableAdminGrpcClient(io.grpc.Channel channel, ScheduledExecutorService retryExecutorService, BigtableOptions bigtableOptions) Constructor for BigtableTableAdminGrpcClient.

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BigtableTableAdminGrpcClient

public BigtableTableAdminGrpcClient(io.grpc.Channel channel,
                                    ScheduledExecutorService retryExecutorService,
                                    BigtableOptions bigtableOptions)

Constructor for BigtableTableAdminGrpcClient.

Parameters:

channel - a Channel object.

Method Detail

listTables

public com.google.bigtable.admin.v2.ListTablesResponse listTables(com.google.bigtable.admin.v2.ListTablesRequest request)

Lists the names of all tables in an instance.

Specified by:

listTables in interface BigtableTableAdminClient

Parameters:

request - a ListTablesRequest object.

Returns:

a ListTablesResponse object.

listTablesAsync

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

Specified by:

listTablesAsync in interface BigtableTableAdminClient

Parameters:

request - a ListTablesRequest object.

Returns:

a ListenableFuture that returns a ListTablesResponse object.

getTable

public com.google.bigtable.admin.v2.Table getTable(com.google.bigtable.admin.v2.GetTableRequest request)

Gets the details of a table.

Specified by:

getTable in interface BigtableTableAdminClient

Parameters:

request - a GetTableRequest object.

Returns:

a Table object.

getTableAsync

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

Specified by:

getTableAsync in interface BigtableTableAdminClient

Parameters:

request - a GetTableRequest object.

Returns:

a ListenableFuture that returns a Table object.

createTable

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

Specified by:

createTable in interface BigtableTableAdminClient

Parameters:

request - a CreateTableRequest object.

createTableAsync

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

Specified by:

createTableAsync in interface BigtableTableAdminClient

Parameters:

request - a CreateTableRequest object.

Returns:

modifyColumnFamily

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

Specified by:

modifyColumnFamily in interface BigtableTableAdminClient

Parameters:

request - a ModifyColumnFamiliesRequest object.

Returns:

return Table object that contains the updated table structure.

modifyColumnFamilyAsync

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

Specified by:

modifyColumnFamilyAsync in interface BigtableTableAdminClient

Parameters:

request - a ModifyColumnFamiliesRequest object.

Returns:

deleteTable

public void deleteTable(com.google.bigtable.admin.v2.DeleteTableRequest request)

Permanently deletes a specified table and all of its data.

Specified by:

deleteTable in interface BigtableTableAdminClient

Parameters:

request - a DeleteTableRequest object.

deleteTableAsync

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

Specified by:

deleteTableAsync in interface BigtableTableAdminClient

Parameters:

request - a DeleteTableRequest object.

Returns:

dropRowRange

public void dropRowRange(com.google.bigtable.admin.v2.DropRowRangeRequest request)

Permanently deletes all rows in a range.

Specified by:

dropRowRange in interface BigtableTableAdminClient

Parameters:

request - a DropRowRangeRequest object.

dropRowRangeAsync

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

Specified by:

dropRowRangeAsync in interface BigtableTableAdminClient

Parameters:

request - a DropRowRangeRequest object.

Returns:

waitForReplication

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

This is a private alpha release of Cloud Bigtable replication. 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.

Specified by:

waitForReplication in interface BigtableTableAdminClient

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

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

Specified by:

snapshotTableAsync in interface BigtableTableAdminClient

Parameters:

request - a SnapshotTableRequest object.

Returns:

The long running Operation for the request.

getSnapshotAsync

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

Specified by:

getSnapshotAsync in interface BigtableTableAdminClient

Parameters:

request - a GetSnapshotRequest object.

Returns:

The Snapshot definied by the request.

listSnapshotsAsync

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

Specified by:

listSnapshotsAsync in interface BigtableTableAdminClient

Parameters:

request - a ListSnapshotsRequest object.

Returns:

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

deleteSnapshotAsync

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

Permanently deletes the specified snapshot.

Specified by:

deleteSnapshotAsync in interface BigtableTableAdminClient

Parameters:

request - a DeleteSnapshotRequest object.

createTableFromSnapshotAsync

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

Specified by:

createTableFromSnapshotAsync in interface BigtableTableAdminClient

Parameters:

request - a CreateTableFromSnapshotRequest object.

Returns:

The long running Operation for the request.