com.google.cloud.bigtable.admin.v2

Class BigtableTableAdminClient

java.lang.Object

com.google.cloud.bigtable.admin.v2.BigtableTableAdminClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by GAPIC v0.0.5")
 @BetaApi
public class BigtableTableAdminClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for creating, configuring, and deleting Cloud Bigtable tables.

Provides access to the table schemas only, not the data stored within the tables.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   Table table = Table.newBuilder().build();
   Table response = bigtableTableAdminClient.createTable(parent, tableId, table);
 }
 
 

Note: close() needs to be called on the bigtableTableAdminClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of BigtableTableAdminSettings to create(). For example:

To customize credentials:

 
 BigtableTableAdminSettings bigtableTableAdminSettings =
     BigtableTableAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BigtableTableAdminClient bigtableTableAdminClient =
     BigtableTableAdminClient.create(bigtableTableAdminSettings);
 
 

To customize the endpoint:

 
 BigtableTableAdminSettings bigtableTableAdminSettings =
     BigtableTableAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 BigtableTableAdminClient bigtableTableAdminClient =
     BigtableTableAdminClient.create(bigtableTableAdminSettings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BigtableTableAdminClient(BigtableTableAdminSettings settings) Constructs an instance of BigtableTableAdminClient, using the given settings.
protected	BigtableTableAdminClient(BigtableTableAdminStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static BigtableTableAdminClient	create() Constructs an instance of BigtableTableAdminClient with default settings.
static BigtableTableAdminClient	create(BigtableTableAdminSettings settings) Constructs an instance of BigtableTableAdminClient, using the given settings.
static BigtableTableAdminClient	create(BigtableTableAdminStub stub) Constructs an instance of BigtableTableAdminClient, using the given stub for making calls.
com.google.bigtable.admin.v2.Table	createTable(com.google.bigtable.admin.v2.CreateTableRequest request) Creates a new table in the specified instance.
com.google.bigtable.admin.v2.Table	createTable(com.google.bigtable.admin.v2.InstanceName parent, String tableId, com.google.bigtable.admin.v2.Table table) Creates a new table in the specified instance.
com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.CreateTableRequest,com.google.bigtable.admin.v2.Table>	createTableCallable() Creates a new table in the specified instance.
void	deleteTable(com.google.bigtable.admin.v2.TableName name) Permanently deletes a specified table and all of its data.
com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.DeleteTableRequest,com.google.protobuf.Empty>	deleteTableCallable() Permanently deletes a specified table and all of its data.
void	dropRowRange(com.google.bigtable.admin.v2.DropRowRangeRequest request) Permanently drop/delete a row range from a specified table.
void	dropRowRange(String name, com.google.protobuf.ByteString rowKeyPrefix) Permanently drop/delete a row range from a specified table.
com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.DropRowRangeRequest,com.google.protobuf.Empty>	dropRowRangeCallable() Permanently drop/delete a row range from a specified table.
BigtableTableAdminSettings	getSettings()
BigtableTableAdminStub	getStub()
com.google.bigtable.admin.v2.Table	getTable(com.google.bigtable.admin.v2.GetTableRequest request) Gets metadata information about the specified table.
com.google.bigtable.admin.v2.Table	getTable(com.google.bigtable.admin.v2.TableName name) Gets metadata information about the specified table.
com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.GetTableRequest,com.google.bigtable.admin.v2.Table>	getTableCallable() Gets metadata information about the specified table.
boolean	isShutdown()
boolean	isTerminated()
PagedResponseWrappers.ListTablesPagedResponse	listTables(com.google.bigtable.admin.v2.InstanceName parent) Lists all tables served from a specified instance.
com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.ListTablesRequest,com.google.bigtable.admin.v2.ListTablesResponse>	listTablesCallable() Lists all tables served from a specified instance.
com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.ListTablesRequest,PagedResponseWrappers.ListTablesPagedResponse>	listTablesPagedCallable() Lists all tables served from a specified instance.
com.google.bigtable.admin.v2.Table	modifyColumnFamilies(com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest request) Performs a series of column family modifications on the specified table.
com.google.bigtable.admin.v2.Table	modifyColumnFamilies(com.google.bigtable.admin.v2.TableName name, List<com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest.Modification> modifications) Performs a series of column family modifications on the specified table.
com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest,com.google.bigtable.admin.v2.Table>	modifyColumnFamiliesCallable() Performs a series of column family modifications on the specified table.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

BigtableTableAdminClient

protected BigtableTableAdminClient(BigtableTableAdminSettings settings)
                            throws IOException

Constructs an instance of BigtableTableAdminClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

BigtableTableAdminClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected BigtableTableAdminClient(BigtableTableAdminStub stub)

Method Detail

create

public static final BigtableTableAdminClient create()
                                             throws IOException

Constructs an instance of BigtableTableAdminClient with default settings.

Throws:

IOException

create

public static final BigtableTableAdminClient create(BigtableTableAdminSettings settings)
                                             throws IOException

Constructs an instance of BigtableTableAdminClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final BigtableTableAdminClient create(BigtableTableAdminStub stub)

Constructs an instance of BigtableTableAdminClient, using the given stub for making calls. This is for advanced usage - prefer to use BigtableTableAdminSettings}.

getSettings

public final BigtableTableAdminSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public BigtableTableAdminStub getStub()

createTable

public final com.google.bigtable.admin.v2.Table createTable(com.google.bigtable.admin.v2.InstanceName parent,
                                                            String tableId,
                                                            com.google.bigtable.admin.v2.Table table)

Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   Table table = Table.newBuilder().build();
   Table response = bigtableTableAdminClient.createTable(parent, tableId, table);
 }
 

Parameters:

parent - The unique name of the instance in which to create the table. Values are of the form `projects/<project>/instances/<instance>`.

tableId - The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `<parent>/tables/foobar`.

table - The Table to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTable

public final com.google.bigtable.admin.v2.Table createTable(com.google.bigtable.admin.v2.CreateTableRequest request)

Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   Table table = Table.newBuilder().build();
   CreateTableRequest request = CreateTableRequest.newBuilder()
     .setParentWithInstanceName(parent)
     .setTableId(tableId)
     .setTable(table)
     .build();
   Table response = bigtableTableAdminClient.createTable(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTableCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.CreateTableRequest,com.google.bigtable.admin.v2.Table> createTableCallable()

Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   Table table = Table.newBuilder().build();
   CreateTableRequest request = CreateTableRequest.newBuilder()
     .setParentWithInstanceName(parent)
     .setTableId(tableId)
     .setTable(table)
     .build();
   ApiFuture<Table> future = bigtableTableAdminClient.createTableCallable().futureCall(request);
   // Do something
   Table response = future.get();
 }
 

listTables

public final PagedResponseWrappers.ListTablesPagedResponse listTables(com.google.bigtable.admin.v2.InstanceName parent)

Lists all tables served from a specified instance.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   for (Table element : bigtableTableAdminClient.listTables(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - The unique name of the instance for which tables should be listed. Values are of the form `projects/<project>/instances/<instance>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTablesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.ListTablesRequest,PagedResponseWrappers.ListTablesPagedResponse> listTablesPagedCallable()

Lists all tables served from a specified instance.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   ListTablesRequest request = ListTablesRequest.newBuilder()
     .setParentWithInstanceName(parent)
     .build();
   ApiFuture<ListTablesPagedResponse> future = bigtableTableAdminClient.listTablesPagedCallable().futureCall(request);
   // Do something
   for (Table element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTablesCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.ListTablesRequest,com.google.bigtable.admin.v2.ListTablesResponse> listTablesCallable()

Lists all tables served from a specified instance.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   ListTablesRequest request = ListTablesRequest.newBuilder()
     .setParentWithInstanceName(parent)
     .build();
   while (true) {
     ListTablesResponse response = bigtableTableAdminClient.listTablesCallable().call(request);
     for (Table element : response.getTablesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getTable

public final com.google.bigtable.admin.v2.Table getTable(com.google.bigtable.admin.v2.TableName name)

Gets metadata information about the specified table.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   Table response = bigtableTableAdminClient.getTable(name);
 }
 

Parameters:

name - The unique name of the requested table. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTable

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

Gets metadata information about the specified table.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   GetTableRequest request = GetTableRequest.newBuilder()
     .setNameWithTableName(name)
     .build();
   Table response = bigtableTableAdminClient.getTable(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTableCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.GetTableRequest,com.google.bigtable.admin.v2.Table> getTableCallable()

Gets metadata information about the specified table.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   GetTableRequest request = GetTableRequest.newBuilder()
     .setNameWithTableName(name)
     .build();
   ApiFuture<Table> future = bigtableTableAdminClient.getTableCallable().futureCall(request);
   // Do something
   Table response = future.get();
 }
 

deleteTable

public final void deleteTable(com.google.bigtable.admin.v2.TableName name)

Permanently deletes a specified table and all of its data.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   bigtableTableAdminClient.deleteTable(name);
 }
 

Parameters:

name - The unique name of the table to be deleted. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTableCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.DeleteTableRequest,com.google.protobuf.Empty> deleteTableCallable()

Permanently deletes a specified table and all of its data.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   DeleteTableRequest request = DeleteTableRequest.newBuilder()
     .setNameWithTableName(name)
     .build();
   ApiFuture<Void> future = bigtableTableAdminClient.deleteTableCallable().futureCall(request);
   // Do something
   future.get();
 }
 

modifyColumnFamilies

public final com.google.bigtable.admin.v2.Table modifyColumnFamilies(com.google.bigtable.admin.v2.TableName name,
                                                                     List<com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest.Modification> modifications)

Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   List<ModifyColumnFamiliesRequest.Modification> modifications = new ArrayList<>();
   Table response = bigtableTableAdminClient.modifyColumnFamilies(name, modifications);
 }
 

Parameters:

name - The unique name of the table whose families should be modified. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.

modifications - Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

modifyColumnFamilies

public final com.google.bigtable.admin.v2.Table modifyColumnFamilies(com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest request)

Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   List<ModifyColumnFamiliesRequest.Modification> modifications = new ArrayList<>();
   ModifyColumnFamiliesRequest request = ModifyColumnFamiliesRequest.newBuilder()
     .setNameWithTableName(name)
     .addAllModifications(modifications)
     .build();
   Table response = bigtableTableAdminClient.modifyColumnFamilies(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

modifyColumnFamiliesCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest,com.google.bigtable.admin.v2.Table> modifyColumnFamiliesCallable()

Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   List<ModifyColumnFamiliesRequest.Modification> modifications = new ArrayList<>();
   ModifyColumnFamiliesRequest request = ModifyColumnFamiliesRequest.newBuilder()
     .setNameWithTableName(name)
     .addAllModifications(modifications)
     .build();
   ApiFuture<Table> future = bigtableTableAdminClient.modifyColumnFamiliesCallable().futureCall(request);
   // Do something
   Table response = future.get();
 }
 

dropRowRange

public final void dropRowRange(String name,
                               com.google.protobuf.ByteString rowKeyPrefix)

Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   String formattedName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   ByteString rowKeyPrefix = ByteString.copyFromUtf8("");
   bigtableTableAdminClient.dropRowRange(formattedName, rowKeyPrefix);
 }
 

Parameters:

name - The unique name of the table on which to drop a range of rows. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.

rowKeyPrefix - Delete all rows that start with this row key prefix. Prefix cannot be zero length.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

dropRowRange

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

Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   String formattedName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   DropRowRangeRequest request = DropRowRangeRequest.newBuilder()
     .setName(formattedName)
     .build();
   bigtableTableAdminClient.dropRowRange(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

dropRowRangeCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.bigtable.admin.v2.DropRowRangeRequest,com.google.protobuf.Empty> dropRowRangeCallable()

Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.

Sample code:

 try (BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.create()) {
   String formattedName = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   DropRowRangeRequest request = DropRowRangeRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = bigtableTableAdminClient.dropRowRangeCallable().futureCall(request);
   // Do something
   future.get();
 }
 

close

public final void close()
                 throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException