com.google.cloud.bigtable.core

Interface IBigtableTableAdminClient

All Known Implementing Classes:

BigtableTableAdminClientWrapper

@InternalApi(value="For internal usage only")
public interface IBigtableTableAdminClient

Interface to wrap BigtableTableAdminClient with Google-Cloud-java's models.

For internal use only - public for technical reasons.

Method Summary

Modifier and Type	Method and Description
com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Backup>	createBackupAsync(com.google.cloud.bigtable.admin.v2.models.CreateBackupRequest request) Creates a new backup from a table in a specific cluster.
com.google.cloud.bigtable.admin.v2.models.Table	createTable(com.google.cloud.bigtable.admin.v2.models.CreateTableRequest request) Creates a new table.
com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Table>	createTableAsync(com.google.cloud.bigtable.admin.v2.models.CreateTableRequest request) Creates a new table asynchronously.
com.google.api.core.ApiFuture<com.google.longrunning.Operation>	createTableFromSnapshotAsync(com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest request) Deprecated. this will be removed in a future release - please use backups API instead
com.google.api.core.ApiFuture<Void>	deleteBackupAsync(String clusterId, String backupId) Permanently deletes the specified backup.
com.google.api.core.ApiFuture<Void>	deleteSnapshotAsync(com.google.bigtable.admin.v2.DeleteSnapshotRequest request) Deprecated. this will be removed in a future release - please use backups API instead
void	deleteTable(String tableId) Permanently deletes a specified table and all of its data.
com.google.api.core.ApiFuture<Void>	deleteTableAsync(String tableId) Permanently deletes a specified table and all of its data.
void	dropAllRows(String tableId) Drops all data in the table.
com.google.api.core.ApiFuture<Void>	dropAllRowsAsync(String tableId) Asynchronously drops all data in the table
void	dropRowRange(String tableId, com.google.protobuf.ByteString rowKeyPrefix) Permanently deletes all rows in a range.
void	dropRowRange(String tableId, String rowKeyPrefix) Permanently deletes all rows in a range.
com.google.api.core.ApiFuture<Void>	dropRowRangeAsync(String tableId, com.google.protobuf.ByteString rowKeyPrefix) Permanently deletes all rows in a range.
com.google.api.core.ApiFuture<Void>	dropRowRangeAsync(String tableId, String rowKeyPrefix) Permanently deletes all rows in a range.
com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Backup>	getBackupAsync(String clusterId, String backupId) Gets metadata information about the specified backup.
com.google.api.core.ApiFuture<com.google.bigtable.admin.v2.Snapshot>	getSnapshotAsync(com.google.bigtable.admin.v2.GetSnapshotRequest request) Deprecated. this will be removed in a future release - please use backups API instead
com.google.cloud.bigtable.admin.v2.models.Table	getTable(String tableId) Gets the details of a table.
com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Table>	getTableAsync(String tableId) Gets the details of a table asynchronously.
com.google.api.core.ApiFuture<List<String>>	listBackupsAsync(String clusterId) Lists all backups associated with the specified cluster.
com.google.api.core.ApiFuture<com.google.bigtable.admin.v2.ListSnapshotsResponse>	listSnapshotsAsync(com.google.bigtable.admin.v2.ListSnapshotsRequest request) Deprecated. this will be removed in a future release - please use backups API instead
List<String>	listTables() Lists the names of all tables in an instance.
com.google.api.core.ApiFuture<List<String>>	listTablesAsync() Lists the names of all tables in an instance asynchronously.
com.google.cloud.bigtable.admin.v2.models.Table	modifyFamilies(com.google.cloud.bigtable.admin.v2.models.ModifyColumnFamiliesRequest request) Creates, modifies or deletes a new column family within a specified table.
com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Table>	modifyFamiliesAsync(com.google.cloud.bigtable.admin.v2.models.ModifyColumnFamiliesRequest request) Creates, modifies or deletes a new column family within a specified table.
com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.RestoredTableResult>	restoreTableAsync(com.google.cloud.bigtable.admin.v2.models.RestoreTableRequest request) Creates a new table from a backup.
com.google.api.core.ApiFuture<com.google.longrunning.Operation>	snapshotTableAsync(com.google.bigtable.admin.v2.SnapshotTableRequest request) Deprecated. this will be removed in a future release - please use backups API instead
com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Backup>	updateBackupAsync(com.google.cloud.bigtable.admin.v2.models.UpdateBackupRequest request) Update the specified backup.

Method Detail

createTable

com.google.cloud.bigtable.admin.v2.models.Table createTable(com.google.cloud.bigtable.admin.v2.models.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.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Table> createTableAsync(com.google.cloud.bigtable.admin.v2.models.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.cloud.bigtable.admin.v2.models.Table getTable(String tableId)

Gets the details of a table.

Parameters:

tableId - a String object.

Returns:

a Table object.

getTableAsync

com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Table> getTableAsync(String tableId)

Gets the details of a table asynchronously.

Returns:

a ApiFuture that returns a Table object.

listTables

List<String> listTables()

Lists the names of all tables in an instance.

Returns:

an immutable List object containing tableId.

listTablesAsync

com.google.api.core.ApiFuture<List<String>> listTablesAsync()

Lists the names of all tables in an instance asynchronously.

Returns:

a ApiFuture of type Void will be set when request is successful otherwise exception will be thrown.

deleteTable

void deleteTable(String tableId)

Permanently deletes a specified table and all of its data.

deleteTableAsync

com.google.api.core.ApiFuture<Void> deleteTableAsync(String tableId)

Permanently deletes a specified table and all of its data.

Returns:

a ApiFuture of type Void will be set when request is successful otherwise exception will be thrown.

modifyFamilies

com.google.cloud.bigtable.admin.v2.models.Table modifyFamilies(com.google.cloud.bigtable.admin.v2.models.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.

modifyFamiliesAsync

com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Table> modifyFamiliesAsync(com.google.cloud.bigtable.admin.v2.models.ModifyColumnFamiliesRequest request)

Creates, modifies or deletes a new column family within a specified table.

Parameters:

request - a ModifyColumnFamiliesRequest object.

Returns:

a ApiFuture that returns Table object that contains the updated table structure.

dropRowRange

void dropRowRange(String tableId,
                  String rowKeyPrefix)

Permanently deletes all rows in a range.

Parameters:

tableId -

rowKeyPrefix -

dropRowRange

void dropRowRange(String tableId,
                  com.google.protobuf.ByteString rowKeyPrefix)

Permanently deletes all rows in a range.

Parameters:

tableId -

rowKeyPrefix -

dropRowRangeAsync

com.google.api.core.ApiFuture<Void> dropRowRangeAsync(String tableId,
                                                      String rowKeyPrefix)

Permanently deletes all rows in a range.

Parameters:

tableId -

rowKeyPrefix -

Returns:

a ApiFuture that returns Void object.

dropRowRangeAsync

com.google.api.core.ApiFuture<Void> dropRowRangeAsync(String tableId,
                                                      com.google.protobuf.ByteString rowKeyPrefix)

Permanently deletes all rows in a range.

Parameters:

tableId -

rowKeyPrefix -

Returns:

a ApiFuture that returns Void object.

dropAllRows

void dropAllRows(String tableId)

Drops all data in the table.

Parameters:

tableId - a String object.

dropAllRowsAsync

com.google.api.core.ApiFuture<Void> dropAllRowsAsync(String tableId)

Asynchronously drops all data in the table

Parameters:

tableId - a String object.

snapshotTableAsync

@Deprecated
com.google.api.core.ApiFuture<com.google.longrunning.Operation> snapshotTableAsync(com.google.bigtable.admin.v2.SnapshotTableRequest request)

Deprecated. this will be removed in a future release - please use backups API instead

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

@Deprecated
com.google.api.core.ApiFuture<com.google.bigtable.admin.v2.Snapshot> getSnapshotAsync(com.google.bigtable.admin.v2.GetSnapshotRequest request)

Deprecated. this will be removed in a future release - please use backups API instead

Gets metadata information about the specified snapshot.

Parameters:

request - a GetSnapshotRequest object.

Returns:

The Snapshot defined by the request.

listSnapshotsAsync

@Deprecated
com.google.api.core.ApiFuture<com.google.bigtable.admin.v2.ListSnapshotsResponse> listSnapshotsAsync(com.google.bigtable.admin.v2.ListSnapshotsRequest request)

Deprecated. this will be removed in a future release - please use backups API instead

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

@Deprecated
com.google.api.core.ApiFuture<Void> deleteSnapshotAsync(com.google.bigtable.admin.v2.DeleteSnapshotRequest request)

Deprecated. this will be removed in a future release - please use backups API instead

Permanently deletes the specified snapshot.

Parameters:

request - a DeleteSnapshotRequest object.

createTableFromSnapshotAsync

@Deprecated
com.google.api.core.ApiFuture<com.google.longrunning.Operation> createTableFromSnapshotAsync(com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest request)

Deprecated. this will be removed in a future release - please use backups API instead

Creates a new table from a snapshot.

Parameters:

request - a CreateTableFromSnapshotRequest object.

Returns:

The long running Operation for the request.

createBackupAsync

com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Backup> createBackupAsync(com.google.cloud.bigtable.admin.v2.models.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.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Backup> getBackupAsync(String clusterId,
                                                                                               String backupId)

Gets metadata information about the specified backup.

updateBackupAsync

com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.Backup> updateBackupAsync(com.google.cloud.bigtable.admin.v2.models.UpdateBackupRequest request)

Update the specified backup.

listBackupsAsync

com.google.api.core.ApiFuture<List<String>> listBackupsAsync(String clusterId)

Lists all backups associated with the specified cluster.

deleteBackupAsync

com.google.api.core.ApiFuture<Void> deleteBackupAsync(String clusterId,
                                                      String backupId)

Permanently deletes the specified backup.

restoreTableAsync

com.google.api.core.ApiFuture<com.google.cloud.bigtable.admin.v2.models.RestoredTableResult> restoreTableAsync(com.google.cloud.bigtable.admin.v2.models.RestoreTableRequest request)

Creates a new table from a backup.

Returns:

The long running Operation for the request.