BaseBigtableTableAdminClient (Google Cloud 0.89.0-alpha API)

java.lang.Object
- com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class BaseBigtableTableAdminClient
extends Object
implements 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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   Table table = Table.newBuilder().build();
   Table response = baseBigtableTableAdminClient.createTable(parent, tableId, table);
 }
 
 
```
Note: close() needs to be called on the baseBigtableTableAdminClient 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 BaseBigtableTableAdminSettings to create(). For example:
To customize credentials:
```
 
 BaseBigtableTableAdminSettings baseBigtableTableAdminSettings =
     BaseBigtableTableAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create(baseBigtableTableAdminSettings);
 
 
```
To customize the endpoint:
```
 
 BaseBigtableTableAdminSettings baseBigtableTableAdminSettings =
     BaseBigtableTableAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create(baseBigtableTableAdminSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseBigtableTableAdminClient.ListSnapshotsFixedSizeCollection`
`static class`	`BaseBigtableTableAdminClient.ListSnapshotsPage`
`static class`	`BaseBigtableTableAdminClient.ListSnapshotsPagedResponse`
`static class`	`BaseBigtableTableAdminClient.ListTablesFixedSizeCollection`
`static class`	`BaseBigtableTableAdminClient.ListTablesPage`
`static class`	`BaseBigtableTableAdminClient.ListTablesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseBigtableTableAdminClient(BaseBigtableTableAdminSettings settings)` Constructs an instance of BaseBigtableTableAdminClient, using the given settings.
`protected`	`BaseBigtableTableAdminClient(BigtableTableAdminStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`com.google.bigtable.admin.v2.CheckConsistencyResponse`	`checkConsistency(com.google.bigtable.admin.v2.CheckConsistencyRequest request)` Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
`com.google.bigtable.admin.v2.CheckConsistencyResponse`	`checkConsistency(String name, String consistencyToken)` Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
`com.google.bigtable.admin.v2.CheckConsistencyResponse`	`checkConsistency(com.google.bigtable.admin.v2.TableName name, String consistencyToken)` Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
`UnaryCallable<com.google.bigtable.admin.v2.CheckConsistencyRequest,com.google.bigtable.admin.v2.CheckConsistencyResponse>`	`checkConsistencyCallable()` Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
`void`	`close()`
`static BaseBigtableTableAdminClient`	`create()` Constructs an instance of BaseBigtableTableAdminClient with default settings.
`static BaseBigtableTableAdminClient`	`create(BaseBigtableTableAdminSettings settings)` Constructs an instance of BaseBigtableTableAdminClient, using the given settings.
`static BaseBigtableTableAdminClient`	`create(BigtableTableAdminStub stub)` Constructs an instance of BaseBigtableTableAdminClient, 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.bigtable.admin.v2.Table`	`createTable(String parent, String tableId, com.google.bigtable.admin.v2.Table table)` Creates a new table in the specified instance.
`UnaryCallable<com.google.bigtable.admin.v2.CreateTableRequest,com.google.bigtable.admin.v2.Table>`	`createTableCallable()` Creates a new table in the specified instance.
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>`	`createTableFromSnapshotAsync(com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest request)` Creates a new table from the specified snapshot.
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>`	`createTableFromSnapshotAsync(com.google.bigtable.admin.v2.InstanceName parent, String tableId, com.google.bigtable.admin.v2.SnapshotName sourceSnapshot)` Creates a new table from the specified snapshot.
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>`	`createTableFromSnapshotAsync(String parent, String tableId, String sourceSnapshot)` Creates a new table from the specified snapshot.
`UnaryCallable<com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest,Operation>`	`createTableFromSnapshotCallable()` Creates a new table from the specified snapshot.
`OperationCallable<com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest,com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>`	`createTableFromSnapshotOperationCallable()` Creates a new table from the specified snapshot.
`void`	`deleteSnapshot(com.google.bigtable.admin.v2.DeleteSnapshotRequest request)` Permanently deletes the specified snapshot.
`void`	`deleteSnapshot(com.google.bigtable.admin.v2.SnapshotName name)` Permanently deletes the specified snapshot.
`void`	`deleteSnapshot(String name)` Permanently deletes the specified snapshot.
`UnaryCallable<com.google.bigtable.admin.v2.DeleteSnapshotRequest,Empty>`	`deleteSnapshotCallable()` Permanently deletes the specified snapshot.
`void`	`deleteTable(com.google.bigtable.admin.v2.DeleteTableRequest request)` Permanently deletes a specified table and all of its data.
`void`	`deleteTable(String name)` Permanently deletes a specified table and all of its data.
`void`	`deleteTable(com.google.bigtable.admin.v2.TableName name)` Permanently deletes a specified table and all of its data.
`UnaryCallable<com.google.bigtable.admin.v2.DeleteTableRequest,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.
`UnaryCallable<com.google.bigtable.admin.v2.DropRowRangeRequest,Empty>`	`dropRowRangeCallable()` Permanently drop/delete a row range from a specified table.
`com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse`	`generateConsistencyToken(com.google.bigtable.admin.v2.GenerateConsistencyTokenRequest request)` Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated.
`com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse`	`generateConsistencyToken(String name)` Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated.
`com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse`	`generateConsistencyToken(com.google.bigtable.admin.v2.TableName name)` Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated.
`UnaryCallable<com.google.bigtable.admin.v2.GenerateConsistencyTokenRequest,com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse>`	`generateConsistencyTokenCallable()` Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated.
`OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`BaseBigtableTableAdminSettings`	`getSettings()`
`com.google.bigtable.admin.v2.Snapshot`	`getSnapshot(com.google.bigtable.admin.v2.GetSnapshotRequest request)` Gets metadata information about the specified snapshot.
`com.google.bigtable.admin.v2.Snapshot`	`getSnapshot(com.google.bigtable.admin.v2.SnapshotName name)` Gets metadata information about the specified snapshot.
`com.google.bigtable.admin.v2.Snapshot`	`getSnapshot(String name)` Gets metadata information about the specified snapshot.
`UnaryCallable<com.google.bigtable.admin.v2.GetSnapshotRequest,com.google.bigtable.admin.v2.Snapshot>`	`getSnapshotCallable()` Gets metadata information about the specified snapshot.
`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(String name)` 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.
`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()`
`BaseBigtableTableAdminClient.ListSnapshotsPagedResponse`	`listSnapshots(com.google.bigtable.admin.v2.ClusterName parent)` Lists all snapshots associated with the specified cluster.
`BaseBigtableTableAdminClient.ListSnapshotsPagedResponse`	`listSnapshots(com.google.bigtable.admin.v2.ListSnapshotsRequest request)` Lists all snapshots associated with the specified cluster.
`BaseBigtableTableAdminClient.ListSnapshotsPagedResponse`	`listSnapshots(String parent)` Lists all snapshots associated with the specified cluster.
`UnaryCallable<com.google.bigtable.admin.v2.ListSnapshotsRequest,com.google.bigtable.admin.v2.ListSnapshotsResponse>`	`listSnapshotsCallable()` Lists all snapshots associated with the specified cluster.
`UnaryCallable<com.google.bigtable.admin.v2.ListSnapshotsRequest,BaseBigtableTableAdminClient.ListSnapshotsPagedResponse>`	`listSnapshotsPagedCallable()` Lists all snapshots associated with the specified cluster.
`BaseBigtableTableAdminClient.ListTablesPagedResponse`	`listTables(com.google.bigtable.admin.v2.InstanceName parent)` Lists all tables served from a specified instance.
`BaseBigtableTableAdminClient.ListTablesPagedResponse`	`listTables(com.google.bigtable.admin.v2.ListTablesRequest request)` Lists all tables served from a specified instance.
`BaseBigtableTableAdminClient.ListTablesPagedResponse`	`listTables(String parent)` Lists all tables served from a specified instance.
`UnaryCallable<com.google.bigtable.admin.v2.ListTablesRequest,com.google.bigtable.admin.v2.ListTablesResponse>`	`listTablesCallable()` Lists all tables served from a specified instance.
`UnaryCallable<com.google.bigtable.admin.v2.ListTablesRequest,BaseBigtableTableAdminClient.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(String name, List<com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest.Modification> modifications)` 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.
`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()`
`OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>`	`snapshotTableAsync(com.google.bigtable.admin.v2.SnapshotTableRequest request)` Creates a new snapshot in the specified cluster from the specified source table.
`OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>`	`snapshotTableAsync(String name, String cluster, String snapshotId, String description)` Creates a new snapshot in the specified cluster from the specified source table.
`OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>`	`snapshotTableAsync(com.google.bigtable.admin.v2.TableName name, com.google.bigtable.admin.v2.ClusterName cluster, com.google.bigtable.admin.v2.SnapshotName snapshotId, String description)` Creates a new snapshot in the specified cluster from the specified source table.
`UnaryCallable<com.google.bigtable.admin.v2.SnapshotTableRequest,Operation>`	`snapshotTableCallable()` Creates a new snapshot in the specified cluster from the specified source table.
`OperationCallable<com.google.bigtable.admin.v2.SnapshotTableRequest,com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>`	`snapshotTableOperationCallable()` Creates a new snapshot in the specified cluster from the specified source table.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseBigtableTableAdminClient
```
protected BaseBigtableTableAdminClient(BaseBigtableTableAdminSettings settings)
                                throws IOException
```
Constructs an instance of BaseBigtableTableAdminClient, 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

BaseBigtableTableAdminClient

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

Method Detail

create

public static final BaseBigtableTableAdminClient create()
                                                 throws IOException

Constructs an instance of BaseBigtableTableAdminClient with default settings.

Throws:: IOException

create
```
public static final BaseBigtableTableAdminClient create(BaseBigtableTableAdminSettings settings)
                                                 throws IOException
```
Constructs an instance of BaseBigtableTableAdminClient, 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 BaseBigtableTableAdminClient create(BigtableTableAdminStub stub)

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

getSettings

public final BaseBigtableTableAdminSettings getSettings()

getStub

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

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   Table table = Table.newBuilder().build();
   Table response = baseBigtableTableAdminClient.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:: ApiException - if the remote call fails

createTable

public final com.google.bigtable.admin.v2.Table createTable(String 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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   Table table = Table.newBuilder().build();
   Table response = baseBigtableTableAdminClient.createTable(parent.toString(), 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:: 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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   Table table = Table.newBuilder().build();
   CreateTableRequest request = CreateTableRequest.newBuilder()
     .setParent(parent.toString())
     .setTableId(tableId)
     .setTable(table)
     .build();
   Table response = baseBigtableTableAdminClient.createTable(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

createTableCallable

public final 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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   Table table = Table.newBuilder().build();
   CreateTableRequest request = CreateTableRequest.newBuilder()
     .setParent(parent.toString())
     .setTableId(tableId)
     .setTable(table)
     .build();
   ApiFuture<Table> future = baseBigtableTableAdminClient.createTableCallable().futureCall(request);
   // Do something
   Table response = future.get();
 }

createTableFromSnapshotAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata> createTableFromSnapshotAsync(com.google.bigtable.admin.v2.InstanceName parent,
                                                                                                                                                                                                                                                                     String tableId,
                                                                                                                                                                                                                                                                     com.google.bigtable.admin.v2.SnapshotName sourceSnapshot)

Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.

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

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   SnapshotName sourceSnapshot = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   Table response = baseBigtableTableAdminClient.createTableFromSnapshotAsync(parent, tableId, sourceSnapshot).get();
 }

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`.; sourceSnapshot - The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
Throws:: ApiException - if the remote call fails

createTableFromSnapshotAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata> createTableFromSnapshotAsync(String parent,
                                                                                                                                                                                                                                                                     String tableId,
                                                                                                                                                                                                                                                                     String sourceSnapshot)

Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   SnapshotName sourceSnapshot = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   Table response = baseBigtableTableAdminClient.createTableFromSnapshotAsync(parent.toString(), tableId, sourceSnapshot.toString()).get();
 }

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`.; sourceSnapshot - The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
Throws:: ApiException - if the remote call fails

createTableFromSnapshotAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata> createTableFromSnapshotAsync(com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest request)

Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   SnapshotName sourceSnapshot = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   CreateTableFromSnapshotRequest request = CreateTableFromSnapshotRequest.newBuilder()
     .setParent(parent.toString())
     .setTableId(tableId)
     .setSourceSnapshot(sourceSnapshot.toString())
     .build();
   Table response = baseBigtableTableAdminClient.createTableFromSnapshotAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

createTableFromSnapshotOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest,com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata> createTableFromSnapshotOperationCallable()

Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   SnapshotName sourceSnapshot = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   CreateTableFromSnapshotRequest request = CreateTableFromSnapshotRequest.newBuilder()
     .setParent(parent.toString())
     .setTableId(tableId)
     .setSourceSnapshot(sourceSnapshot.toString())
     .build();
   OperationFuture<Table, CreateTableFromSnapshotMetadata> future = baseBigtableTableAdminClient.createTableFromSnapshotOperationCallable().futureCall(request);
   // Do something
   Table response = future.get();
 }

createTableFromSnapshotCallable

public final UnaryCallable<com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest,Operation> createTableFromSnapshotCallable()

Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "";
   SnapshotName sourceSnapshot = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   CreateTableFromSnapshotRequest request = CreateTableFromSnapshotRequest.newBuilder()
     .setParent(parent.toString())
     .setTableId(tableId)
     .setSourceSnapshot(sourceSnapshot.toString())
     .build();
   ApiFuture<Operation> future = baseBigtableTableAdminClient.createTableFromSnapshotCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

listTables

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

Lists all tables served from a specified instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   for (Table element : baseBigtableTableAdminClient.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:: ApiException - if the remote call fails

listTables

public final BaseBigtableTableAdminClient.ListTablesPagedResponse listTables(String parent)

Lists all tables served from a specified instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   for (Table element : baseBigtableTableAdminClient.listTables(parent.toString()).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:: ApiException - if the remote call fails

listTables

public final BaseBigtableTableAdminClient.ListTablesPagedResponse listTables(com.google.bigtable.admin.v2.ListTablesRequest request)

Lists all tables served from a specified instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   ListTablesRequest request = ListTablesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Table element : baseBigtableTableAdminClient.listTables(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

listTablesPagedCallable

public final UnaryCallable<com.google.bigtable.admin.v2.ListTablesRequest,BaseBigtableTableAdminClient.ListTablesPagedResponse> listTablesPagedCallable()

Lists all tables served from a specified instance.

Sample code:


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

listTablesCallable

public final 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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   ListTablesRequest request = ListTablesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListTablesResponse response = baseBigtableTableAdminClient.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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   Table response = baseBigtableTableAdminClient.getTable(name);
 }

Parameters:: name - The unique name of the requested table. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
Throws:: ApiException - if the remote call fails

getTable

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

Gets metadata information about the specified table.

Sample code:


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

Parameters:: name - The unique name of the requested table. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
Throws:: 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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   GetTableRequest request = GetTableRequest.newBuilder()
     .setName(name.toString())
     .build();
   Table response = baseBigtableTableAdminClient.getTable(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getTableCallable

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

Gets metadata information about the specified table.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   GetTableRequest request = GetTableRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Table> future = baseBigtableTableAdminClient.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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   baseBigtableTableAdminClient.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:: ApiException - if the remote call fails

deleteTable

public final void deleteTable(String name)

Permanently deletes a specified table and all of its data.

Sample code:


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

Parameters:: name - The unique name of the table to be deleted. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.
Throws:: ApiException - if the remote call fails

deleteTable

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

Permanently deletes a specified table and all of its data.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   DeleteTableRequest request = DeleteTableRequest.newBuilder()
     .setName(name.toString())
     .build();
   baseBigtableTableAdminClient.deleteTable(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

deleteTableCallable

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

Permanently deletes a specified table and all of its data.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   DeleteTableRequest request = DeleteTableRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = baseBigtableTableAdminClient.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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   List<ModifyColumnFamiliesRequest.Modification> modifications = new ArrayList<>();
   Table response = baseBigtableTableAdminClient.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:

ApiException - if the remote call fails

modifyColumnFamilies
```
public final com.google.bigtable.admin.v2.Table modifyColumnFamilies(String 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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   List<ModifyColumnFamiliesRequest.Modification> modifications = new ArrayList<>();
   Table response = baseBigtableTableAdminClient.modifyColumnFamilies(name.toString(), 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:

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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   List<ModifyColumnFamiliesRequest.Modification> modifications = new ArrayList<>();
   ModifyColumnFamiliesRequest request = ModifyColumnFamiliesRequest.newBuilder()
     .setName(name.toString())
     .addAllModifications(modifications)
     .build();
   Table response = baseBigtableTableAdminClient.modifyColumnFamilies(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

modifyColumnFamiliesCallable

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

Sample code:


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

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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   DropRowRangeRequest request = DropRowRangeRequest.newBuilder()
     .setName(name.toString())
     .build();
   baseBigtableTableAdminClient.dropRowRange(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

dropRowRangeCallable

public final UnaryCallable<com.google.bigtable.admin.v2.DropRowRangeRequest,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 (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   DropRowRangeRequest request = DropRowRangeRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = baseBigtableTableAdminClient.dropRowRangeCallable().futureCall(request);
   // Do something
   future.get();
 }

generateConsistencyToken
```
public final com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse generateConsistencyToken(com.google.bigtable.admin.v2.TableName name)
```
Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
Sample code:
```
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   GenerateConsistencyTokenResponse response = baseBigtableTableAdminClient.generateConsistencyToken(name);
 }
 
```
Parameters:

name - The unique name of the Table for which to create a consistency token. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.

Throws:

ApiException - if the remote call fails

generateConsistencyToken
```
public final com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse generateConsistencyToken(String name)
```
Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
Sample code:
```
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   GenerateConsistencyTokenResponse response = baseBigtableTableAdminClient.generateConsistencyToken(name.toString());
 }
 
```
Parameters:

name - The unique name of the Table for which to create a consistency token. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.

Throws:

ApiException - if the remote call fails

generateConsistencyToken

public final com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse generateConsistencyToken(com.google.bigtable.admin.v2.GenerateConsistencyTokenRequest request)

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   GenerateConsistencyTokenRequest request = GenerateConsistencyTokenRequest.newBuilder()
     .setName(name.toString())
     .build();
   GenerateConsistencyTokenResponse response = baseBigtableTableAdminClient.generateConsistencyToken(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

generateConsistencyTokenCallable

public final UnaryCallable<com.google.bigtable.admin.v2.GenerateConsistencyTokenRequest,com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse> generateConsistencyTokenCallable()

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   GenerateConsistencyTokenRequest request = GenerateConsistencyTokenRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<GenerateConsistencyTokenResponse> future = baseBigtableTableAdminClient.generateConsistencyTokenCallable().futureCall(request);
   // Do something
   GenerateConsistencyTokenResponse response = future.get();
 }

checkConsistency

public final com.google.bigtable.admin.v2.CheckConsistencyResponse checkConsistency(com.google.bigtable.admin.v2.TableName name,
                                                                                    String consistencyToken)

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   String consistencyToken = "";
   CheckConsistencyResponse response = baseBigtableTableAdminClient.checkConsistency(name, consistencyToken);
 }

Parameters:: name - The unique name of the Table for which to check replication consistency. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.; consistencyToken - The token created using GenerateConsistencyToken for the Table.
Throws:: ApiException - if the remote call fails

checkConsistency

public final com.google.bigtable.admin.v2.CheckConsistencyResponse checkConsistency(String name,
                                                                                    String consistencyToken)

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   String consistencyToken = "";
   CheckConsistencyResponse response = baseBigtableTableAdminClient.checkConsistency(name.toString(), consistencyToken);
 }

Parameters:: name - The unique name of the Table for which to check replication consistency. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.; consistencyToken - The token created using GenerateConsistencyToken for the Table.
Throws:: ApiException - if the remote call fails

checkConsistency

public final com.google.bigtable.admin.v2.CheckConsistencyResponse checkConsistency(com.google.bigtable.admin.v2.CheckConsistencyRequest request)

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   String consistencyToken = "";
   CheckConsistencyRequest request = CheckConsistencyRequest.newBuilder()
     .setName(name.toString())
     .setConsistencyToken(consistencyToken)
     .build();
   CheckConsistencyResponse response = baseBigtableTableAdminClient.checkConsistency(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

checkConsistencyCallable

public final UnaryCallable<com.google.bigtable.admin.v2.CheckConsistencyRequest,com.google.bigtable.admin.v2.CheckConsistencyResponse> checkConsistencyCallable()

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   String consistencyToken = "";
   CheckConsistencyRequest request = CheckConsistencyRequest.newBuilder()
     .setName(name.toString())
     .setConsistencyToken(consistencyToken)
     .build();
   ApiFuture<CheckConsistencyResponse> future = baseBigtableTableAdminClient.checkConsistencyCallable().futureCall(request);
   // Do something
   CheckConsistencyResponse response = future.get();
 }

snapshotTableAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata> snapshotTableAsync(com.google.bigtable.admin.v2.TableName name,
                                                                                                                                                                                                                                                    com.google.bigtable.admin.v2.ClusterName cluster,
                                                                                                                                                                                                                                                    com.google.bigtable.admin.v2.SnapshotName snapshotId,
                                                                                                                                                                                                                                                    String description)

Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ClusterName cluster = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   SnapshotName snapshotId = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   String description = "";
   Snapshot response = baseBigtableTableAdminClient.snapshotTableAsync(name, cluster, snapshotId, description).get();
 }

Parameters:: name - The unique name of the table to have the snapshot taken. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.; cluster - The name of the cluster where the snapshot will be created in. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>`.; snapshotId - The ID by which the new snapshot should be referred to within the parent cluster, e.g., `mysnapshot` of the form: `[_a-zA-Z0-9][-_.a-zA-Z0-9]*` rather than `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot`.; description - Description of the snapshot.
Throws:: ApiException - if the remote call fails

snapshotTableAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata> snapshotTableAsync(String name,
                                                                                                                                                                                                                                                    String cluster,
                                                                                                                                                                                                                                                    String snapshotId,
                                                                                                                                                                                                                                                    String description)

Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ClusterName cluster = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   SnapshotName snapshotId = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   String description = "";
   Snapshot response = baseBigtableTableAdminClient.snapshotTableAsync(name.toString(), cluster.toString(), snapshotId.toString(), description).get();
 }

Parameters:: name - The unique name of the table to have the snapshot taken. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`.; cluster - The name of the cluster where the snapshot will be created in. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>`.; snapshotId - The ID by which the new snapshot should be referred to within the parent cluster, e.g., `mysnapshot` of the form: `[_a-zA-Z0-9][-_.a-zA-Z0-9]*` rather than `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot`.; description - Description of the snapshot.
Throws:: ApiException - if the remote call fails

snapshotTableAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata> snapshotTableAsync(com.google.bigtable.admin.v2.SnapshotTableRequest request)

Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ClusterName cluster = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   SnapshotName snapshotId = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   String description = "";
   SnapshotTableRequest request = SnapshotTableRequest.newBuilder()
     .setName(name.toString())
     .setCluster(cluster.toString())
     .setSnapshotId(snapshotId.toString())
     .setDescription(description)
     .build();
   Snapshot response = baseBigtableTableAdminClient.snapshotTableAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

snapshotTableOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.bigtable.admin.v2.SnapshotTableRequest,com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata> snapshotTableOperationCallable()

Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ClusterName cluster = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   SnapshotName snapshotId = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   String description = "";
   SnapshotTableRequest request = SnapshotTableRequest.newBuilder()
     .setName(name.toString())
     .setCluster(cluster.toString())
     .setSnapshotId(snapshotId.toString())
     .setDescription(description)
     .build();
   OperationFuture<Snapshot, SnapshotTableMetadata> future = baseBigtableTableAdminClient.snapshotTableOperationCallable().futureCall(request);
   // Do something
   Snapshot response = future.get();
 }

snapshotTableCallable

public final UnaryCallable<com.google.bigtable.admin.v2.SnapshotTableRequest,Operation> snapshotTableCallable()

Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ClusterName cluster = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   SnapshotName snapshotId = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   String description = "";
   SnapshotTableRequest request = SnapshotTableRequest.newBuilder()
     .setName(name.toString())
     .setCluster(cluster.toString())
     .setSnapshotId(snapshotId.toString())
     .setDescription(description)
     .build();
   ApiFuture<Operation> future = baseBigtableTableAdminClient.snapshotTableCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getSnapshot
```
public final com.google.bigtable.admin.v2.Snapshot getSnapshot(com.google.bigtable.admin.v2.SnapshotName name)
```
Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. 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.
Sample code:
```
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   Snapshot response = baseBigtableTableAdminClient.getSnapshot(name);
 }
 
```
Parameters:

name - The unique name of the requested snapshot. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.

Throws:

ApiException - if the remote call fails

getSnapshot
```
public final com.google.bigtable.admin.v2.Snapshot getSnapshot(String name)
```
Gets metadata information about the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. 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.
Sample code:
```
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   Snapshot response = baseBigtableTableAdminClient.getSnapshot(name.toString());
 }
 
```
Parameters:

name - The unique name of the requested snapshot. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.

Throws:

ApiException - if the remote call fails

getSnapshot

public final com.google.bigtable.admin.v2.Snapshot getSnapshot(com.google.bigtable.admin.v2.GetSnapshotRequest request)

Gets metadata information about the specified snapshot.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   GetSnapshotRequest request = GetSnapshotRequest.newBuilder()
     .setName(name.toString())
     .build();
   Snapshot response = baseBigtableTableAdminClient.getSnapshot(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getSnapshotCallable

public final UnaryCallable<com.google.bigtable.admin.v2.GetSnapshotRequest,com.google.bigtable.admin.v2.Snapshot> getSnapshotCallable()

Gets metadata information about the specified snapshot.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   GetSnapshotRequest request = GetSnapshotRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Snapshot> future = baseBigtableTableAdminClient.getSnapshotCallable().futureCall(request);
   // Do something
   Snapshot response = future.get();
 }

listSnapshots
```
public final BaseBigtableTableAdminClient.ListSnapshotsPagedResponse listSnapshots(com.google.bigtable.admin.v2.ClusterName parent)
```
Lists all snapshots associated with the specified cluster.
Note: This is a private alpha release of Cloud Bigtable snapshots. 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.
Sample code:
```
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   for (Snapshot element : baseBigtableTableAdminClient.listSnapshots(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

parent - The unique name of the cluster for which snapshots should be listed. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>`. Use `<cluster> = '-'` to list snapshots for all clusters in an instance, e.g., `projects/<project>/instances/<instance>/clusters/-`.

Throws:

ApiException - if the remote call fails

listSnapshots
```
public final BaseBigtableTableAdminClient.ListSnapshotsPagedResponse listSnapshots(String parent)
```
Lists all snapshots associated with the specified cluster.
Note: This is a private alpha release of Cloud Bigtable snapshots. 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.
Sample code:
```
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   for (Snapshot element : baseBigtableTableAdminClient.listSnapshots(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

parent - The unique name of the cluster for which snapshots should be listed. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>`. Use `<cluster> = '-'` to list snapshots for all clusters in an instance, e.g., `projects/<project>/instances/<instance>/clusters/-`.

Throws:

ApiException - if the remote call fails

listSnapshots

public final BaseBigtableTableAdminClient.ListSnapshotsPagedResponse listSnapshots(com.google.bigtable.admin.v2.ListSnapshotsRequest request)

Lists all snapshots associated with the specified cluster.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   ListSnapshotsRequest request = ListSnapshotsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Snapshot element : baseBigtableTableAdminClient.listSnapshots(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

listSnapshotsPagedCallable

public final UnaryCallable<com.google.bigtable.admin.v2.ListSnapshotsRequest,BaseBigtableTableAdminClient.ListSnapshotsPagedResponse> listSnapshotsPagedCallable()

Lists all snapshots associated with the specified cluster.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   ListSnapshotsRequest request = ListSnapshotsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListSnapshotsPagedResponse> future = baseBigtableTableAdminClient.listSnapshotsPagedCallable().futureCall(request);
   // Do something
   for (Snapshot element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listSnapshotsCallable

public final UnaryCallable<com.google.bigtable.admin.v2.ListSnapshotsRequest,com.google.bigtable.admin.v2.ListSnapshotsResponse> listSnapshotsCallable()

Lists all snapshots associated with the specified cluster.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   ListSnapshotsRequest request = ListSnapshotsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListSnapshotsResponse response = baseBigtableTableAdminClient.listSnapshotsCallable().call(request);
     for (Snapshot element : response.getSnapshotsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteSnapshot
```
public final void deleteSnapshot(com.google.bigtable.admin.v2.SnapshotName name)
```
Permanently deletes the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. 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.
Sample code:
```
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   baseBigtableTableAdminClient.deleteSnapshot(name);
 }
 
```
Parameters:

name - The unique name of the snapshot to be deleted. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.

Throws:

ApiException - if the remote call fails

deleteSnapshot
```
public final void deleteSnapshot(String name)
```
Permanently deletes the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. 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.
Sample code:
```
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   baseBigtableTableAdminClient.deleteSnapshot(name.toString());
 }
 
```
Parameters:

name - The unique name of the snapshot to be deleted. Values are of the form `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.

Throws:

ApiException - if the remote call fails

deleteSnapshot
```
public final void deleteSnapshot(com.google.bigtable.admin.v2.DeleteSnapshotRequest request)
```
Permanently deletes the specified snapshot.
Note: This is a private alpha release of Cloud Bigtable snapshots. 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.
Sample code:
```
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   DeleteSnapshotRequest request = DeleteSnapshotRequest.newBuilder()
     .setName(name.toString())
     .build();
   baseBigtableTableAdminClient.deleteSnapshot(request);
 }
 
```
Parameters:

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

Throws:

ApiException - if the remote call fails

deleteSnapshotCallable

public final UnaryCallable<com.google.bigtable.admin.v2.DeleteSnapshotRequest,Empty> deleteSnapshotCallable()

Permanently deletes the specified snapshot.

Sample code:


 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient = BaseBigtableTableAdminClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   DeleteSnapshotRequest request = DeleteSnapshotRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = baseBigtableTableAdminClient.deleteSnapshotCallable().futureCall(request);
   // Do something
   future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:: awaitTermination in interface BackgroundResource
Throws:: InterruptedException

Class BaseBigtableTableAdminClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseBigtableTableAdminClient

BaseBigtableTableAdminClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

createTable

createTable

createTable

createTableCallable

createTableFromSnapshotAsync

createTableFromSnapshotAsync

createTableFromSnapshotAsync

createTableFromSnapshotOperationCallable

createTableFromSnapshotCallable

listTables

listTables

listTables

listTablesPagedCallable

listTablesCallable

getTable

getTable

getTable

getTableCallable

deleteTable

deleteTable

deleteTable

deleteTableCallable

modifyColumnFamilies

modifyColumnFamilies

modifyColumnFamilies

modifyColumnFamiliesCallable

dropRowRange

dropRowRangeCallable

generateConsistencyToken

generateConsistencyToken

generateConsistencyToken

generateConsistencyTokenCallable

checkConsistency

checkConsistency

checkConsistency

checkConsistencyCallable

snapshotTableAsync

snapshotTableAsync

snapshotTableAsync

snapshotTableOperationCallable

snapshotTableCallable

getSnapshot

getSnapshot

getSnapshot

getSnapshotCallable

listSnapshots

listSnapshots

listSnapshots

listSnapshotsPagedCallable

listSnapshotsCallable

deleteSnapshot

deleteSnapshot

deleteSnapshot

deleteSnapshotCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination