Class BaseBigtableTableAdminClient (2.77.0)

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "tableId-1552905847";
   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().

Methods
Method	Description	Method Variants
CreateTable	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createTable(CreateTableRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createTable(InstanceName parent, String tableId, Table table) createTable(String parent, String tableId, Table table) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createTableCallable()
CreateTableFromSnapshot	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createTableFromSnapshotAsync(CreateTableFromSnapshotRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createTableFromSnapshotAsync(InstanceName parent, String tableId, SnapshotName sourceSnapshot) createTableFromSnapshotAsync(InstanceName parent, String tableId, String sourceSnapshot) createTableFromSnapshotAsync(String parent, String tableId, SnapshotName sourceSnapshot) createTableFromSnapshotAsync(String parent, String tableId, String sourceSnapshot) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createTableFromSnapshotOperationCallable() createTableFromSnapshotCallable()
ListTables	Lists all tables served from a specified instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listTables(ListTablesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listTables(InstanceName parent) listTables(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listTablesPagedCallable() listTablesCallable()
GetTable	Gets metadata information about the specified table.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getTable(GetTableRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getTable(TableName name) getTable(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getTableCallable()
UpdateTable	Updates a specified table.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateTableAsync(UpdateTableRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateTableAsync(Table table, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateTableOperationCallable() updateTableCallable()
DeleteTable	Permanently deletes a specified table and all of its data.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteTable(DeleteTableRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteTable(TableName name) deleteTable(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteTableCallable()
UndeleteTable	Restores a specified table which was accidentally deleted.	Request object method variants only take one parameter, a request object, which must be constructed before the call. undeleteTableAsync(UndeleteTableRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. undeleteTableAsync(TableName name) undeleteTableAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. undeleteTableOperationCallable() undeleteTableCallable()
CreateAuthorizedView	Creates a new AuthorizedView in a table.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createAuthorizedViewAsync(CreateAuthorizedViewRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createAuthorizedViewAsync(TableName parent, AuthorizedView authorizedView, String authorizedViewId) createAuthorizedViewAsync(String parent, AuthorizedView authorizedView, String authorizedViewId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createAuthorizedViewOperationCallable() createAuthorizedViewCallable()
ListAuthorizedViews	Lists all AuthorizedViews from a specific table.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAuthorizedViews(ListAuthorizedViewsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAuthorizedViews(TableName parent) listAuthorizedViews(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listAuthorizedViewsPagedCallable() listAuthorizedViewsCallable()
GetAuthorizedView	Gets information from a specified AuthorizedView.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getAuthorizedView(GetAuthorizedViewRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAuthorizedView(AuthorizedViewName name) getAuthorizedView(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getAuthorizedViewCallable()
UpdateAuthorizedView	Updates an AuthorizedView in a table.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAuthorizedViewAsync(UpdateAuthorizedViewRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateAuthorizedViewAsync(AuthorizedView authorizedView, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateAuthorizedViewOperationCallable() updateAuthorizedViewCallable()
DeleteAuthorizedView	Permanently deletes a specified AuthorizedView.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAuthorizedView(DeleteAuthorizedViewRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteAuthorizedView(AuthorizedViewName name) deleteAuthorizedView(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteAuthorizedViewCallable()
ModifyColumnFamilies	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. modifyColumnFamilies(ModifyColumnFamiliesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. modifyColumnFamilies(TableName name, List<ModifyColumnFamiliesRequest.Modification> modifications) modifyColumnFamilies(String name, List<ModifyColumnFamiliesRequest.Modification> modifications) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. modifyColumnFamiliesCallable()
DropRowRange	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. dropRowRange(DropRowRangeRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. dropRowRangeCallable()
GenerateConsistencyToken	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. generateConsistencyToken(GenerateConsistencyTokenRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. generateConsistencyToken(TableName name) generateConsistencyToken(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. generateConsistencyTokenCallable()
CheckConsistency	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. checkConsistency(CheckConsistencyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. checkConsistency(TableName name, String consistencyToken) checkConsistency(String name, String consistencyToken) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. checkConsistencyCallable()
SnapshotTable	Creates a new snapshot in the specified cluster from the specified source table. The cluster 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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. snapshotTableAsync(SnapshotTableRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. snapshotTableAsync(TableName name, ClusterName cluster, String snapshotId, String description) snapshotTableAsync(TableName name, String cluster, String snapshotId, String description) snapshotTableAsync(String name, ClusterName cluster, String snapshotId, String description) snapshotTableAsync(String name, String cluster, String snapshotId, String description) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. snapshotTableOperationCallable() snapshotTableCallable()
GetSnapshot	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getSnapshot(GetSnapshotRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getSnapshot(SnapshotName name) getSnapshot(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getSnapshotCallable()
ListSnapshots	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listSnapshots(ListSnapshotsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listSnapshots(ClusterName parent) listSnapshots(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listSnapshotsPagedCallable() listSnapshotsCallable()
DeleteSnapshot	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteSnapshot(DeleteSnapshotRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteSnapshot(SnapshotName name) deleteSnapshot(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteSnapshotCallable()
CreateBackup	Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createBackupAsync(CreateBackupRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createBackupAsync(ClusterName parent, String backupId, Backup backup) createBackupAsync(String parent, String backupId, Backup backup) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createBackupOperationCallable() createBackupCallable()
GetBackup	Gets metadata on a pending or completed Cloud Bigtable Backup.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getBackup(GetBackupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getBackup(BackupName name) getBackup(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getBackupCallable()
UpdateBackup	Updates a pending or completed Cloud Bigtable Backup.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateBackup(UpdateBackupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateBackup(Backup backup, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateBackupCallable()
DeleteBackup	Deletes a pending or completed Cloud Bigtable backup.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteBackup(DeleteBackupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteBackup(BackupName name) deleteBackup(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteBackupCallable()
ListBackups	Lists Cloud Bigtable backups. Returns both completed and pending backups.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listBackups(ListBackupsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listBackups(ClusterName parent) listBackups(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listBackupsPagedCallable() listBackupsCallable()
RestoreTable	Create a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.	Request object method variants only take one parameter, a request object, which must be constructed before the call. restoreTableAsync(RestoreTableRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. restoreTableOperationCallable() restoreTableCallable()
CopyBackup	Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. copyBackupAsync(CopyBackupRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. copyBackupAsync(ClusterName parent, String backupId, BackupName sourceBackup, Timestamp expireTime) copyBackupAsync(ClusterName parent, String backupId, String sourceBackup, Timestamp expireTime) copyBackupAsync(String parent, String backupId, BackupName sourceBackup, Timestamp expireTime) copyBackupAsync(String parent, String backupId, String sourceBackup, Timestamp expireTime) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. copyBackupOperationCallable() copyBackupCallable()
GetIamPolicy	Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIamPolicy(ResourceName resource) getIamPolicy(String resource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
SetIamPolicy	Sets the access control policy on a Bigtable resource. Replaces any existing policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. setIamPolicy(ResourceName resource, Policy policy) setIamPolicy(String resource, Policy policy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
TestIamPermissions	Returns permissions that the caller has on the specified Bigtable resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. testIamPermissions(ResourceName resource, List<String> permissions) testIamPermissions(String resource, List<String> permissions) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()
CreateSchemaBundle	Creates a new schema bundle in the specified table.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createSchemaBundleAsync(CreateSchemaBundleRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createSchemaBundleAsync(TableName parent, String schemaBundleId, SchemaBundle schemaBundle) createSchemaBundleAsync(String parent, String schemaBundleId, SchemaBundle schemaBundle) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createSchemaBundleOperationCallable() createSchemaBundleCallable()
UpdateSchemaBundle	Updates a schema bundle in the specified table.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateSchemaBundleAsync(UpdateSchemaBundleRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateSchemaBundleAsync(SchemaBundle schemaBundle, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateSchemaBundleOperationCallable() updateSchemaBundleCallable()
GetSchemaBundle	Gets metadata information about the specified schema bundle.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getSchemaBundle(GetSchemaBundleRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getSchemaBundle(SchemaBundleName name) getSchemaBundle(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getSchemaBundleCallable()
ListSchemaBundles	Lists all schema bundles associated with the specified table.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listSchemaBundles(ListSchemaBundlesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listSchemaBundles(TableName parent) listSchemaBundles(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listSchemaBundlesPagedCallable() listSchemaBundlesCallable()
DeleteSchemaBundle	Deletes a schema bundle in the specified table.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteSchemaBundle(DeleteSchemaBundleRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteSchemaBundle(SchemaBundleName name) deleteSchemaBundle(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteSchemaBundleCallable()

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BaseBigtableTableAdminSettings baseBigtableTableAdminSettings =
     BaseBigtableTableAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create(baseBigtableTableAdminSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BaseBigtableTableAdminSettings baseBigtableTableAdminSettings =
     BaseBigtableTableAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create(baseBigtableTableAdminSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > BaseBigtableTableAdminClient

Static Methods

create()

public static final BaseBigtableTableAdminClient create()

Constructs an instance of BaseBigtableTableAdminClient with default settings.

Returns
Type	Description
`BaseBigtableTableAdminClient`

Exceptions
Type	Description
`IOException`

create(BaseBigtableTableAdminSettings settings)

public static final BaseBigtableTableAdminClient create(BaseBigtableTableAdminSettings settings)

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.

Parameter
Name	Description
`settings`	`BaseBigtableTableAdminSettings`

Returns
Type	Description
`BaseBigtableTableAdminClient`

Exceptions
Type	Description
`IOException`

create(BigtableTableAdminStub stub)

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 using create(BaseBigtableTableAdminSettings).

Parameter
Name	Description
`stub`	`BigtableTableAdminStub`

Returns
Type	Description
`BaseBigtableTableAdminClient`

Constructors

BaseBigtableTableAdminClient(BaseBigtableTableAdminSettings settings)

protected BaseBigtableTableAdminClient(BaseBigtableTableAdminSettings settings)

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.

Parameter
Name	Description
`settings`	`BaseBigtableTableAdminSettings`

BaseBigtableTableAdminClient(BigtableTableAdminStub stub)

protected BaseBigtableTableAdminClient(BigtableTableAdminStub stub)

Parameter
Name	Description
`stub`	`BigtableTableAdminStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

checkConsistency(CheckConsistencyRequest request)

public final CheckConsistencyResponse checkConsistency(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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CheckConsistencyRequest request =
       CheckConsistencyRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setConsistencyToken("consistencyToken-1985152319")
           .build();
   CheckConsistencyResponse response = baseBigtableTableAdminClient.checkConsistency(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.CheckConsistencyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.bigtable.admin.v2.CheckConsistencyResponse`

checkConsistency(TableName name, String consistencyToken)

public final CheckConsistencyResponse checkConsistency(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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   String consistencyToken = "consistencyToken-1985152319";
   CheckConsistencyResponse response =
       baseBigtableTableAdminClient.checkConsistency(name, consistencyToken);
 }

Parameters
Name	Description
`name`	`com.google.bigtable.admin.v2.TableName` Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`consistencyToken`	`String` Required. The token created using GenerateConsistencyToken for the Table.

Returns
Type	Description
`com.google.bigtable.admin.v2.CheckConsistencyResponse`

checkConsistency(String name, String consistencyToken)

public final 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   String consistencyToken = "consistencyToken-1985152319";
   CheckConsistencyResponse response =
       baseBigtableTableAdminClient.checkConsistency(name, consistencyToken);
 }

Parameters
Name	Description
`name`	`String` Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`consistencyToken`	`String` Required. The token created using GenerateConsistencyToken for the Table.

Returns
Type	Description
`com.google.bigtable.admin.v2.CheckConsistencyResponse`

checkConsistencyCallable()

public final UnaryCallable<CheckConsistencyRequest,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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CheckConsistencyRequest request =
       CheckConsistencyRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setConsistencyToken("consistencyToken-1985152319")
           .build();
   ApiFuture<CheckConsistencyResponse> future =
       baseBigtableTableAdminClient.checkConsistencyCallable().futureCall(request);
   // Do something.
   CheckConsistencyResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.CheckConsistencyRequest,com.google.bigtable.admin.v2.CheckConsistencyResponse>`

close()

public final void close()

copyBackupAsync(ClusterName parent, String backupId, BackupName sourceBackup, Timestamp expireTime)

public final OperationFuture<Backup,CopyBackupMetadata> copyBackupAsync(ClusterName parent, String backupId, BackupName sourceBackup, Timestamp expireTime)

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   String backupId = "backupId2121930365";
   BackupName sourceBackup = BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
   Timestamp expireTime = Timestamp.newBuilder().build();
   Backup response =
       baseBigtableTableAdminClient
           .copyBackupAsync(parent, backupId, sourceBackup, expireTime)
           .get();
 }

Parameters
Name	Description
`parent`	`com.google.bigtable.admin.v2.ClusterName` Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`.
`backupId`	`String` Required. The id of the new backup. The `backup_id` along with `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
`sourceBackup`	`com.google.bigtable.admin.v2.BackupName` Required. The source backup to be copied from. The source backup needs to be in READY state for it to be copied. Copying a copied backup is not allowed. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
`expireTime`	`Timestamp` Required. Required. The expiration time of the copied backup with microsecond granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CopyBackupMetadata>`

copyBackupAsync(ClusterName parent, String backupId, String sourceBackup, Timestamp expireTime)

public final OperationFuture<Backup,CopyBackupMetadata> copyBackupAsync(ClusterName parent, String backupId, String sourceBackup, Timestamp expireTime)

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   String backupId = "backupId2121930365";
   String sourceBackup =
       BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString();
   Timestamp expireTime = Timestamp.newBuilder().build();
   Backup response =
       baseBigtableTableAdminClient
           .copyBackupAsync(parent, backupId, sourceBackup, expireTime)
           .get();
 }

Parameters
Name	Description
`parent`	`com.google.bigtable.admin.v2.ClusterName` Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`.
`backupId`	`String` Required. The id of the new backup. The `backup_id` along with `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
`sourceBackup`	`String` Required. The source backup to be copied from. The source backup needs to be in READY state for it to be copied. Copying a copied backup is not allowed. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
`expireTime`	`Timestamp` Required. Required. The expiration time of the copied backup with microsecond granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CopyBackupMetadata>`

copyBackupAsync(CopyBackupRequest request)

public final OperationFuture<Backup,CopyBackupMetadata> copyBackupAsync(CopyBackupRequest request)

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CopyBackupRequest request =
       CopyBackupRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setBackupId("backupId2121930365")
           .setSourceBackup(
               BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString())
           .setExpireTime(Timestamp.newBuilder().build())
           .build();
   Backup response = baseBigtableTableAdminClient.copyBackupAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.CopyBackupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CopyBackupMetadata>`

copyBackupAsync(String parent, String backupId, BackupName sourceBackup, Timestamp expireTime)

public final OperationFuture<Backup,CopyBackupMetadata> copyBackupAsync(String parent, String backupId, BackupName sourceBackup, Timestamp expireTime)

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
   String backupId = "backupId2121930365";
   BackupName sourceBackup = BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
   Timestamp expireTime = Timestamp.newBuilder().build();
   Backup response =
       baseBigtableTableAdminClient
           .copyBackupAsync(parent, backupId, sourceBackup, expireTime)
           .get();
 }

Parameters
Name	Description
`parent`	`String` Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`.
`backupId`	`String` Required. The id of the new backup. The `backup_id` along with `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
`sourceBackup`	`com.google.bigtable.admin.v2.BackupName` Required. The source backup to be copied from. The source backup needs to be in READY state for it to be copied. Copying a copied backup is not allowed. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
`expireTime`	`Timestamp` Required. Required. The expiration time of the copied backup with microsecond granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CopyBackupMetadata>`

copyBackupAsync(String parent, String backupId, String sourceBackup, Timestamp expireTime)

public final OperationFuture<Backup,CopyBackupMetadata> copyBackupAsync(String parent, String backupId, String sourceBackup, Timestamp expireTime)

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
   String backupId = "backupId2121930365";
   String sourceBackup =
       BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString();
   Timestamp expireTime = Timestamp.newBuilder().build();
   Backup response =
       baseBigtableTableAdminClient
           .copyBackupAsync(parent, backupId, sourceBackup, expireTime)
           .get();
 }

Parameters
Name	Description
`parent`	`String` Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`.
`backupId`	`String` Required. The id of the new backup. The `backup_id` along with `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
`sourceBackup`	`String` Required. The source backup to be copied from. The source backup needs to be in READY state for it to be copied. Copying a copied backup is not allowed. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
`expireTime`	`Timestamp` Required. Required. The expiration time of the copied backup with microsecond granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CopyBackupMetadata>`

copyBackupCallable()

public final UnaryCallable<CopyBackupRequest,Operation> copyBackupCallable()

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CopyBackupRequest request =
       CopyBackupRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setBackupId("backupId2121930365")
           .setSourceBackup(
               BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString())
           .setExpireTime(Timestamp.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.copyBackupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.CopyBackupRequest,Operation>`

copyBackupOperationCallable()

public final OperationCallable<CopyBackupRequest,Backup,CopyBackupMetadata> copyBackupOperationCallable()

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CopyBackupRequest request =
       CopyBackupRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setBackupId("backupId2121930365")
           .setSourceBackup(
               BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString())
           .setExpireTime(Timestamp.newBuilder().build())
           .build();
   OperationFuture<Backup, CopyBackupMetadata> future =
       baseBigtableTableAdminClient.copyBackupOperationCallable().futureCall(request);
   // Do something.
   Backup response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.CopyBackupRequest,com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CopyBackupMetadata>`

createAuthorizedViewAsync(CreateAuthorizedViewRequest request)

public final OperationFuture<AuthorizedView,CreateAuthorizedViewMetadata> createAuthorizedViewAsync(CreateAuthorizedViewRequest request)

Creates a new AuthorizedView in a table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateAuthorizedViewRequest request =
       CreateAuthorizedViewRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setAuthorizedViewId("authorizedViewId-2074136549")
           .setAuthorizedView(AuthorizedView.newBuilder().build())
           .build();
   AuthorizedView response =
       baseBigtableTableAdminClient.createAuthorizedViewAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.CreateAuthorizedViewRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.AuthorizedView,com.google.bigtable.admin.v2.CreateAuthorizedViewMetadata>`

createAuthorizedViewAsync(TableName parent, AuthorizedView authorizedView, String authorizedViewId)

public final OperationFuture<AuthorizedView,CreateAuthorizedViewMetadata> createAuthorizedViewAsync(TableName parent, AuthorizedView authorizedView, String authorizedViewId)

Creates a new AuthorizedView in a table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName parent = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   AuthorizedView authorizedView = AuthorizedView.newBuilder().build();
   String authorizedViewId = "authorizedViewId-2074136549";
   AuthorizedView response =
       baseBigtableTableAdminClient
           .createAuthorizedViewAsync(parent, authorizedView, authorizedViewId)
           .get();
 }

Parameters
Name	Description
`parent`	`com.google.bigtable.admin.v2.TableName` Required. This is the name of the table the AuthorizedView belongs to. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`authorizedView`	`com.google.bigtable.admin.v2.AuthorizedView` Required. The AuthorizedView to create.
`authorizedViewId`	`String` Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The `authorized_view_id` appended to `parent` forms the full AuthorizedView name of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view}`.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.AuthorizedView,com.google.bigtable.admin.v2.CreateAuthorizedViewMetadata>`

createAuthorizedViewAsync(String parent, AuthorizedView authorizedView, String authorizedViewId)

public final OperationFuture<AuthorizedView,CreateAuthorizedViewMetadata> createAuthorizedViewAsync(String parent, AuthorizedView authorizedView, String authorizedViewId)

Creates a new AuthorizedView in a table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   AuthorizedView authorizedView = AuthorizedView.newBuilder().build();
   String authorizedViewId = "authorizedViewId-2074136549";
   AuthorizedView response =
       baseBigtableTableAdminClient
           .createAuthorizedViewAsync(parent, authorizedView, authorizedViewId)
           .get();
 }

Parameters
Name	Description
`parent`	`String` Required. This is the name of the table the AuthorizedView belongs to. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`authorizedView`	`com.google.bigtable.admin.v2.AuthorizedView` Required. The AuthorizedView to create.
`authorizedViewId`	`String` Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The `authorized_view_id` appended to `parent` forms the full AuthorizedView name of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view}`.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.AuthorizedView,com.google.bigtable.admin.v2.CreateAuthorizedViewMetadata>`

createAuthorizedViewCallable()

public final UnaryCallable<CreateAuthorizedViewRequest,Operation> createAuthorizedViewCallable()

Creates a new AuthorizedView in a table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateAuthorizedViewRequest request =
       CreateAuthorizedViewRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setAuthorizedViewId("authorizedViewId-2074136549")
           .setAuthorizedView(AuthorizedView.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.createAuthorizedViewCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.CreateAuthorizedViewRequest,Operation>`

createAuthorizedViewOperationCallable()

public final OperationCallable<CreateAuthorizedViewRequest,AuthorizedView,CreateAuthorizedViewMetadata> createAuthorizedViewOperationCallable()

Creates a new AuthorizedView in a table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateAuthorizedViewRequest request =
       CreateAuthorizedViewRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setAuthorizedViewId("authorizedViewId-2074136549")
           .setAuthorizedView(AuthorizedView.newBuilder().build())
           .build();
   OperationFuture<AuthorizedView, CreateAuthorizedViewMetadata> future =
       baseBigtableTableAdminClient.createAuthorizedViewOperationCallable().futureCall(request);
   // Do something.
   AuthorizedView response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.CreateAuthorizedViewRequest,com.google.bigtable.admin.v2.AuthorizedView,com.google.bigtable.admin.v2.CreateAuthorizedViewMetadata>`

createBackupAsync(ClusterName parent, String backupId, Backup backup)

public final OperationFuture<Backup,CreateBackupMetadata> createBackupAsync(ClusterName parent, String backupId, Backup backup)

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   String backupId = "backupId2121930365";
   Backup backup = Backup.newBuilder().build();
   Backup response =
       baseBigtableTableAdminClient.createBackupAsync(parent, backupId, backup).get();
 }

Parameters
Name	Description
`parent`	`com.google.bigtable.admin.v2.ClusterName` Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
`backupId`	`String` Required. The id of the backup to be created. The `backup_id` along with the parent `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
`backup`	`com.google.bigtable.admin.v2.Backup` Required. The backup to create.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CreateBackupMetadata>`

createBackupAsync(CreateBackupRequest request)

public final OperationFuture<Backup,CreateBackupMetadata> createBackupAsync(CreateBackupRequest request)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateBackupRequest request =
       CreateBackupRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setBackupId("backupId2121930365")
           .setBackup(Backup.newBuilder().build())
           .build();
   Backup response = baseBigtableTableAdminClient.createBackupAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.CreateBackupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CreateBackupMetadata>`

createBackupAsync(String parent, String backupId, Backup backup)

public final OperationFuture<Backup,CreateBackupMetadata> createBackupAsync(String parent, String backupId, Backup backup)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
   String backupId = "backupId2121930365";
   Backup backup = Backup.newBuilder().build();
   Backup response =
       baseBigtableTableAdminClient.createBackupAsync(parent, backupId, backup).get();
 }

Parameters
Name	Description
`parent`	`String` Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
`backupId`	`String` Required. The id of the backup to be created. The `backup_id` along with the parent `parent` are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
`backup`	`com.google.bigtable.admin.v2.Backup` Required. The backup to create.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CreateBackupMetadata>`

createBackupCallable()

public final UnaryCallable<CreateBackupRequest,Operation> createBackupCallable()

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateBackupRequest request =
       CreateBackupRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setBackupId("backupId2121930365")
           .setBackup(Backup.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.createBackupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.CreateBackupRequest,Operation>`

createBackupOperationCallable()

public final OperationCallable<CreateBackupRequest,Backup,CreateBackupMetadata> createBackupOperationCallable()

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateBackupRequest request =
       CreateBackupRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setBackupId("backupId2121930365")
           .setBackup(Backup.newBuilder().build())
           .build();
   OperationFuture<Backup, CreateBackupMetadata> future =
       baseBigtableTableAdminClient.createBackupOperationCallable().futureCall(request);
   // Do something.
   Backup response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.CreateBackupRequest,com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CreateBackupMetadata>`

createSchemaBundleAsync(CreateSchemaBundleRequest request)

public final OperationFuture<SchemaBundle,CreateSchemaBundleMetadata> createSchemaBundleAsync(CreateSchemaBundleRequest request)

Creates a new schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateSchemaBundleRequest request =
       CreateSchemaBundleRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setSchemaBundleId("schemaBundleId2039843326")
           .setSchemaBundle(SchemaBundle.newBuilder().build())
           .build();
   SchemaBundle response = baseBigtableTableAdminClient.createSchemaBundleAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.CreateSchemaBundleRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.SchemaBundle,com.google.bigtable.admin.v2.CreateSchemaBundleMetadata>`

createSchemaBundleAsync(TableName parent, String schemaBundleId, SchemaBundle schemaBundle)

public final OperationFuture<SchemaBundle,CreateSchemaBundleMetadata> createSchemaBundleAsync(TableName parent, String schemaBundleId, SchemaBundle schemaBundle)

Creates a new schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName parent = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   String schemaBundleId = "schemaBundleId2039843326";
   SchemaBundle schemaBundle = SchemaBundle.newBuilder().build();
   SchemaBundle response =
       baseBigtableTableAdminClient
           .createSchemaBundleAsync(parent, schemaBundleId, schemaBundle)
           .get();
 }

Parameters
Name	Description
`parent`	`com.google.bigtable.admin.v2.TableName` Required. The parent resource where this schema bundle will be created. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`schemaBundleId`	`String` Required. The unique ID to use for the schema bundle, which will become the final component of the schema bundle's resource name.
`schemaBundle`	`com.google.bigtable.admin.v2.SchemaBundle` Required. The schema bundle to create.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.SchemaBundle,com.google.bigtable.admin.v2.CreateSchemaBundleMetadata>`

createSchemaBundleAsync(String parent, String schemaBundleId, SchemaBundle schemaBundle)

public final OperationFuture<SchemaBundle,CreateSchemaBundleMetadata> createSchemaBundleAsync(String parent, String schemaBundleId, SchemaBundle schemaBundle)

Creates a new schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   String schemaBundleId = "schemaBundleId2039843326";
   SchemaBundle schemaBundle = SchemaBundle.newBuilder().build();
   SchemaBundle response =
       baseBigtableTableAdminClient
           .createSchemaBundleAsync(parent, schemaBundleId, schemaBundle)
           .get();
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where this schema bundle will be created. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`schemaBundleId`	`String` Required. The unique ID to use for the schema bundle, which will become the final component of the schema bundle's resource name.
`schemaBundle`	`com.google.bigtable.admin.v2.SchemaBundle` Required. The schema bundle to create.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.SchemaBundle,com.google.bigtable.admin.v2.CreateSchemaBundleMetadata>`

createSchemaBundleCallable()

public final UnaryCallable<CreateSchemaBundleRequest,Operation> createSchemaBundleCallable()

Creates a new schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateSchemaBundleRequest request =
       CreateSchemaBundleRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setSchemaBundleId("schemaBundleId2039843326")
           .setSchemaBundle(SchemaBundle.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.createSchemaBundleCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.CreateSchemaBundleRequest,Operation>`

createSchemaBundleOperationCallable()

public final OperationCallable<CreateSchemaBundleRequest,SchemaBundle,CreateSchemaBundleMetadata> createSchemaBundleOperationCallable()

Creates a new schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateSchemaBundleRequest request =
       CreateSchemaBundleRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setSchemaBundleId("schemaBundleId2039843326")
           .setSchemaBundle(SchemaBundle.newBuilder().build())
           .build();
   OperationFuture<SchemaBundle, CreateSchemaBundleMetadata> future =
       baseBigtableTableAdminClient.createSchemaBundleOperationCallable().futureCall(request);
   // Do something.
   SchemaBundle response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.CreateSchemaBundleRequest,com.google.bigtable.admin.v2.SchemaBundle,com.google.bigtable.admin.v2.CreateSchemaBundleMetadata>`

createTable(CreateTableRequest request)

public final Table createTable(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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateTableRequest request =
       CreateTableRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setTableId("tableId-1552905847")
           .setTable(Table.newBuilder().build())
           .addAllInitialSplits(new ArrayList<CreateTableRequest.Split>())
           .build();
   Table response = baseBigtableTableAdminClient.createTable(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.CreateTableRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.bigtable.admin.v2.Table`

createTable(InstanceName parent, String tableId, Table table)

public final Table createTable(InstanceName parent, String tableId, 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "tableId-1552905847";
   Table table = Table.newBuilder().build();
   Table response = baseBigtableTableAdminClient.createTable(parent, tableId, table);
 }

Parameters
Name	Description
`parent`	`com.google.bigtable.admin.v2.InstanceName` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
`tableId`	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`. Maximum 50 characters.
`table`	`com.google.bigtable.admin.v2.Table` Required. The Table to create.

Returns
Type	Description
`com.google.bigtable.admin.v2.Table`

createTable(String parent, String tableId, Table table)

public final Table createTable(String parent, String tableId, 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   String tableId = "tableId-1552905847";
   Table table = Table.newBuilder().build();
   Table response = baseBigtableTableAdminClient.createTable(parent, tableId, table);
 }

Parameters
Name	Description
`parent`	`String` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
`tableId`	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`. Maximum 50 characters.
`table`	`com.google.bigtable.admin.v2.Table` Required. The Table to create.

Returns
Type	Description
`com.google.bigtable.admin.v2.Table`

createTableCallable()

public final UnaryCallable<CreateTableRequest,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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateTableRequest request =
       CreateTableRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setTableId("tableId-1552905847")
           .setTable(Table.newBuilder().build())
           .addAllInitialSplits(new ArrayList<CreateTableRequest.Split>())
           .build();
   ApiFuture<Table> future =
       baseBigtableTableAdminClient.createTableCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.CreateTableRequest,com.google.bigtable.admin.v2.Table>`

createTableFromSnapshotAsync(CreateTableFromSnapshotRequest request)

public final OperationFuture<Table,CreateTableFromSnapshotMetadata> createTableFromSnapshotAsync(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.

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateTableFromSnapshotRequest request =
       CreateTableFromSnapshotRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setTableId("tableId-1552905847")
           .setSourceSnapshot(
               SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString())
           .build();
   Table response = baseBigtableTableAdminClient.createTableFromSnapshotAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>`

createTableFromSnapshotAsync(InstanceName parent, String tableId, SnapshotName sourceSnapshot)

public final OperationFuture<Table,CreateTableFromSnapshotMetadata> createTableFromSnapshotAsync(InstanceName parent, String tableId, 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "tableId-1552905847";
   SnapshotName sourceSnapshot =
       SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   Table response =
       baseBigtableTableAdminClient
           .createTableFromSnapshotAsync(parent, tableId, sourceSnapshot)
           .get();
 }

Parameters
Name	Description
`parent`	`com.google.bigtable.admin.v2.InstanceName` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
`tableId`	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
`sourceSnapshot`	`com.google.bigtable.admin.v2.SnapshotName` Required. 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}`.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>`

createTableFromSnapshotAsync(InstanceName parent, String tableId, String sourceSnapshot)

public final OperationFuture<Table,CreateTableFromSnapshotMetadata> createTableFromSnapshotAsync(InstanceName 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String tableId = "tableId-1552905847";
   String sourceSnapshot =
       SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString();
   Table response =
       baseBigtableTableAdminClient
           .createTableFromSnapshotAsync(parent, tableId, sourceSnapshot)
           .get();
 }

Parameters
Name	Description
`parent`	`com.google.bigtable.admin.v2.InstanceName` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
`tableId`	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
`sourceSnapshot`	`String` Required. 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}`.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>`

createTableFromSnapshotAsync(String parent, String tableId, SnapshotName sourceSnapshot)

public final OperationFuture<Table,CreateTableFromSnapshotMetadata> createTableFromSnapshotAsync(String parent, String tableId, 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   String tableId = "tableId-1552905847";
   SnapshotName sourceSnapshot =
       SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   Table response =
       baseBigtableTableAdminClient
           .createTableFromSnapshotAsync(parent, tableId, sourceSnapshot)
           .get();
 }

Parameters
Name	Description
`parent`	`String` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
`tableId`	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
`sourceSnapshot`	`com.google.bigtable.admin.v2.SnapshotName` Required. 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}`.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>`

createTableFromSnapshotAsync(String parent, String tableId, String sourceSnapshot)

public final OperationFuture<Table,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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   String tableId = "tableId-1552905847";
   String sourceSnapshot =
       SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString();
   Table response =
       baseBigtableTableAdminClient
           .createTableFromSnapshotAsync(parent, tableId, sourceSnapshot)
           .get();
 }

Parameters
Name	Description
`parent`	`String` Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.
`tableId`	`String` Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
`sourceSnapshot`	`String` Required. 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}`.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>`

createTableFromSnapshotCallable()

public final UnaryCallable<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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateTableFromSnapshotRequest request =
       CreateTableFromSnapshotRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setTableId("tableId-1552905847")
           .setSourceSnapshot(
               SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString())
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.createTableFromSnapshotCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest,Operation>`

createTableFromSnapshotOperationCallable()

public final OperationCallable<CreateTableFromSnapshotRequest,Table,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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   CreateTableFromSnapshotRequest request =
       CreateTableFromSnapshotRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setTableId("tableId-1552905847")
           .setSourceSnapshot(
               SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString())
           .build();
   OperationFuture<Table, CreateTableFromSnapshotMetadata> future =
       baseBigtableTableAdminClient
           .createTableFromSnapshotOperationCallable()
           .futureCall(request);
   // Do something.
   Table response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest,com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>`

deleteAuthorizedView(AuthorizedViewName name)

public final void deleteAuthorizedView(AuthorizedViewName name)

Permanently deletes a specified AuthorizedView.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   AuthorizedViewName name =
       AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
   baseBigtableTableAdminClient.deleteAuthorizedView(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.AuthorizedViewName` Required. The unique name of the AuthorizedView to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.

deleteAuthorizedView(DeleteAuthorizedViewRequest request)

public final void deleteAuthorizedView(DeleteAuthorizedViewRequest request)

Permanently deletes a specified AuthorizedView.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DeleteAuthorizedViewRequest request =
       DeleteAuthorizedViewRequest.newBuilder()
           .setName(
               AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   baseBigtableTableAdminClient.deleteAuthorizedView(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.DeleteAuthorizedViewRequest` The request object containing all of the parameters for the API call.

deleteAuthorizedView(String name)

public final void deleteAuthorizedView(String name)

Permanently deletes a specified AuthorizedView.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name =
       AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
           .toString();
   baseBigtableTableAdminClient.deleteAuthorizedView(name);
 }

Parameter
Name	Description
`name`	`String` Required. The unique name of the AuthorizedView to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.

deleteAuthorizedViewCallable()

public final UnaryCallable<DeleteAuthorizedViewRequest,Empty> deleteAuthorizedViewCallable()

Permanently deletes a specified AuthorizedView.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DeleteAuthorizedViewRequest request =
       DeleteAuthorizedViewRequest.newBuilder()
           .setName(
               AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       baseBigtableTableAdminClient.deleteAuthorizedViewCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.DeleteAuthorizedViewRequest,Empty>`

deleteBackup(BackupName name)

public final void deleteBackup(BackupName name)

Deletes a pending or completed Cloud Bigtable backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   BackupName name = BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
   baseBigtableTableAdminClient.deleteBackup(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.BackupName` Required. Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.

deleteBackup(DeleteBackupRequest request)

public final void deleteBackup(DeleteBackupRequest request)

Deletes a pending or completed Cloud Bigtable backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DeleteBackupRequest request =
       DeleteBackupRequest.newBuilder()
           .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString())
           .build();
   baseBigtableTableAdminClient.deleteBackup(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.DeleteBackupRequest` The request object containing all of the parameters for the API call.

deleteBackup(String name)

public final void deleteBackup(String name)

Deletes a pending or completed Cloud Bigtable backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name = BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString();
   baseBigtableTableAdminClient.deleteBackup(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.

deleteBackupCallable()

public final UnaryCallable<DeleteBackupRequest,Empty> deleteBackupCallable()

Deletes a pending or completed Cloud Bigtable backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DeleteBackupRequest request =
       DeleteBackupRequest.newBuilder()
           .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString())
           .build();
   ApiFuture<Empty> future =
       baseBigtableTableAdminClient.deleteBackupCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.DeleteBackupRequest,Empty>`

deleteSchemaBundle(DeleteSchemaBundleRequest request)

public final void deleteSchemaBundle(DeleteSchemaBundleRequest request)

Deletes a schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DeleteSchemaBundleRequest request =
       DeleteSchemaBundleRequest.newBuilder()
           .setName(
               SchemaBundleName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[SCHEMA_BUNDLE]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   baseBigtableTableAdminClient.deleteSchemaBundle(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.DeleteSchemaBundleRequest` The request object containing all of the parameters for the API call.

deleteSchemaBundle(SchemaBundleName name)

public final void deleteSchemaBundle(SchemaBundleName name)

Deletes a schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   SchemaBundleName name =
       SchemaBundleName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[SCHEMA_BUNDLE]");
   baseBigtableTableAdminClient.deleteSchemaBundle(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.SchemaBundleName` Required. The unique name of the schema bundle to delete. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`

deleteSchemaBundle(String name)

public final void deleteSchemaBundle(String name)

Deletes a schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name =
       SchemaBundleName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[SCHEMA_BUNDLE]").toString();
   baseBigtableTableAdminClient.deleteSchemaBundle(name);
 }

Parameter
Name	Description
`name`	`String` Required. The unique name of the schema bundle to delete. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`

deleteSchemaBundleCallable()

public final UnaryCallable<DeleteSchemaBundleRequest,Empty> deleteSchemaBundleCallable()

Deletes a schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DeleteSchemaBundleRequest request =
       DeleteSchemaBundleRequest.newBuilder()
           .setName(
               SchemaBundleName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[SCHEMA_BUNDLE]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       baseBigtableTableAdminClient.deleteSchemaBundleCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.DeleteSchemaBundleRequest,Empty>`

deleteSnapshot(DeleteSnapshotRequest request)

public final void deleteSnapshot(DeleteSnapshotRequest request)

Permanently deletes the specified snapshot.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DeleteSnapshotRequest request =
       DeleteSnapshotRequest.newBuilder()
           .setName(
               SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString())
           .build();
   baseBigtableTableAdminClient.deleteSnapshot(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.DeleteSnapshotRequest` The request object containing all of the parameters for the API call.

deleteSnapshot(SnapshotName name)

public final void deleteSnapshot(SnapshotName name)

Permanently deletes the specified snapshot.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   baseBigtableTableAdminClient.deleteSnapshot(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.SnapshotName` Required. The unique name of the snapshot to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.

deleteSnapshot(String name)

public final void deleteSnapshot(String name)

Permanently deletes the specified snapshot.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name =
       SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString();
   baseBigtableTableAdminClient.deleteSnapshot(name);
 }

Parameter
Name	Description
`name`	`String` Required. The unique name of the snapshot to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.

deleteSnapshotCallable()

public final UnaryCallable<DeleteSnapshotRequest,Empty> deleteSnapshotCallable()

Permanently deletes the specified snapshot.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DeleteSnapshotRequest request =
       DeleteSnapshotRequest.newBuilder()
           .setName(
               SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString())
           .build();
   ApiFuture<Empty> future =
       baseBigtableTableAdminClient.deleteSnapshotCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.DeleteSnapshotRequest,Empty>`

deleteTable(DeleteTableRequest request)

public final void deleteTable(DeleteTableRequest request)

Permanently deletes a specified table and all of its data.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DeleteTableRequest request =
       DeleteTableRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   baseBigtableTableAdminClient.deleteTable(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.DeleteTableRequest` The request object containing all of the parameters for the API call.

deleteTable(TableName name)

public final void deleteTable(TableName name)

Permanently deletes a specified table and all of its data.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   baseBigtableTableAdminClient.deleteTable(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.TableName` Required. The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

deleteTable(String name)

public final void deleteTable(String name)

Permanently deletes a specified table and all of its data.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   baseBigtableTableAdminClient.deleteTable(name);
 }

Parameter
Name	Description
`name`	`String` Required. The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

deleteTableCallable()

public final UnaryCallable<DeleteTableRequest,Empty> deleteTableCallable()

Permanently deletes a specified table and all of its data.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DeleteTableRequest request =
       DeleteTableRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   ApiFuture<Empty> future =
       baseBigtableTableAdminClient.deleteTableCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.DeleteTableRequest,Empty>`

dropRowRange(DropRowRangeRequest request)

public final void dropRowRange(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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DropRowRangeRequest request =
       DropRowRangeRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   baseBigtableTableAdminClient.dropRowRange(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.DropRowRangeRequest` The request object containing all of the parameters for the API call.

dropRowRangeCallable()

public final UnaryCallable<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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   DropRowRangeRequest request =
       DropRowRangeRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   ApiFuture<Empty> future =
       baseBigtableTableAdminClient.dropRowRangeCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.DropRowRangeRequest,Empty>`

generateConsistencyToken(GenerateConsistencyTokenRequest request)

public final GenerateConsistencyTokenResponse generateConsistencyToken(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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GenerateConsistencyTokenRequest request =
       GenerateConsistencyTokenRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   GenerateConsistencyTokenResponse response =
       baseBigtableTableAdminClient.generateConsistencyToken(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.GenerateConsistencyTokenRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse`

generateConsistencyToken(TableName name)

public final GenerateConsistencyTokenResponse generateConsistencyToken(TableName name)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   GenerateConsistencyTokenResponse response =
       baseBigtableTableAdminClient.generateConsistencyToken(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.TableName` Required. The unique name of the Table for which to create a consistency token. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

Returns
Type	Description
`com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse`

generateConsistencyToken(String name)

public final GenerateConsistencyTokenResponse generateConsistencyToken(String name)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   GenerateConsistencyTokenResponse response =
       baseBigtableTableAdminClient.generateConsistencyToken(name);
 }

Parameter
Name	Description
`name`	`String` Required. The unique name of the Table for which to create a consistency token. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

Returns
Type	Description
`com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse`

generateConsistencyTokenCallable()

public final UnaryCallable<GenerateConsistencyTokenRequest,GenerateConsistencyTokenResponse> generateConsistencyTokenCallable()

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GenerateConsistencyTokenRequest request =
       GenerateConsistencyTokenRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   ApiFuture<GenerateConsistencyTokenResponse> future =
       baseBigtableTableAdminClient.generateConsistencyTokenCallable().futureCall(request);
   // Do something.
   GenerateConsistencyTokenResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.GenerateConsistencyTokenRequest,com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse>`

getAuthorizedView(AuthorizedViewName name)

public final AuthorizedView getAuthorizedView(AuthorizedViewName name)

Gets information from a specified AuthorizedView.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   AuthorizedViewName name =
       AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
   AuthorizedView response = baseBigtableTableAdminClient.getAuthorizedView(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.AuthorizedViewName` Required. The unique name of the requested AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.

Returns
Type	Description
`com.google.bigtable.admin.v2.AuthorizedView`

getAuthorizedView(GetAuthorizedViewRequest request)

public final AuthorizedView getAuthorizedView(GetAuthorizedViewRequest request)

Gets information from a specified AuthorizedView.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetAuthorizedViewRequest request =
       GetAuthorizedViewRequest.newBuilder()
           .setName(
               AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
                   .toString())
           .build();
   AuthorizedView response = baseBigtableTableAdminClient.getAuthorizedView(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.GetAuthorizedViewRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.bigtable.admin.v2.AuthorizedView`

getAuthorizedView(String name)

public final AuthorizedView getAuthorizedView(String name)

Gets information from a specified AuthorizedView.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name =
       AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
           .toString();
   AuthorizedView response = baseBigtableTableAdminClient.getAuthorizedView(name);
 }

Parameter
Name	Description
`name`	`String` Required. The unique name of the requested AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.

Returns
Type	Description
`com.google.bigtable.admin.v2.AuthorizedView`

getAuthorizedViewCallable()

public final UnaryCallable<GetAuthorizedViewRequest,AuthorizedView> getAuthorizedViewCallable()

Gets information from a specified AuthorizedView.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetAuthorizedViewRequest request =
       GetAuthorizedViewRequest.newBuilder()
           .setName(
               AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
                   .toString())
           .build();
   ApiFuture<AuthorizedView> future =
       baseBigtableTableAdminClient.getAuthorizedViewCallable().futureCall(request);
   // Do something.
   AuthorizedView response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.GetAuthorizedViewRequest,com.google.bigtable.admin.v2.AuthorizedView>`

getBackup(BackupName name)

public final Backup getBackup(BackupName name)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   BackupName name = BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]");
   Backup response = baseBigtableTableAdminClient.getBackup(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.BackupName` Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.

Returns
Type	Description
`com.google.bigtable.admin.v2.Backup`

getBackup(GetBackupRequest request)

public final Backup getBackup(GetBackupRequest request)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetBackupRequest request =
       GetBackupRequest.newBuilder()
           .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString())
           .build();
   Backup response = baseBigtableTableAdminClient.getBackup(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.GetBackupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.bigtable.admin.v2.Backup`

getBackup(String name)

public final Backup getBackup(String name)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name = BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString();
   Backup response = baseBigtableTableAdminClient.getBackup(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.

Returns
Type	Description
`com.google.bigtable.admin.v2.Backup`

getBackupCallable()

public final UnaryCallable<GetBackupRequest,Backup> getBackupCallable()

Gets metadata on a pending or completed Cloud Bigtable Backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetBackupRequest request =
       GetBackupRequest.newBuilder()
           .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[BACKUP]").toString())
           .build();
   ApiFuture<Backup> future =
       baseBigtableTableAdminClient.getBackupCallable().futureCall(request);
   // Do something.
   Backup response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.GetBackupRequest,com.google.bigtable.admin.v2.Backup>`

getIamPolicy(ResourceName resource)

public final Policy getIamPolicy(ResourceName resource)

Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ResourceName resource =
       AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
   Policy response = baseBigtableTableAdminClient.getIamPolicy(resource);
 }

Parameter
Name	Description
`resource`	`com.google.api.resourcenames.ResourceName` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns
Type	Description
`com.google.iam.v1.Policy`

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = baseBigtableTableAdminClient.getIamPolicy(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.GetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

getIamPolicy(String resource)

public final Policy getIamPolicy(String resource)

Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String resource = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
   Policy response = baseBigtableTableAdminClient.getIamPolicy(resource);
 }

Parameter
Name	Description
`resource`	`String` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns
Type	Description
`com.google.iam.v1.Policy`

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       baseBigtableTableAdminClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

getOperationsClient()

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.

Returns
Type	Description
`OperationsClient`

getSchemaBundle(GetSchemaBundleRequest request)

public final SchemaBundle getSchemaBundle(GetSchemaBundleRequest request)

Gets metadata information about the specified schema bundle.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetSchemaBundleRequest request =
       GetSchemaBundleRequest.newBuilder()
           .setName(
               SchemaBundleName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[SCHEMA_BUNDLE]")
                   .toString())
           .build();
   SchemaBundle response = baseBigtableTableAdminClient.getSchemaBundle(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.GetSchemaBundleRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.bigtable.admin.v2.SchemaBundle`

getSchemaBundle(SchemaBundleName name)

public final SchemaBundle getSchemaBundle(SchemaBundleName name)

Gets metadata information about the specified schema bundle.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   SchemaBundleName name =
       SchemaBundleName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[SCHEMA_BUNDLE]");
   SchemaBundle response = baseBigtableTableAdminClient.getSchemaBundle(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.SchemaBundleName` Required. The unique name of the schema bundle to retrieve. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`

Returns
Type	Description
`com.google.bigtable.admin.v2.SchemaBundle`

getSchemaBundle(String name)

public final SchemaBundle getSchemaBundle(String name)

Gets metadata information about the specified schema bundle.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name =
       SchemaBundleName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[SCHEMA_BUNDLE]").toString();
   SchemaBundle response = baseBigtableTableAdminClient.getSchemaBundle(name);
 }

Parameter
Name	Description
`name`	`String` Required. The unique name of the schema bundle to retrieve. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`

Returns
Type	Description
`com.google.bigtable.admin.v2.SchemaBundle`

getSchemaBundleCallable()

public final UnaryCallable<GetSchemaBundleRequest,SchemaBundle> getSchemaBundleCallable()

Gets metadata information about the specified schema bundle.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetSchemaBundleRequest request =
       GetSchemaBundleRequest.newBuilder()
           .setName(
               SchemaBundleName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[SCHEMA_BUNDLE]")
                   .toString())
           .build();
   ApiFuture<SchemaBundle> future =
       baseBigtableTableAdminClient.getSchemaBundleCallable().futureCall(request);
   // Do something.
   SchemaBundle response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.GetSchemaBundleRequest,com.google.bigtable.admin.v2.SchemaBundle>`

getSettings()

public final BaseBigtableTableAdminSettings getSettings()

Returns
Type	Description
`BaseBigtableTableAdminSettings`

getSnapshot(GetSnapshotRequest request)

public final Snapshot getSnapshot(GetSnapshotRequest request)

Gets metadata information about the specified snapshot.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetSnapshotRequest request =
       GetSnapshotRequest.newBuilder()
           .setName(
               SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString())
           .build();
   Snapshot response = baseBigtableTableAdminClient.getSnapshot(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.GetSnapshotRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.bigtable.admin.v2.Snapshot`

getSnapshot(SnapshotName name)

public final Snapshot getSnapshot(SnapshotName name)

Gets metadata information about the specified snapshot.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   SnapshotName name = SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]");
   Snapshot response = baseBigtableTableAdminClient.getSnapshot(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.SnapshotName` Required. The unique name of the requested snapshot. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.

Returns
Type	Description
`com.google.bigtable.admin.v2.Snapshot`

getSnapshot(String name)

public final Snapshot getSnapshot(String name)

Gets metadata information about the specified snapshot.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name =
       SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString();
   Snapshot response = baseBigtableTableAdminClient.getSnapshot(name);
 }

Parameter
Name	Description
`name`	`String` Required. The unique name of the requested snapshot. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.

Returns
Type	Description
`com.google.bigtable.admin.v2.Snapshot`

getSnapshotCallable()

public final UnaryCallable<GetSnapshotRequest,Snapshot> getSnapshotCallable()

Gets metadata information about the specified snapshot.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetSnapshotRequest request =
       GetSnapshotRequest.newBuilder()
           .setName(
               SnapshotName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]").toString())
           .build();
   ApiFuture<Snapshot> future =
       baseBigtableTableAdminClient.getSnapshotCallable().futureCall(request);
   // Do something.
   Snapshot response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.GetSnapshotRequest,com.google.bigtable.admin.v2.Snapshot>`

getStub()

public BigtableTableAdminStub getStub()

Returns
Type	Description
`BigtableTableAdminStub`

getTable(GetTableRequest request)

public final Table getTable(GetTableRequest request)

Gets metadata information about the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetTableRequest request =
       GetTableRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   Table response = baseBigtableTableAdminClient.getTable(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.GetTableRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.bigtable.admin.v2.Table`

getTable(TableName name)

public final Table getTable(TableName name)

Gets metadata information about the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   Table response = baseBigtableTableAdminClient.getTable(name);
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.TableName` Required. The unique name of the requested table. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

Returns
Type	Description
`com.google.bigtable.admin.v2.Table`

getTable(String name)

public final Table getTable(String name)

Gets metadata information about the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   Table response = baseBigtableTableAdminClient.getTable(name);
 }

Parameter
Name	Description
`name`	`String` Required. The unique name of the requested table. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

Returns
Type	Description
`com.google.bigtable.admin.v2.Table`

getTableCallable()

public final UnaryCallable<GetTableRequest,Table> getTableCallable()

Gets metadata information about the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   GetTableRequest request =
       GetTableRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   ApiFuture<Table> future = baseBigtableTableAdminClient.getTableCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.GetTableRequest,com.google.bigtable.admin.v2.Table>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listAuthorizedViews(ListAuthorizedViewsRequest request)

public final BaseBigtableTableAdminClient.ListAuthorizedViewsPagedResponse listAuthorizedViews(ListAuthorizedViewsRequest request)

Lists all AuthorizedViews from a specific table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListAuthorizedViewsRequest request =
       ListAuthorizedViewsRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AuthorizedView element :
       baseBigtableTableAdminClient.listAuthorizedViews(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.ListAuthorizedViewsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListAuthorizedViewsPagedResponse`

listAuthorizedViews(TableName parent)

public final BaseBigtableTableAdminClient.ListAuthorizedViewsPagedResponse listAuthorizedViews(TableName parent)

Lists all AuthorizedViews from a specific table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName parent = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   for (AuthorizedView element :
       baseBigtableTableAdminClient.listAuthorizedViews(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`com.google.bigtable.admin.v2.TableName` Required. The unique name of the table for which AuthorizedViews should be listed. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListAuthorizedViewsPagedResponse`

listAuthorizedViews(String parent)

public final BaseBigtableTableAdminClient.ListAuthorizedViewsPagedResponse listAuthorizedViews(String parent)

Lists all AuthorizedViews from a specific table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   for (AuthorizedView element :
       baseBigtableTableAdminClient.listAuthorizedViews(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The unique name of the table for which AuthorizedViews should be listed. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListAuthorizedViewsPagedResponse`

listAuthorizedViewsCallable()

public final UnaryCallable<ListAuthorizedViewsRequest,ListAuthorizedViewsResponse> listAuthorizedViewsCallable()

Lists all AuthorizedViews from a specific table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListAuthorizedViewsRequest request =
       ListAuthorizedViewsRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAuthorizedViewsResponse response =
         baseBigtableTableAdminClient.listAuthorizedViewsCallable().call(request);
     for (AuthorizedView element : response.getAuthorizedViewsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ListAuthorizedViewsRequest,com.google.bigtable.admin.v2.ListAuthorizedViewsResponse>`

listAuthorizedViewsPagedCallable()

public final UnaryCallable<ListAuthorizedViewsRequest,BaseBigtableTableAdminClient.ListAuthorizedViewsPagedResponse> listAuthorizedViewsPagedCallable()

Lists all AuthorizedViews from a specific table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListAuthorizedViewsRequest request =
       ListAuthorizedViewsRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AuthorizedView> future =
       baseBigtableTableAdminClient.listAuthorizedViewsPagedCallable().futureCall(request);
   // Do something.
   for (AuthorizedView element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ListAuthorizedViewsRequest,ListAuthorizedViewsPagedResponse>`

listBackups(ClusterName parent)

public final BaseBigtableTableAdminClient.ListBackupsPagedResponse listBackups(ClusterName parent)

Lists Cloud Bigtable backups. Returns both completed and pending backups.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   for (Backup element : baseBigtableTableAdminClient.listBackups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`com.google.bigtable.admin.v2.ClusterName` Required. The cluster to list backups from. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. Use `{cluster} = '-'` to list backups for all clusters in an instance, e.g., `projects/{project}/instances/{instance}/clusters/-`.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListBackupsPagedResponse`

listBackups(ListBackupsRequest request)

public final BaseBigtableTableAdminClient.ListBackupsPagedResponse listBackups(ListBackupsRequest request)

Lists Cloud Bigtable backups. Returns both completed and pending backups.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListBackupsRequest request =
       ListBackupsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Backup element : baseBigtableTableAdminClient.listBackups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.ListBackupsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListBackupsPagedResponse`

listBackups(String parent)

public final BaseBigtableTableAdminClient.ListBackupsPagedResponse listBackups(String parent)

Lists Cloud Bigtable backups. Returns both completed and pending backups.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
   for (Backup element : baseBigtableTableAdminClient.listBackups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The cluster to list backups from. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. Use `{cluster} = '-'` to list backups for all clusters in an instance, e.g., `projects/{project}/instances/{instance}/clusters/-`.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListBackupsPagedResponse`

listBackupsCallable()

public final UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()

Lists Cloud Bigtable backups. Returns both completed and pending backups.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListBackupsRequest request =
       ListBackupsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListBackupsResponse response =
         baseBigtableTableAdminClient.listBackupsCallable().call(request);
     for (Backup element : response.getBackupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ListBackupsRequest,com.google.bigtable.admin.v2.ListBackupsResponse>`

listBackupsPagedCallable()

public final UnaryCallable<ListBackupsRequest,BaseBigtableTableAdminClient.ListBackupsPagedResponse> listBackupsPagedCallable()

Lists Cloud Bigtable backups. Returns both completed and pending backups.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListBackupsRequest request =
       ListBackupsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Backup> future =
       baseBigtableTableAdminClient.listBackupsPagedCallable().futureCall(request);
   // Do something.
   for (Backup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ListBackupsRequest,ListBackupsPagedResponse>`

listSchemaBundles(ListSchemaBundlesRequest request)

public final BaseBigtableTableAdminClient.ListSchemaBundlesPagedResponse listSchemaBundles(ListSchemaBundlesRequest request)

Lists all schema bundles associated with the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListSchemaBundlesRequest request =
       ListSchemaBundlesRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SchemaBundle element :
       baseBigtableTableAdminClient.listSchemaBundles(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.ListSchemaBundlesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListSchemaBundlesPagedResponse`

listSchemaBundles(TableName parent)

public final BaseBigtableTableAdminClient.ListSchemaBundlesPagedResponse listSchemaBundles(TableName parent)

Lists all schema bundles associated with the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName parent = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   for (SchemaBundle element :
       baseBigtableTableAdminClient.listSchemaBundles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`com.google.bigtable.admin.v2.TableName` Required. The parent, which owns this collection of schema bundles. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListSchemaBundlesPagedResponse`

listSchemaBundles(String parent)

public final BaseBigtableTableAdminClient.ListSchemaBundlesPagedResponse listSchemaBundles(String parent)

Lists all schema bundles associated with the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   for (SchemaBundle element :
       baseBigtableTableAdminClient.listSchemaBundles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of schema bundles. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListSchemaBundlesPagedResponse`

listSchemaBundlesCallable()

public final UnaryCallable<ListSchemaBundlesRequest,ListSchemaBundlesResponse> listSchemaBundlesCallable()

Lists all schema bundles associated with the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListSchemaBundlesRequest request =
       ListSchemaBundlesRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSchemaBundlesResponse response =
         baseBigtableTableAdminClient.listSchemaBundlesCallable().call(request);
     for (SchemaBundle element : response.getSchemaBundlesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ListSchemaBundlesRequest,com.google.bigtable.admin.v2.ListSchemaBundlesResponse>`

listSchemaBundlesPagedCallable()

public final UnaryCallable<ListSchemaBundlesRequest,BaseBigtableTableAdminClient.ListSchemaBundlesPagedResponse> listSchemaBundlesPagedCallable()

Lists all schema bundles associated with the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListSchemaBundlesRequest request =
       ListSchemaBundlesRequest.newBuilder()
           .setParent(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SchemaBundle> future =
       baseBigtableTableAdminClient.listSchemaBundlesPagedCallable().futureCall(request);
   // Do something.
   for (SchemaBundle element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ListSchemaBundlesRequest,ListSchemaBundlesPagedResponse>`

listSnapshots(ClusterName parent)

public final BaseBigtableTableAdminClient.ListSnapshotsPagedResponse listSnapshots(ClusterName parent)

Lists all snapshots associated with the specified cluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   for (Snapshot element : baseBigtableTableAdminClient.listSnapshots(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`com.google.bigtable.admin.v2.ClusterName` Required. 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/-`.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListSnapshotsPagedResponse`

listSnapshots(ListSnapshotsRequest request)

public final BaseBigtableTableAdminClient.ListSnapshotsPagedResponse listSnapshots(ListSnapshotsRequest request)

Lists all snapshots associated with the specified cluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListSnapshotsRequest request =
       ListSnapshotsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Snapshot element : baseBigtableTableAdminClient.listSnapshots(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.ListSnapshotsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListSnapshotsPagedResponse`

listSnapshots(String parent)

public final BaseBigtableTableAdminClient.ListSnapshotsPagedResponse listSnapshots(String parent)

Lists all snapshots associated with the specified cluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
   for (Snapshot element : baseBigtableTableAdminClient.listSnapshots(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. 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/-`.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListSnapshotsPagedResponse`

listSnapshotsCallable()

public final UnaryCallable<ListSnapshotsRequest,ListSnapshotsResponse> listSnapshotsCallable()

Lists all snapshots associated with the specified cluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListSnapshotsRequest request =
       ListSnapshotsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ListSnapshotsRequest,com.google.bigtable.admin.v2.ListSnapshotsResponse>`

listSnapshotsPagedCallable()

public final UnaryCallable<ListSnapshotsRequest,BaseBigtableTableAdminClient.ListSnapshotsPagedResponse> listSnapshotsPagedCallable()

Lists all snapshots associated with the specified cluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListSnapshotsRequest request =
       ListSnapshotsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Snapshot> future =
       baseBigtableTableAdminClient.listSnapshotsPagedCallable().futureCall(request);
   // Do something.
   for (Snapshot element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ListSnapshotsRequest,ListSnapshotsPagedResponse>`

listTables(InstanceName parent)

public final BaseBigtableTableAdminClient.ListTablesPagedResponse listTables(InstanceName parent)

Lists all tables served from a specified instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   for (Table element : baseBigtableTableAdminClient.listTables(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`com.google.bigtable.admin.v2.InstanceName` Required. The unique name of the instance for which tables should be listed. Values are of the form `projects/{project}/instances/{instance}`.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListTablesPagedResponse`

listTables(ListTablesRequest request)

public final BaseBigtableTableAdminClient.ListTablesPagedResponse listTables(ListTablesRequest request)

Lists all tables served from a specified instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListTablesRequest request =
       ListTablesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Table element : baseBigtableTableAdminClient.listTables(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.ListTablesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListTablesPagedResponse`

listTables(String parent)

public final BaseBigtableTableAdminClient.ListTablesPagedResponse listTables(String parent)

Lists all tables served from a specified instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   for (Table element : baseBigtableTableAdminClient.listTables(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The unique name of the instance for which tables should be listed. Values are of the form `projects/{project}/instances/{instance}`.

Returns
Type	Description
`BaseBigtableTableAdminClient.ListTablesPagedResponse`

listTablesCallable()

public final UnaryCallable<ListTablesRequest,ListTablesResponse> listTablesCallable()

Lists all tables served from a specified instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListTablesRequest request =
       ListTablesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ListTablesRequest,com.google.bigtable.admin.v2.ListTablesResponse>`

listTablesPagedCallable()

public final UnaryCallable<ListTablesRequest,BaseBigtableTableAdminClient.ListTablesPagedResponse> listTablesPagedCallable()

Lists all tables served from a specified instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ListTablesRequest request =
       ListTablesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Table> future =
       baseBigtableTableAdminClient.listTablesPagedCallable().futureCall(request);
   // Do something.
   for (Table element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ListTablesRequest,ListTablesPagedResponse>`

modifyColumnFamilies(ModifyColumnFamiliesRequest request)

public final Table modifyColumnFamilies(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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ModifyColumnFamiliesRequest request =
       ModifyColumnFamiliesRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .addAllModifications(new ArrayList<ModifyColumnFamiliesRequest.Modification>())
           .setIgnoreWarnings(true)
           .build();
   Table response = baseBigtableTableAdminClient.modifyColumnFamilies(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.bigtable.admin.v2.Table`

modifyColumnFamilies(TableName name, List<ModifyColumnFamiliesRequest.Modification> modifications)

public final Table modifyColumnFamilies(TableName name, List<ModifyColumnFamiliesRequest.Modification> modifications)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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	Description
`name`	`com.google.bigtable.admin.v2.TableName` Required. The unique name of the table whose families should be modified. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`modifications`	`List<com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest.Modification>` Required. 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).

Returns
Type	Description
`com.google.bigtable.admin.v2.Table`

modifyColumnFamilies(String name, List<ModifyColumnFamiliesRequest.Modification> modifications)

public final Table modifyColumnFamilies(String name, List<ModifyColumnFamiliesRequest.Modification> modifications)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   List<ModifyColumnFamiliesRequest.Modification> modifications = new ArrayList<>();
   Table response = baseBigtableTableAdminClient.modifyColumnFamilies(name, modifications);
 }

Parameters
Name	Description
`name`	`String` Required. The unique name of the table whose families should be modified. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`modifications`	`List<com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest.Modification>` Required. 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).

Returns
Type	Description
`com.google.bigtable.admin.v2.Table`

modifyColumnFamiliesCallable()

public final UnaryCallable<ModifyColumnFamiliesRequest,Table> modifyColumnFamiliesCallable()

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ModifyColumnFamiliesRequest request =
       ModifyColumnFamiliesRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .addAllModifications(new ArrayList<ModifyColumnFamiliesRequest.Modification>())
           .setIgnoreWarnings(true)
           .build();
   ApiFuture<Table> future =
       baseBigtableTableAdminClient.modifyColumnFamiliesCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest,com.google.bigtable.admin.v2.Table>`

restoreTableAsync(RestoreTableRequest request)

public final OperationFuture<Table,RestoreTableMetadata> restoreTableAsync(RestoreTableRequest request)

Create a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   RestoreTableRequest request =
       RestoreTableRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setTableId("tableId-1552905847")
           .build();
   Table response = baseBigtableTableAdminClient.restoreTableAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.RestoreTableRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.RestoreTableMetadata>`

restoreTableCallable()

public final UnaryCallable<RestoreTableRequest,Operation> restoreTableCallable()

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   RestoreTableRequest request =
       RestoreTableRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setTableId("tableId-1552905847")
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.restoreTableCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.RestoreTableRequest,Operation>`

restoreTableOperationCallable()

public final OperationCallable<RestoreTableRequest,Table,RestoreTableMetadata> restoreTableOperationCallable()

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   RestoreTableRequest request =
       RestoreTableRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setTableId("tableId-1552905847")
           .build();
   OperationFuture<Table, RestoreTableMetadata> future =
       baseBigtableTableAdminClient.restoreTableOperationCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.RestoreTableRequest,com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.RestoreTableMetadata>`

setIamPolicy(ResourceName resource, Policy policy)

public final Policy setIamPolicy(ResourceName resource, Policy policy)

Sets the access control policy on a Bigtable resource. Replaces any existing policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ResourceName resource =
       AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
   Policy policy = Policy.newBuilder().build();
   Policy response = baseBigtableTableAdminClient.setIamPolicy(resource, policy);
 }

Parameters
Name	Description
`resource`	`com.google.api.resourcenames.ResourceName` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`com.google.iam.v1.Policy` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Returns
Type	Description
`com.google.iam.v1.Policy`

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on a Bigtable resource. Replaces any existing policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = baseBigtableTableAdminClient.setIamPolicy(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.SetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

setIamPolicy(String resource, Policy policy)

public final Policy setIamPolicy(String resource, Policy policy)

Sets the access control policy on a Bigtable resource. Replaces any existing policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String resource = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
   Policy policy = Policy.newBuilder().build();
   Policy response = baseBigtableTableAdminClient.setIamPolicy(resource, policy);
 }

Parameters
Name	Description
`resource`	`String` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`com.google.iam.v1.Policy` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Returns
Type	Description
`com.google.iam.v1.Policy`

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on a Bigtable resource. Replaces any existing policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       baseBigtableTableAdminClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

snapshotTableAsync(SnapshotTableRequest request)

public final OperationFuture<Snapshot,SnapshotTableMetadata> snapshotTableAsync(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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   SnapshotTableRequest request =
       SnapshotTableRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setCluster(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setSnapshotId("snapshotId-1113817601")
           .setTtl(Duration.newBuilder().build())
           .setDescription("description-1724546052")
           .build();
   Snapshot response = baseBigtableTableAdminClient.snapshotTableAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.SnapshotTableRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>`

snapshotTableAsync(TableName name, ClusterName cluster, String snapshotId, String description)

public final OperationFuture<Snapshot,SnapshotTableMetadata> snapshotTableAsync(TableName name, ClusterName 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   ClusterName cluster = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   String snapshotId = "snapshotId-1113817601";
   String description = "description-1724546052";
   Snapshot response =
       baseBigtableTableAdminClient
           .snapshotTableAsync(name, cluster, snapshotId, description)
           .get();
 }

Parameters
Name	Description
`name`	`com.google.bigtable.admin.v2.TableName` Required. The unique name of the table to have the snapshot taken. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`cluster`	`com.google.bigtable.admin.v2.ClusterName` Required. The name of the cluster where the snapshot will be created in. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
`snapshotId`	`String` Required. 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*` rather than `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
`description`	`String` Description of the snapshot.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>`

snapshotTableAsync(TableName name, String cluster, String snapshotId, String description)

public final OperationFuture<Snapshot,SnapshotTableMetadata> snapshotTableAsync(TableName 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   String cluster = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
   String snapshotId = "snapshotId-1113817601";
   String description = "description-1724546052";
   Snapshot response =
       baseBigtableTableAdminClient
           .snapshotTableAsync(name, cluster, snapshotId, description)
           .get();
 }

Parameters
Name	Description
`name`	`com.google.bigtable.admin.v2.TableName` Required. The unique name of the table to have the snapshot taken. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`cluster`	`String` Required. The name of the cluster where the snapshot will be created in. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
`snapshotId`	`String` Required. 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*` rather than `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
`description`	`String` Description of the snapshot.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>`

snapshotTableAsync(String name, ClusterName cluster, String snapshotId, String description)

public final OperationFuture<Snapshot,SnapshotTableMetadata> snapshotTableAsync(String name, ClusterName 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   ClusterName cluster = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   String snapshotId = "snapshotId-1113817601";
   String description = "description-1724546052";
   Snapshot response =
       baseBigtableTableAdminClient
           .snapshotTableAsync(name, cluster, snapshotId, description)
           .get();
 }

Parameters
Name	Description
`name`	`String` Required. The unique name of the table to have the snapshot taken. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`cluster`	`com.google.bigtable.admin.v2.ClusterName` Required. The name of the cluster where the snapshot will be created in. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
`snapshotId`	`String` Required. 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*` rather than `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
`description`	`String` Description of the snapshot.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>`

snapshotTableAsync(String name, String cluster, String snapshotId, String description)

public final OperationFuture<Snapshot,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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   String cluster = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
   String snapshotId = "snapshotId-1113817601";
   String description = "description-1724546052";
   Snapshot response =
       baseBigtableTableAdminClient
           .snapshotTableAsync(name, cluster, snapshotId, description)
           .get();
 }

Parameters
Name	Description
`name`	`String` Required. The unique name of the table to have the snapshot taken. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`cluster`	`String` Required. The name of the cluster where the snapshot will be created in. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
`snapshotId`	`String` Required. 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*` rather than `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
`description`	`String` Description of the snapshot.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>`

snapshotTableCallable()

public final UnaryCallable<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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   SnapshotTableRequest request =
       SnapshotTableRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setCluster(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setSnapshotId("snapshotId-1113817601")
           .setTtl(Duration.newBuilder().build())
           .setDescription("description-1724546052")
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.snapshotTableCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.SnapshotTableRequest,Operation>`

snapshotTableOperationCallable()

public final OperationCallable<SnapshotTableRequest,Snapshot,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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   SnapshotTableRequest request =
       SnapshotTableRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .setCluster(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setSnapshotId("snapshotId-1113817601")
           .setTtl(Duration.newBuilder().build())
           .setDescription("description-1724546052")
           .build();
   OperationFuture<Snapshot, SnapshotTableMetadata> future =
       baseBigtableTableAdminClient.snapshotTableOperationCallable().futureCall(request);
   // Do something.
   Snapshot response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.SnapshotTableRequest,com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>`

testIamPermissions(ResourceName resource, List<String> permissions)

public final TestIamPermissionsResponse testIamPermissions(ResourceName resource, List<String> permissions)

Returns permissions that the caller has on the specified Bigtable resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   ResourceName resource =
       AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response =
       baseBigtableTableAdminClient.testIamPermissions(resource, permissions);
 }

Parameters
Name	Description
`resource`	`com.google.api.resourcenames.ResourceName` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	`List<String>` The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

Returns
Type	Description
`com.google.iam.v1.TestIamPermissionsResponse`

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that the caller has on the specified Bigtable resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       baseBigtableTableAdminClient.testIamPermissions(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.TestIamPermissionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.TestIamPermissionsResponse`

testIamPermissions(String resource, List<String> permissions)

public final TestIamPermissionsResponse testIamPermissions(String resource, List<String> permissions)

Returns permissions that the caller has on the specified Bigtable resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String resource = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response =
       baseBigtableTableAdminClient.testIamPermissions(resource, permissions);
 }

Parameters
Name	Description
`resource`	`String` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	`List<String>` The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

Returns
Type	Description
`com.google.iam.v1.TestIamPermissionsResponse`

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that the caller has on the specified Bigtable resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AuthorizedViewName.of("[PROJECT]", "[INSTANCE]", "[TABLE]", "[AUTHORIZED_VIEW]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       baseBigtableTableAdminClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

undeleteTableAsync(TableName name)

public final OperationFuture<Table,UndeleteTableMetadata> undeleteTableAsync(TableName name)

Restores a specified table which was accidentally deleted.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   TableName name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]");
   Table response = baseBigtableTableAdminClient.undeleteTableAsync(name).get();
 }

Parameter
Name	Description
`name`	`com.google.bigtable.admin.v2.TableName` Required. The unique name of the table to be restored. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.UndeleteTableMetadata>`

undeleteTableAsync(UndeleteTableRequest request)

public final OperationFuture<Table,UndeleteTableMetadata> undeleteTableAsync(UndeleteTableRequest request)

Restores a specified table which was accidentally deleted.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UndeleteTableRequest request =
       UndeleteTableRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   Table response = baseBigtableTableAdminClient.undeleteTableAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.UndeleteTableRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.UndeleteTableMetadata>`

undeleteTableAsync(String name)

public final OperationFuture<Table,UndeleteTableMetadata> undeleteTableAsync(String name)

Restores a specified table which was accidentally deleted.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   String name = TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString();
   Table response = baseBigtableTableAdminClient.undeleteTableAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The unique name of the table to be restored. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.UndeleteTableMetadata>`

undeleteTableCallable()

public final UnaryCallable<UndeleteTableRequest,Operation> undeleteTableCallable()

Restores a specified table which was accidentally deleted.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UndeleteTableRequest request =
       UndeleteTableRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.undeleteTableCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.UndeleteTableRequest,Operation>`

undeleteTableOperationCallable()

public final OperationCallable<UndeleteTableRequest,Table,UndeleteTableMetadata> undeleteTableOperationCallable()

Restores a specified table which was accidentally deleted.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UndeleteTableRequest request =
       UndeleteTableRequest.newBuilder()
           .setName(TableName.of("[PROJECT]", "[INSTANCE]", "[TABLE]").toString())
           .build();
   OperationFuture<Table, UndeleteTableMetadata> future =
       baseBigtableTableAdminClient.undeleteTableOperationCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.UndeleteTableRequest,com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.UndeleteTableMetadata>`

updateAuthorizedViewAsync(AuthorizedView authorizedView, FieldMask updateMask)

public final OperationFuture<AuthorizedView,UpdateAuthorizedViewMetadata> updateAuthorizedViewAsync(AuthorizedView authorizedView, FieldMask updateMask)

Updates an AuthorizedView in a table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   AuthorizedView authorizedView = AuthorizedView.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AuthorizedView response =
       baseBigtableTableAdminClient.updateAuthorizedViewAsync(authorizedView, updateMask).get();
 }

Parameters
Name	Description
`authorizedView`	`com.google.bigtable.admin.v2.AuthorizedView` Required. The AuthorizedView to update. The `name` in `authorized_view` is used to identify the AuthorizedView. AuthorizedView name must in this format: `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.
`updateMask`	`FieldMask` Optional. The list of fields to update. A mask specifying which fields in the AuthorizedView resource should be updated. This mask is relative to the AuthorizedView resource, not to the request message. A field will be overwritten if it is in the mask. If empty, all fields set in the request will be overwritten. A special value `*` means to overwrite all fields (including fields not set in the request).

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.AuthorizedView,com.google.bigtable.admin.v2.UpdateAuthorizedViewMetadata>`

updateAuthorizedViewAsync(UpdateAuthorizedViewRequest request)

public final OperationFuture<AuthorizedView,UpdateAuthorizedViewMetadata> updateAuthorizedViewAsync(UpdateAuthorizedViewRequest request)

Updates an AuthorizedView in a table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateAuthorizedViewRequest request =
       UpdateAuthorizedViewRequest.newBuilder()
           .setAuthorizedView(AuthorizedView.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   AuthorizedView response =
       baseBigtableTableAdminClient.updateAuthorizedViewAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.UpdateAuthorizedViewRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.AuthorizedView,com.google.bigtable.admin.v2.UpdateAuthorizedViewMetadata>`

updateAuthorizedViewCallable()

public final UnaryCallable<UpdateAuthorizedViewRequest,Operation> updateAuthorizedViewCallable()

Updates an AuthorizedView in a table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateAuthorizedViewRequest request =
       UpdateAuthorizedViewRequest.newBuilder()
           .setAuthorizedView(AuthorizedView.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.updateAuthorizedViewCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.UpdateAuthorizedViewRequest,Operation>`

updateAuthorizedViewOperationCallable()

public final OperationCallable<UpdateAuthorizedViewRequest,AuthorizedView,UpdateAuthorizedViewMetadata> updateAuthorizedViewOperationCallable()

Updates an AuthorizedView in a table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateAuthorizedViewRequest request =
       UpdateAuthorizedViewRequest.newBuilder()
           .setAuthorizedView(AuthorizedView.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   OperationFuture<AuthorizedView, UpdateAuthorizedViewMetadata> future =
       baseBigtableTableAdminClient.updateAuthorizedViewOperationCallable().futureCall(request);
   // Do something.
   AuthorizedView response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.UpdateAuthorizedViewRequest,com.google.bigtable.admin.v2.AuthorizedView,com.google.bigtable.admin.v2.UpdateAuthorizedViewMetadata>`

updateBackup(Backup backup, FieldMask updateMask)

public final Backup updateBackup(Backup backup, FieldMask updateMask)

Updates a pending or completed Cloud Bigtable Backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   Backup backup = Backup.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Backup response = baseBigtableTableAdminClient.updateBackup(backup, updateMask);
 }

Parameters

Name Description

backup

com.google.bigtable.admin.v2.Backup

Required. The backup to update. backup.name, and the fields to be updated as specified by update_mask are required. Other fields are ignored. Update is only supported for the following fields:

* backup.expire_time.

updateMask

FieldMask

Required. A mask specifying which fields (e.g. expire_time) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.

Returns
Type	Description
`com.google.bigtable.admin.v2.Backup`

updateBackup(UpdateBackupRequest request)

public final Backup updateBackup(UpdateBackupRequest request)

Updates a pending or completed Cloud Bigtable Backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateBackupRequest request =
       UpdateBackupRequest.newBuilder()
           .setBackup(Backup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Backup response = baseBigtableTableAdminClient.updateBackup(request);
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.UpdateBackupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.bigtable.admin.v2.Backup`

updateBackupCallable()

public final UnaryCallable<UpdateBackupRequest,Backup> updateBackupCallable()

Updates a pending or completed Cloud Bigtable Backup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateBackupRequest request =
       UpdateBackupRequest.newBuilder()
           .setBackup(Backup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Backup> future =
       baseBigtableTableAdminClient.updateBackupCallable().futureCall(request);
   // Do something.
   Backup response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.UpdateBackupRequest,com.google.bigtable.admin.v2.Backup>`

updateSchemaBundleAsync(SchemaBundle schemaBundle, FieldMask updateMask)

public final OperationFuture<SchemaBundle,UpdateSchemaBundleMetadata> updateSchemaBundleAsync(SchemaBundle schemaBundle, FieldMask updateMask)

Updates a schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   SchemaBundle schemaBundle = SchemaBundle.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   SchemaBundle response =
       baseBigtableTableAdminClient.updateSchemaBundleAsync(schemaBundle, updateMask).get();
 }

Parameters

Name Description

schemaBundle

com.google.bigtable.admin.v2.SchemaBundle

Required. The schema bundle to update.

The schema bundle's name field is used to identify the schema bundle to update. Values are of the form projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}

updateMask

FieldMask

Optional. The list of fields to update.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.SchemaBundle,com.google.bigtable.admin.v2.UpdateSchemaBundleMetadata>`

updateSchemaBundleAsync(UpdateSchemaBundleRequest request)

public final OperationFuture<SchemaBundle,UpdateSchemaBundleMetadata> updateSchemaBundleAsync(UpdateSchemaBundleRequest request)

Updates a schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateSchemaBundleRequest request =
       UpdateSchemaBundleRequest.newBuilder()
           .setSchemaBundle(SchemaBundle.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   SchemaBundle response = baseBigtableTableAdminClient.updateSchemaBundleAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.UpdateSchemaBundleRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.SchemaBundle,com.google.bigtable.admin.v2.UpdateSchemaBundleMetadata>`

updateSchemaBundleCallable()

public final UnaryCallable<UpdateSchemaBundleRequest,Operation> updateSchemaBundleCallable()

Updates a schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateSchemaBundleRequest request =
       UpdateSchemaBundleRequest.newBuilder()
           .setSchemaBundle(SchemaBundle.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.updateSchemaBundleCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.UpdateSchemaBundleRequest,Operation>`

updateSchemaBundleOperationCallable()

public final OperationCallable<UpdateSchemaBundleRequest,SchemaBundle,UpdateSchemaBundleMetadata> updateSchemaBundleOperationCallable()

Updates a schema bundle in the specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateSchemaBundleRequest request =
       UpdateSchemaBundleRequest.newBuilder()
           .setSchemaBundle(SchemaBundle.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   OperationFuture<SchemaBundle, UpdateSchemaBundleMetadata> future =
       baseBigtableTableAdminClient.updateSchemaBundleOperationCallable().futureCall(request);
   // Do something.
   SchemaBundle response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.UpdateSchemaBundleRequest,com.google.bigtable.admin.v2.SchemaBundle,com.google.bigtable.admin.v2.UpdateSchemaBundleMetadata>`

updateTableAsync(Table table, FieldMask updateMask)

public final OperationFuture<Table,UpdateTableMetadata> updateTableAsync(Table table, FieldMask updateMask)

Updates a specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   Table table = Table.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Table response = baseBigtableTableAdminClient.updateTableAsync(table, updateMask).get();
 }

Parameters

Name Description

table

com.google.bigtable.admin.v2.Table

Required. The table to update. The table's name field is used to identify the table to update.

updateMask

FieldMask

Required. The list of fields to update. A mask specifying which fields (e.g. change_stream_config) in the table field should be updated. This mask is relative to the table field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields:

change_stream_config
change_stream_config.retention_period
deletion_protection
row_key_schema

If column_families is set in update_mask, it will return an UNIMPLEMENTED error.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.UpdateTableMetadata>`

updateTableAsync(UpdateTableRequest request)

public final OperationFuture<Table,UpdateTableMetadata> updateTableAsync(UpdateTableRequest request)

Updates a specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateTableRequest request =
       UpdateTableRequest.newBuilder()
           .setTable(Table.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   Table response = baseBigtableTableAdminClient.updateTableAsync(request).get();
 }

Parameter
Name	Description
`request`	`com.google.bigtable.admin.v2.UpdateTableRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.UpdateTableMetadata>`

updateTableCallable()

public final UnaryCallable<UpdateTableRequest,Operation> updateTableCallable()

Updates a specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateTableRequest request =
       UpdateTableRequest.newBuilder()
           .setTable(Table.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   ApiFuture<Operation> future =
       baseBigtableTableAdminClient.updateTableCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.bigtable.admin.v2.UpdateTableRequest,Operation>`

updateTableOperationCallable()

public final OperationCallable<UpdateTableRequest,Table,UpdateTableMetadata> updateTableOperationCallable()

Updates a specified table.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BaseBigtableTableAdminClient baseBigtableTableAdminClient =
     BaseBigtableTableAdminClient.create()) {
   UpdateTableRequest request =
       UpdateTableRequest.newBuilder()
           .setTable(Table.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   OperationFuture<Table, UpdateTableMetadata> future =
       baseBigtableTableAdminClient.updateTableOperationCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

Returns
Type	Description
`OperationCallable<com.google.bigtable.admin.v2.UpdateTableRequest,com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.UpdateTableMetadata>`

Class BaseBigtableTableAdminClient (2.77.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(BaseBigtableTableAdminSettings settings)

create(BigtableTableAdminStub stub)

Constructors

BaseBigtableTableAdminClient(BaseBigtableTableAdminSettings settings)

BaseBigtableTableAdminClient(BigtableTableAdminStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

checkConsistency(CheckConsistencyRequest request)

checkConsistency(TableName name, String consistencyToken)

checkConsistency(String name, String consistencyToken)

checkConsistencyCallable()

close()

copyBackupAsync(ClusterName parent, String backupId, BackupName sourceBackup, Timestamp expireTime)

copyBackupAsync(ClusterName parent, String backupId, String sourceBackup, Timestamp expireTime)

copyBackupAsync(CopyBackupRequest request)

copyBackupAsync(String parent, String backupId, BackupName sourceBackup, Timestamp expireTime)

copyBackupAsync(String parent, String backupId, String sourceBackup, Timestamp expireTime)

copyBackupCallable()

copyBackupOperationCallable()

createAuthorizedViewAsync(CreateAuthorizedViewRequest request)

createAuthorizedViewAsync(TableName parent, AuthorizedView authorizedView, String authorizedViewId)

createAuthorizedViewAsync(String parent, AuthorizedView authorizedView, String authorizedViewId)

createAuthorizedViewCallable()

createAuthorizedViewOperationCallable()

createBackupAsync(ClusterName parent, String backupId, Backup backup)

createBackupAsync(CreateBackupRequest request)

createBackupAsync(String parent, String backupId, Backup backup)

createBackupCallable()

createBackupOperationCallable()

createSchemaBundleAsync(CreateSchemaBundleRequest request)

createSchemaBundleAsync(TableName parent, String schemaBundleId, SchemaBundle schemaBundle)

createSchemaBundleAsync(String parent, String schemaBundleId, SchemaBundle schemaBundle)

createSchemaBundleCallable()

createSchemaBundleOperationCallable()

createTable(CreateTableRequest request)

createTable(InstanceName parent, String tableId, Table table)

createTable(String parent, String tableId, Table table)

createTableCallable()

createTableFromSnapshotAsync(CreateTableFromSnapshotRequest request)

createTableFromSnapshotAsync(InstanceName parent, String tableId, SnapshotName sourceSnapshot)

createTableFromSnapshotAsync(InstanceName parent, String tableId, String sourceSnapshot)

createTableFromSnapshotAsync(String parent, String tableId, SnapshotName sourceSnapshot)

createTableFromSnapshotAsync(String parent, String tableId, String sourceSnapshot)

createTableFromSnapshotCallable()

createTableFromSnapshotOperationCallable()

deleteAuthorizedView(AuthorizedViewName name)

deleteAuthorizedView(DeleteAuthorizedViewRequest request)

deleteAuthorizedView(String name)

deleteAuthorizedViewCallable()

deleteBackup(BackupName name)

deleteBackup(DeleteBackupRequest request)

deleteBackup(String name)

deleteBackupCallable()

deleteSchemaBundle(DeleteSchemaBundleRequest request)

deleteSchemaBundle(SchemaBundleName name)

deleteSchemaBundle(String name)

deleteSchemaBundleCallable()

deleteSnapshot(DeleteSnapshotRequest request)

deleteSnapshot(SnapshotName name)

deleteSnapshot(String name)

deleteSnapshotCallable()

deleteTable(DeleteTableRequest request)

deleteTable(TableName name)

deleteTable(String name)

deleteTableCallable()

dropRowRange(DropRowRangeRequest request)

dropRowRangeCallable()

generateConsistencyToken(GenerateConsistencyTokenRequest request)

generateConsistencyToken(TableName name)

generateConsistencyToken(String name)

generateConsistencyTokenCallable()

getAuthorizedView(AuthorizedViewName name)

getAuthorizedView(GetAuthorizedViewRequest request)

getAuthorizedView(String name)

getAuthorizedViewCallable()

getBackup(BackupName name)

Class BaseBigtableTableAdminClient (2.77.0)