com.google.cloud.bigtable.grpc

Class BigtableTableAdminGrpcClient

java.lang.Object

com.google.cloud.bigtable.grpc.BigtableTableAdminGrpcClient

All Implemented Interfaces:

BigtableTableAdminClient

@InternalApi(value="For internal usage only")
public class BigtableTableAdminGrpcClient
extends Object
implements BigtableTableAdminClient

A gRPC client for accessing the Bigtable Table Admin API.

For internal use only - public for technical reasons.

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

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

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.

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.

getIamPolicy

public com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

Get an IAM policy.

Specified by:

getIamPolicy in interface BigtableTableAdminClient

Parameters:

request - a GetIamPolicyRequest object.

Returns:

a Policy object.

See Also:

Cloud Bigtable access control

setIamPolicy

public com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

Set an IAM policy.

Specified by:

setIamPolicy in interface BigtableTableAdminClient

Parameters:

request - a SetIamPolicyRequest object.

Returns:

a Policy object.

See Also:

Cloud Bigtable access control

testIamPermissions

public com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

Tests an IAM policy.

Specified by:

testIamPermissions in interface BigtableTableAdminClient

Parameters:

request - a TestIamPermissionsRequest object.

Returns:

a TestIamPermissionsResponse object.

See Also:

Cloud Bigtable access control

createBackupAsync

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createBackupAsync(com.google.bigtable.admin.v2.CreateBackupRequest request)

Description copied from interface: BigtableTableAdminClient

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

Specified by:

createBackupAsync in interface BigtableTableAdminClient

Parameters:

request - a CreateBackupRequest object.

Returns:

The long running Operation for the request.

getBackupAsync

public com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Backup> getBackupAsync(com.google.bigtable.admin.v2.GetBackupRequest request)

Description copied from interface: BigtableTableAdminClient

Gets metadata information about the specified backup.

Specified by:

getBackupAsync in interface BigtableTableAdminClient

Parameters:

request - a GetBackupRequest object.

Returns:

The Backup defined by the request.

updateBackupAsync

public com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.Backup> updateBackupAsync(com.google.bigtable.admin.v2.UpdateBackupRequest request)

Description copied from interface: BigtableTableAdminClient

Updates the specified backup.

Specified by:

updateBackupAsync in interface BigtableTableAdminClient

Parameters:

request - the request to update the Backup.

listBackupsAsync

public com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.admin.v2.ListBackupsResponse> listBackupsAsync(com.google.bigtable.admin.v2.ListBackupsRequest request)

Description copied from interface: BigtableTableAdminClient

Lists all backups associated with the specified cluster.

Specified by:

listBackupsAsync in interface BigtableTableAdminClient

Parameters:

request - a GetBackupRequest object.

Returns:

The ListBackupsResponse which has the list of the backups in the cluster.

deleteBackupAsync

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

Description copied from interface: BigtableTableAdminClient

Permanently deletes the specified backup.

Specified by:

deleteBackupAsync in interface BigtableTableAdminClient

Parameters:

request - a DeleteBackupRequest object.

restoreTableAsync

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> restoreTableAsync(com.google.bigtable.admin.v2.RestoreTableRequest request)

Description copied from interface: BigtableTableAdminClient

Creates a new table from a backup.

Specified by:

restoreTableAsync in interface BigtableTableAdminClient

Parameters:

request - a RestoreTableRequest object.

Returns:

The long running Operation for the request.

getOperation

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

BigtableTableAdminClient.createBackupAsync(CreateBackupRequest) and BigtableTableAdminClient.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.

Specified by:

getOperation in interface BigtableTableAdminClient

Parameters:

request - a GetOperationRequest object.

Returns:

a Operation object.

waitForOperation

public com.google.longrunning.Operation waitForOperation(com.google.longrunning.Operation operation)
                                                  throws IOException,
                                                         TimeoutException

Waits for the long running operation to complete by polling with exponential backoff. A default timeout of 10 minutes is used.

Specified by:

waitForOperation in interface BigtableTableAdminClient

Throws:

IOException

TimeoutException - If the timeout is exceeded.

waitForOperation

public com.google.longrunning.Operation waitForOperation(com.google.longrunning.Operation operation,
                                                         long timeout,
                                                         TimeUnit timeUnit)
                                                  throws TimeoutException,
                                                         IOException

Waits for the long running operation to complete by polling with exponential backoff.

Specified by:

waitForOperation in interface BigtableTableAdminClient

Throws:

TimeoutException - If the timeout is exceeded.

IOException

snapshotTableAsync

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

Specified by:

snapshotTableAsync in interface BigtableTableAdminClient

getSnapshotAsync

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

Specified by:

getSnapshotAsync in interface BigtableTableAdminClient

listSnapshotsAsync

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

Specified by:

listSnapshotsAsync in interface BigtableTableAdminClient

deleteSnapshotAsync

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

Specified by:

deleteSnapshotAsync in interface BigtableTableAdminClient

createTableFromSnapshotAsync

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

Specified by:

createTableFromSnapshotAsync in interface BigtableTableAdminClient