com.google.cloud.bigtable.admin.v2

Class BigtableInstanceAdminClient

java.lang.Object

com.google.cloud.bigtable.admin.v2.BigtableInstanceAdminClient

All Implemented Interfaces:

AutoCloseable

public final class BigtableInstanceAdminClient
extends Object
implements AutoCloseable

Client for creating, configuring and deleting Cloud Bigtable instances, app profiles, and clusters.

See the individual methods for example code.

 // One instance per application.
 BigtableInstanceAdminClient client =  BigtableInstanceAdminClient.create("my-project");
 CreateInstanceRequest request = CreateInstanceRequest.of("my-instance")
   .addCluster("my-cluster", "us-east1-c", 3, StorageType.SSD);

 Instance instance = client.createInstance(request);

 // Cleanup during application shutdown.
 client.close();
 

Creating a new client is a very expensive operation and should only be done once and shared in an application. However, close() needs to be called on the client object to clean up resources such as threads during application shutdown.

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

To customize credentials:

 BigtableInstanceAdminSettings settings = BigtableInstanceAdminSettings.newBuilder()
   .setProjectId("my-project")
   .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
   .build();

 BigtableInstanceAdminClient client = BigtableInstanceAdminClient.create(settings);
 

To customize the endpoint:

 BigtableInstanceAdminSettings.Builder settingsBuilder = BigtableInstanceAdminSettings.newBuilder()
   .setProjectId("my-project");

 settingsBuilder.stubSettings()
   .setEndpoint(myEndpoint);

 BigtableInstanceAdminClient client = BigtableInstanceAdminClient.create(settingsBuilder.build());
 

Method Summary

Modifier and Type	Method and Description
void	close() Closes the client and frees all resources associated with it (like thread pools).
static BigtableInstanceAdminClient	create(BigtableInstanceAdminSettings settings) Constructs an instance of BigtableInstanceAdminClient with the given settings.
static BigtableInstanceAdminClient	create(String projectId) Constructs an instance of BigtableInstanceAdminClient with the given project ID.
static BigtableInstanceAdminClient	create(String projectId, BigtableInstanceAdminStub stub) Constructs an instance of BigtableInstanceAdminClient with the given project ID and stub.
AppProfile	createAppProfile(CreateAppProfileRequest request) This method is obsolete.
com.google.api.core.ApiFuture<AppProfile>	createAppProfileAsync(CreateAppProfileRequest request) This method is obsolete.
Cluster	createCluster(CreateClusterRequest request) This method is obsolete.
com.google.api.core.ApiFuture<Cluster>	createClusterAsync(CreateClusterRequest request) This method is obsolete.
Instance	createInstance(CreateInstanceRequest request) This method is obsolete.
com.google.api.core.ApiFuture<Instance>	createInstanceAsync(CreateInstanceRequest request) This method is obsolete.
LogicalView	createLogicalView(CreateLogicalViewRequest request) This method is obsolete.
com.google.api.core.ApiFuture<LogicalView>	createLogicalViewAsync(CreateLogicalViewRequest request) This method is obsolete.
MaterializedView	createMaterializedView(CreateMaterializedViewRequest request) This method is obsolete.
com.google.api.core.ApiFuture<MaterializedView>	createMaterializedViewAsync(CreateMaterializedViewRequest request) This method is obsolete.
void	deleteAppProfile(String instanceId, String appProfileId) This method is obsolete.
void	deleteAppProfile(String instanceId, String appProfileId, boolean forceDelete) This method is obsolete.
com.google.api.core.ApiFuture<Void>	deleteAppProfileAsync(String instanceId, String appProfileId) This method is obsolete.
com.google.api.core.ApiFuture<Void>	deleteAppProfileAsync(String instanceId, String appProfileId, boolean forceDelete) This method is obsolete.
void	deleteCluster(String instanceId, String clusterId) This method is obsolete.
com.google.api.core.ApiFuture<Void>	deleteClusterAsync(String instanceId, String clusterId) This method is obsolete.
void	deleteInstance(String instanceId) This method is obsolete.
com.google.api.core.ApiFuture<Void>	deleteInstanceAsync(String instanceId) This method is obsolete.
void	deleteLogicalView(String instanceId, String logicalViewId) This method is obsolete.
com.google.api.core.ApiFuture<Void>	deleteLogicalViewAsync(String instanceId, String logicalViewId) This method is obsolete.
void	deleteMaterializedView(String instanceId, String materializedViewId) This method is obsolete.
com.google.api.core.ApiFuture<Void>	deleteMaterializedViewAsync(String instanceId, String materializedViewId) This method is obsolete.
Cluster	disableClusterAutoscaling(String instanceId, String clusterId, int staticSize) This method is obsolete.
com.google.api.core.ApiFuture<Cluster>	disableClusterAutoscalingAsync(String instanceId, String clusterId, int staticSize) This method is obsolete.
boolean	exists(String instanceId) This method is obsolete.
com.google.api.core.ApiFuture<Boolean>	existsAsync(String instanceId) This method is obsolete.
AppProfile	getAppProfile(String instanceId, String appProfileId) This method is obsolete.
com.google.api.core.ApiFuture<AppProfile>	getAppProfileAsync(String instanceId, String appProfileId) This method is obsolete.
BaseBigtableInstanceAdminClient	getBaseClient() Returns the modern autogenerated client.
Cluster	getCluster(String instanceId, String clusterId) This method is obsolete.
com.google.api.core.ApiFuture<Cluster>	getClusterAsync(String instanceId, String clusterId) This method is obsolete.
com.google.cloud.Policy	getIamPolicy(String instanceId) This method is obsolete.
com.google.api.core.ApiFuture<com.google.cloud.Policy>	getIamPolicyAsync(String instanceId) This method is obsolete.
Instance	getInstance(String id) This method is obsolete.
com.google.api.core.ApiFuture<Instance>	getInstanceAsync(String instanceId) This method is obsolete.
LogicalView	getLogicalView(String instanceId, String logicalViewId) This method is obsolete.
com.google.api.core.ApiFuture<LogicalView>	getLogicalViewAsync(String instanceId, String logicalViewId) This method is obsolete.
MaterializedView	getMaterializedView(String instanceId, String materializedViewId) This method is obsolete.
com.google.api.core.ApiFuture<MaterializedView>	getMaterializedViewAsync(String instanceId, String materializedViewId) This method is obsolete.
String	getProjectId() Gets the project ID this client is associated with.
List<AppProfile>	listAppProfiles(String instanceId) This method is obsolete.
com.google.api.core.ApiFuture<List<AppProfile>>	listAppProfilesAsync(String instanceId) This method is obsolete.
List<Cluster>	listClusters(String instanceId) This method is obsolete.
com.google.api.core.ApiFuture<List<Cluster>>	listClustersAsync(String instanceId) This method is obsolete.
List<Instance>	listInstances() This method is obsolete.
com.google.api.core.ApiFuture<List<Instance>>	listInstancesAsync() This method is obsolete.
List<LogicalView>	listLogicalViews(String instanceId) This method is obsolete.
com.google.api.core.ApiFuture<List<LogicalView>>	listLogicalViewsAsync(String instanceId) This method is obsolete.
List<MaterializedView>	listMaterializedViews(String instanceId) This method is obsolete.
com.google.api.core.ApiFuture<List<MaterializedView>>	listMaterializedViewsAsync(String instanceId) This method is obsolete.
Cluster	resizeCluster(String instanceId, String clusterId, int numServeNodes) This method is obsolete.
com.google.api.core.ApiFuture<Cluster>	resizeClusterAsync(String instanceId, String clusterId, int numServeNodes) This method is obsolete.
com.google.cloud.Policy	setIamPolicy(String instanceId, com.google.cloud.Policy policy) This method is obsolete.
com.google.api.core.ApiFuture<com.google.cloud.Policy>	setIamPolicyAsync(String instanceId, com.google.cloud.Policy policy) This method is obsolete.
List<String>	testIamPermission(String instanceId, String... permissions) This method is obsolete.
com.google.api.core.ApiFuture<List<String>>	testIamPermissionAsync(String instanceId, String... permissions) This method is obsolete.
AppProfile	updateAppProfile(UpdateAppProfileRequest request) This method is obsolete.
com.google.api.core.ApiFuture<AppProfile>	updateAppProfileAsync(UpdateAppProfileRequest request) This method is obsolete.
Cluster	updateClusterAutoscalingConfig(ClusterAutoscalingConfig clusterAutoscalingConfig) This method is obsolete.
com.google.api.core.ApiFuture<Cluster>	updateClusterAutoscalingConfigAsync(ClusterAutoscalingConfig clusterAutoscalingConfig) This method is obsolete.
Instance	updateInstance(UpdateInstanceRequest request) This method is obsolete.
com.google.api.core.ApiFuture<Instance>	updateInstanceAsync(UpdateInstanceRequest request) This method is obsolete.
LogicalView	updateLogicalView(UpdateLogicalViewRequest request) This method is obsolete.
com.google.api.core.ApiFuture<LogicalView>	updateLogicalViewAsync(UpdateLogicalViewRequest request) This method is obsolete.
MaterializedView	updateMaterializedView(UpdateMaterializedViewRequest request) This method is obsolete.
com.google.api.core.ApiFuture<MaterializedView>	updateMaterializedViewAsync(UpdateMaterializedViewRequest request) This method is obsolete.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static BigtableInstanceAdminClient create(@Nonnull
                                                 String projectId)
                                          throws IOException

Constructs an instance of BigtableInstanceAdminClient with the given project ID.

Throws:

IOException

create

public static BigtableInstanceAdminClient create(@Nonnull
                                                 BigtableInstanceAdminSettings settings)
                                          throws IOException

Constructs an instance of BigtableInstanceAdminClient with the given settings.

Throws:

IOException

create

public static BigtableInstanceAdminClient create(@Nonnull
                                                 String projectId,
                                                 @Nonnull
                                                 BigtableInstanceAdminStub stub)

Constructs an instance of BigtableInstanceAdminClient with the given project ID and stub.

getProjectId

public String getProjectId()

Gets the project ID this client is associated with.

getBaseClient

public BaseBigtableInstanceAdminClient getBaseClient()

Returns the modern autogenerated client. This provides access to the newest features and proto-based methods.

close

public void close()

Closes the client and frees all resources associated with it (like thread pools).

Specified by:

close in interface AutoCloseable

createInstance

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public Instance createInstance(CreateInstanceRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.createInstanceAsync(com.google.bigtable.admin.v2.CreateInstanceRequest).

Creates a new instance and returns its representation.

Sample code:

 Instance instance = client.createInstance(
   CreateInstanceRequest.of("my-instance")
     .addCluster("my-cluster", "us-east1-c", 3, StorageType.SSD)
 );
 

See Also:

for details.

createInstanceAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Instance> createInstanceAsync(CreateInstanceRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.createInstanceAsync(com.google.bigtable.admin.v2.CreateInstanceRequest).

Asynchronously creates a new instance and returns its representation wrapped in a future.

Sample code:

 ApiFuture<Instance> instanceFuture = client.createInstanceAsync(
   CreateInstanceRequest.of("my-instance")
     .addCluster("my-cluster", "us-east1-c", 3, StorageType.SSD)
 );

 Instance instance = instanceFuture.get();
 

See Also:

for details.

updateInstance

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public Instance updateInstance(UpdateInstanceRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.partialUpdateInstanceAsync(com.google.bigtable.admin.v2.PartialUpdateInstanceRequest).

Updates a new instance and returns its representation.

Sample code:

 Instance instance = client.updateInstance(
   UpdateInstanceRequest.of("my-instance")
     .setProductionType()
 );
 

See Also:

for details.

updateInstanceAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Instance> updateInstanceAsync(UpdateInstanceRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.partialUpdateInstanceAsync(com.google.bigtable.admin.v2.PartialUpdateInstanceRequest).

Asynchronously updates a new instance and returns its representation wrapped in a future.

Sample code:

 ApiFuture<Instance> instanceFuture = client.updateInstanceAsync(
   UpdateInstanceRequest.of("my-instance")
     .setProductionType()
 );

 Instance instance = instanceFuture.get();
 

See Also:

for details.

getInstance

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public Instance getInstance(String id)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getInstance(com.google.bigtable.admin.v2.GetInstanceRequest).

Get the instance representation by ID.

Sample code:

 Instance instance = client.getInstance("my-instance");
 

getInstanceAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Instance> getInstanceAsync(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getInstance(com.google.bigtable.admin.v2.GetInstanceRequest).

Asynchronously gets the instance representation by ID wrapped in a future.

Sample code:

 ApiFuture<Instance> instanceFuture = client.getInstanceAsync("my-instance");
 Instance instance = instanceFuture.get();
 

listInstances

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public List<Instance> listInstances()

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.listInstances(com.google.bigtable.admin.v2.ListInstancesRequest).

Lists all of the instances in the current project.

This method will throw a PartialListInstancesException when any zone is unavailable. If a partial list is OK, the exception can be caught and inspected.

Sample code:

 try {
   List<Instance> instances = client.listInstances();
 } catch (PartialListInstancesException e) {
   System.out.println("The following zones are unavailable: " + e.getUnavailableZones());
   System.out.println("But the following instances are reachable: " + e.getInstances());
 }
 

listInstancesAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<List<Instance>> listInstancesAsync()

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.listInstances(com.google.bigtable.admin.v2.ListInstancesRequest).

Asynchronously lists all of the instances in the current project.

This method will throw a PartialListInstancesException when any zone is unavailable. If a partial list is OK, the exception can be caught and inspected.

Sample code:

 ApiFuture<Instance> instancesFuture = client.listInstancesAsync();

 ApiFutures.addCallback(instancesFuture, new ApiFutureCallback<List<Instance>>() {
   public void onFailure(Throwable t) {
     if (t instanceof PartialListInstancesException) {
       PartialListInstancesException partialError = (PartialListInstancesException)t;
       System.out.println("The following zones are unavailable: " + partialError.getUnavailableZones());
       System.out.println("But the following instances are reachable: " + partialError.getInstances());
     } else {
       t.printStackTrace();
     }
   }

   public void onSuccess(List<Instance> result) {
     System.out.println("Found a complete set of instances: " + result);
   }
 }, MoreExecutors.directExecutor());
 

deleteInstance

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public void deleteInstance(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteInstance(com.google.bigtable.admin.v2.DeleteInstanceRequest).

Deletes the specified instance.

Sample code:

 client.deleteInstance("my-instance");
 

deleteInstanceAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Void> deleteInstanceAsync(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteInstance(com.google.bigtable.admin.v2.DeleteInstanceRequest).

Asynchronously deletes the specified instance.

Sample code:

 ApiFuture<Void> deleteFuture = client.deleteInstanceAsync("my-instance");
 deleteFuture.get();
 

exists

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public boolean exists(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getInstance(com.google.bigtable.admin.v2.GetInstanceRequest).

Checks if the instance specified by the instance ID exists.

Sample code:

 if(client.exists("my-instance")) {
   System.out.println("Instance exists");
 }
 

existsAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Boolean> existsAsync(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getInstance(com.google.bigtable.admin.v2.GetInstanceRequest).

Asynchronously checks if the instance specified by the instance ID exists.

Sample code:

 ApiFuture<Boolean> found = client.existsAsync("my-instance");

 ApiFutures.addCallback(
  found,
  new ApiFutureCallback<Boolean>() {
    public void onSuccess(Boolean found) {
      if (found) {
        System.out.println("Instance exists");
      } else {
        System.out.println("Instance not found");
      }
    }

    public void onFailure(Throwable t) {
      t.printStackTrace();
    }
  },
  MoreExecutors.directExecutor()
 );
 

createCluster

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public Cluster createCluster(CreateClusterRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.createClusterAsync(com.google.bigtable.admin.v2.CreateClusterRequest).

Creates a new cluster in the specified instance.

Sample code:

 Cluster cluster = client.createCluster(
   CreateClusterRequest.of("my-instance", "my-new-cluster")
     .setZone("us-east1-c")
     .setServeNodes(3)
     .setStorageType(StorageType.SSD)
 );
 

createClusterAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Cluster> createClusterAsync(CreateClusterRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.createClusterAsync(com.google.bigtable.admin.v2.CreateClusterRequest).

Asynchronously creates a new cluster in the specified instance.

Sample code:

 ApiFuture<Cluster> clusterFuture = client.createClusterAsync(
   CreateClusterRequest.of("my-instance", "my-new-cluster")
     .setZone("us-east1-c")
     .setServeNodes(3)
     .setStorageType(StorageType.SSD)
 );

 Cluster cluster = clusterFuture.get();
 

getCluster

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public Cluster getCluster(String instanceId,
                                                                                                                              String clusterId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getCluster(com.google.bigtable.admin.v2.GetClusterRequest).

Gets the cluster representation by ID.

Sample code:

 Cluster cluster = client.getCluster("my-instance", "my-cluster");
 

getClusterAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Cluster> getClusterAsync(String instanceId,
                                                                                                                                                                  String clusterId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getCluster(com.google.bigtable.admin.v2.GetClusterRequest).

Asynchronously gets the cluster representation by ID.

Sample code:

 ApiFuture<Cluster> clusterFuture = client.getClusterAsync("my-instance", "my-cluster");
 Cluster cluster = clusterFuture.get();
 

listClusters

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public List<Cluster> listClusters(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.listClusters(com.google.bigtable.admin.v2.ListClustersRequest).

Lists all clusters in the specified instance.

This method will throw a PartialListClustersException when any zone is unavailable. If a partial list is OK, the exception can be caught and inspected.

Sample code:

 try {
   List<Cluster> clusters = client.listClusters("my-instance");
 } catch (PartialListClustersException e) {
   System.out.println("The following zones are unavailable: " + e.getUnavailableZones());
   System.out.println("But the following clusters are reachable: " + e.getClusters())
 }
 

listClustersAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<List<Cluster>> listClustersAsync(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.listClusters(com.google.bigtable.admin.v2.ListClustersRequest).

Asynchronously lists all clusters in the specified instance.

This method will throw a PartialListClustersException when any zone is unavailable. If a partial list is OK, the exception can be caught and inspected.

Sample code:

 ApiFuture<Cluster> clustersFuture = client.listClustersAsync("my-instance");

 ApiFutures.addCallback(clustersFuture, new ApiFutureCallback<List<Cluster>>() {
   public void onFailure(Throwable t) {
     if (t instanceof PartialListClustersException) {
       PartialListClustersException partialError = (PartialListClustersException)t;
       System.out.println("The following zones are unavailable: " + partialError.getUnavailableZones());
       System.out.println("But the following clusters are reachable: " + partialError.getClusters());
     } else {
       t.printStackTrace();
     }
   }

   public void onSuccess(List<Cluster> result) {
     System.out.println("Found a complete set of instances: " + result);
   }
 }, MoreExecutors.directExecutor());
 

resizeCluster

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public Cluster resizeCluster(String instanceId,
                                                                                                                                 String clusterId,
                                                                                                                                 int numServeNodes)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.partialUpdateClusterAsync(com.google.bigtable.admin.v2.PartialUpdateClusterRequest).

Modifies the cluster's node count for manual scaling. If autoscaling is already enabled, manual scaling will be silently ignored. If you wish to disable autoscaling and enable manual scaling, please use disableClusterAutoscaling(String, String, int) instead. Please note that only clusters that belong to a production instance can be resized.

Sample code:

 Cluster cluster = client.resizeCluster("my-instance", "my-cluster", 30);
 

resizeClusterAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Cluster> resizeClusterAsync(String instanceId,
                                                                                                                                                                     String clusterId,
                                                                                                                                                                     int numServeNodes)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.partialUpdateClusterAsync(com.google.bigtable.admin.v2.PartialUpdateClusterRequest).

Asynchronously modifies the cluster's node count for manual scaling. If autoscaling is already enabled, manual scaling will be silently ignored. If you wish to disable autoscaling and enable manual scaling, please use disableClusterAutoscaling(String, String, int) instead. Please note that only clusters that belong to a production instance can be resized.

 ApiFuture<Cluster> clusterFuture = client.resizeCluster("my-instance", "my-cluster", 30);
 Cluster cluster = clusterFuture.get();
 

updateClusterAutoscalingConfig

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public Cluster updateClusterAutoscalingConfig(@Nonnull
                                                                                                                                                  ClusterAutoscalingConfig clusterAutoscalingConfig)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.partialUpdateClusterAsync(com.google.bigtable.admin.v2.PartialUpdateClusterRequest).

Modifies the cluster's autoscaling config. This will enable autoscaling and disable manual scaling if the cluster is manually scaled. Please note that only clusters that belong to a production instance can enable autoscaling.

Sample code:

 ClusterAutoscalingConfig clusterAutoscalingConfig =
      ClusterAutoscalingConfig.of("my-instance", "my-cluster")
          .setMinNodes(1)
          .setMaxNodes(4)
          .setCpuUtilizationTargetPercent(40);
 Cluster cluster = client.updateClusterAutoscalingConfig(clusterAutoscalingConfig);
 

updateClusterAutoscalingConfigAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Cluster> updateClusterAutoscalingConfigAsync(@Nonnull
                                                                                                                                                                                      ClusterAutoscalingConfig clusterAutoscalingConfig)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.partialUpdateClusterAsync(com.google.bigtable.admin.v2.PartialUpdateClusterRequest).

Asynchronously modifies the cluster's autoscaling config. This will enable autoscaling and disable manual scaling if the cluster is manually scaled. Please note that only clusters that belong to a production instance can enable autoscaling.

Sample code:

 ClusterAutoscalingConfig clusterAutoscalingConfig =
      ClusterAutoscalingConfig.of(targetInstanceId, targetClusterId)
          .setMinNodes(1)
          .setMaxNodes(4)
          .setCpuUtilizationTargetPercent(40);

  ApiFuture<Cluster> clusterApiFuture = client.updateClusterAutoscalingConfigAsync(clusterAutoscalingConfig);
  Cluster cluster = clusterApiFuture.get();
 

disableClusterAutoscaling

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public Cluster disableClusterAutoscaling(String instanceId,
                                                                                                                                             String clusterId,
                                                                                                                                             int staticSize)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.partialUpdateClusterAsync(com.google.bigtable.admin.v2.PartialUpdateClusterRequest).

Disables autoscaling and enables manual scaling by setting a static node count for the cluster. Please note that only clusters that belong to a production instance can be resized.

Sample code:

 Cluster cluster = client.disableClusterAutoscaling("my-instance", "my-cluster", 3);
 

disableClusterAutoscalingAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Cluster> disableClusterAutoscalingAsync(String instanceId,
                                                                                                                                                                                 String clusterId,
                                                                                                                                                                                 int staticSize)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.partialUpdateClusterAsync(com.google.bigtable.admin.v2.PartialUpdateClusterRequest).

Asynchronously disables autoscaling and enables manual scaling by setting a static node count for the cluster. Please note that only clusters that belong to a production instance can be resized.

Sample code:

 ApiFuture<Cluster> clusterApiFuture = client.disableClusterAutoscalingAsync("my-instance", "my-cluster", 3);
 Cluster cluster = clusterApiFuture.get();
 

deleteCluster

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public void deleteCluster(String instanceId,
                                                                                                                              String clusterId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteCluster(com.google.bigtable.admin.v2.DeleteClusterRequest).

Deletes the specified cluster. Please note that an instance must have at least 1 cluster. To remove the last cluster, please use deleteInstance(String).

Sample code:

 client.deleteCluster("my-instance", "my-cluster");
 

deleteClusterAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Void> deleteClusterAsync(String instanceId,
                                                                                                                                                                  String clusterId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteCluster(com.google.bigtable.admin.v2.DeleteClusterRequest).

Asynchronously deletes the specified cluster. Please note that an instance must have at least 1 cluster. To remove the last cluster, please use deleteInstanceAsync(String).

Sample code:

 ApiFuture<Void> future = client.deleteClusterAsync("my-instance", "my-cluster");
 future.get();
 

createAppProfile

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public AppProfile createAppProfile(CreateAppProfileRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.createAppProfile(com.google.bigtable.admin.v2.CreateAppProfileRequest).

Creates a new app profile.

Sample code:

 AppProfile appProfile = client.createAppProfile(
   CreateAppProfileRequest.of("my-instance", "my-new-app-profile")
     .setRoutingPolicy(SingleClusterRoutingPolicy.of("my-cluster"))
 );
 

See Also:

CreateAppProfileRequest

createAppProfileAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<AppProfile> createAppProfileAsync(CreateAppProfileRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.createAppProfile(com.google.bigtable.admin.v2.CreateAppProfileRequest).

Asynchronously creates a new app profile.

Sample code:

 ApiFuture<AppProfile> appProfileFuture = client.createAppProfileAsync(
   CreateAppProfileRequest.of("my-instance", "my-new-app-profile")
     .setRoutingPolicy(SingleClusterRoutingPolicy.of("my-cluster"))
 );

 AppProfile appProfile = appProfileFuture.get();
 

See Also:

CreateAppProfileRequest

getAppProfile

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public AppProfile getAppProfile(String instanceId,
                                                                                                                                    String appProfileId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getAppProfile(com.google.bigtable.admin.v2.GetAppProfileRequest).

Gets the app profile by ID.

Sample code:

 AppProfile appProfile = client.getAppProfile("my-instance", "my-app-profile");
 

See Also:

AppProfile

getAppProfileAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<AppProfile> getAppProfileAsync(String instanceId,
                                                                                                                                                                        String appProfileId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getAppProfile(com.google.bigtable.admin.v2.GetAppProfileRequest).

Asynchronously gets the app profile by ID.

Sample code:

 ApiFuture<AppProfile> appProfileFuture = client.getAppProfileAsync("my-instance", "my-app-profile");

 AppProfile appProfile = appProfileFuture.get();
 

See Also:

AppProfile

listAppProfiles

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public List<AppProfile> listAppProfiles(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.listAppProfiles(com.google.bigtable.admin.v2.ListAppProfilesRequest).

Lists all app profiles of the specified instance.

Sample code:

 List<AppProfile> appProfiles = client.listAppProfiles("my-instance");
 

See Also:

AppProfile

listAppProfilesAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<List<AppProfile>> listAppProfilesAsync(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.listAppProfiles(com.google.bigtable.admin.v2.ListAppProfilesRequest).

Asynchronously lists all app profiles of the specified instance.

Sample code:

 ApiFuture<List<AppProfile>> appProfilesFuture = client.listAppProfilesAsync("my-instance");

 List<AppProfile> appProfiles = appProfileFuture.get();
 

See Also:

AppProfile

updateAppProfile

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public AppProfile updateAppProfile(UpdateAppProfileRequest request)

This method is obsolete. For the recommended proto-based approach, please see com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminClient#updateAppProfile(com.google.bigtable.admin.v2.UpdateAppProfileRequest).

Updates an existing app profile.

Sample code:

 AppProfile existingAppProfile = client.getAppProfile("my-instance", "my-app-profile");

 AppProfile updatedAppProfile = client.updateAppProfile(
   UpdateAppProfileRequest.of(existingAppProfile)
     .setRoutingPolicy(SingleClusterRoutingPolicy.of("my-cluster"))
 );
 

See Also:

UpdateAppProfileRequest

updateAppProfileAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<AppProfile> updateAppProfileAsync(UpdateAppProfileRequest request)

This method is obsolete. For the recommended proto-based approach, please see com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminClient#updateAppProfile(com.google.bigtable.admin.v2.UpdateAppProfileRequest).

Asynchronously updates an existing app profile.

Sample code:

 ApiFuture<AppProfile> existingAppProfileFuture = client.getAppProfileAsync("my-instance", "my-app-profile");

 ApiFuture<AppProfile> updatedAppProfileFuture = ApiFutures.transformAsync(
   existingAppProfileFuture,
   new ApiAsyncFunction<AppProfile, AppProfile>() {
     public ApiFuture<AppProfile> apply(AppProfile existingAppProfile) {
       return client.updateAppProfileAsync(
         UpdateAppProfileRequest.of(existingAppProfile)
           .setRoutingPolicy(SingleClusterRoutingPolicy.of("my-other-cluster"))
       );
     }
   },
   MoreExecutors.directExecutor()
 );

 ApiFuture<AppProfile> appProfile = updatedAppProfileFuture.get();
 

See Also:

UpdateAppProfileRequest

deleteAppProfile

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public void deleteAppProfile(String instanceId,
                                                                                                                                 String appProfileId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest).

Deletes the specified app profile.

Sample code:

 client.deleteAppProfile("my-instance", "my-app-profile");
 

deleteAppProfileAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Void> deleteAppProfileAsync(String instanceId,
                                                                                                                                                                     String appProfileId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest).

Asynchronously deletes the specified app profile.

Sample code:

 ApiFuture<Void> deleteFuture = client.deleteAppProfileAsync("my-instance", "my-app-profile");

 deleteFuture.get();
 

deleteAppProfile

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public void deleteAppProfile(String instanceId,
                                                                                                                                 String appProfileId,
                                                                                                                                 boolean forceDelete)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest).

Deletes the specified app profile with an option to force deletion.

Sample code:

 client.deleteAppProfile("my-instance", "my-app-profile", true);
 

deleteAppProfileAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Void> deleteAppProfileAsync(String instanceId,
                                                                                                                                                                     String appProfileId,
                                                                                                                                                                     boolean forceDelete)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest).

Asynchronously deletes the specified app profile with an option to force deletion.

Sample code:

 ApiFuture<Void> deleteFuture = client.deleteAppProfileAsync("my-instance", "my-app-profile", true);

 deleteFuture.get();
 

getIamPolicy

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.cloud.Policy getIamPolicy(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getIamPolicy(com.google.iam.v1.GetIamPolicyRequest).

Gets the IAM access control policy for the specified instance.

Sample code:

 Policy policy = client.getIamPolicy("my-instance");
 for(Map.Entry<Role, Set<Identity>> entry : policy.getBindings().entrySet()) {
   System.out.printf("Role: %s Identities: %s\n", entry.getKey(), entry.getValue());
 }
 

See Also:

Instance-level IAM management

getIamPolicyAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<com.google.cloud.Policy> getIamPolicyAsync(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getIamPolicy(com.google.iam.v1.GetIamPolicyRequest).

Asynchronously gets the IAM access control policy for the specified instance.

Sample code:

 ApiFuture<Policy> policyFuture = client.getIamPolicyAsync("my-instance");

 ApiFutures.addCallback(policyFuture,
   new ApiFutureCallback<Policy>() {
     public void onSuccess(Policy policy) {
       for (Entry<Role, Set<Identity>> entry : policy.getBindings().entrySet()) {
         System.out.printf("Role: %s Identities: %s\n", entry.getKey(), entry.getValue());
       }
     }

     public void onFailure(Throwable t) {
       t.printStackTrace();
     }
   },
   MoreExecutors.directExecutor());
 

See Also:

Instance-level IAM management

setIamPolicy

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.cloud.Policy setIamPolicy(String instanceId,
                                                                                                                                                com.google.cloud.Policy policy)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.setIamPolicy(com.google.iam.v1.SetIamPolicyRequest).

Replaces the IAM policy associated with the specified instance.

Sample code:

 Policy newPolicy = client.setIamPolicy("my-instance",
   Policy.newBuilder()
     .addIdentity(Role.of("bigtable.user"), Identity.user("someone@example.com"))
     .addIdentity(Role.of("bigtable.admin"), Identity.group("admins@example.com"))
     .build());
 

See Also:

Instance-level IAM management

setIamPolicyAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<com.google.cloud.Policy> setIamPolicyAsync(String instanceId,
                                                                                                                                                                                    com.google.cloud.Policy policy)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.setIamPolicy(com.google.iam.v1.SetIamPolicyRequest).

Asynchronously replaces the IAM policy associated with the specified instance.

Sample code:

 ApiFuture<Policy> newPolicyFuture = client.setIamPolicyAsync("my-instance",
   Policy.newBuilder()
     .addIdentity(Role.of("bigtable.user"), Identity.user("someone@example.com"))
     .addIdentity(Role.of("bigtable.admin"), Identity.group("admins@example.com"))
     .build());

 ApiFutures.addCallback(policyFuture,
   new ApiFutureCallback<Policy>() {
     public void onSuccess(Policy policy) {
       for (Entry<Role, Set<Identity>> entry : policy.getBindings().entrySet()) {
         System.out.printf("Role: %s Identities: %s\n", entry.getKey(), entry.getValue());
       }
     }

     public void onFailure(Throwable t) {
       t.printStackTrace();
     }
   },
   MoreExecutors.directExecutor());
 

See Also:

Instance-level IAM management

testIamPermission

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public List<String> testIamPermission(String instanceId,
                                                                                                                                          String... permissions)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest).

Tests whether the caller has the given permissions for the specified instance. Returns a subset of the specified permissions that the caller has.

Sample code:

 List<String> grantedPermissions = client.testIamPermission("my-instance",
   "bigtable.tables.readRows", "bigtable.tables.mutateRows");
 

System.out.println("Has read access: " + grantedPermissions.contains("bigtable.tables.readRows")); System.out.println("Has write access: " + grantedPermissions.contains("bigtable.tables.mutateRows"));

See Also:

Cloud Bigtable permissions

testIamPermissionAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<List<String>> testIamPermissionAsync(String instanceId,
                                                                                                                                                                              String... permissions)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest).

Asynchronously tests whether the caller has the given permissions for the specified instance. Returns a subset of the specified permissions that the caller has.

Sample code:

 ApiFuture<List<String>> grantedPermissionsFuture = client.testIamPermissionAsync("my-instance",
   "bigtable.tables.readRows", "bigtable.tables.mutateRows");

 ApiFutures.addCallback(grantedPermissionsFuture,
   new ApiFutureCallback<List<String>>() {
     public void onSuccess(List<String> grantedPermissions) {
       System.out.println("Has read access: " + grantedPermissions.contains("bigtable.tables.readRows"));
       System.out.println("Has write access: " + grantedPermissions.contains("bigtable.tables.mutateRows"));
     }

     public void onFailure(Throwable t) {
       t.printStackTrace();
     }
   },
   MoreExecutors.directExecutor());
 

See Also:

Cloud Bigtable permissions

createMaterializedView

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public MaterializedView createMaterializedView(CreateMaterializedViewRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.createMaterializedViewAsync(com.google.bigtable.admin.v2.CreateMaterializedViewRequest).

Creates a new materialized view.

Sample code:

 MaterializedView materializedView = client.createMaterializedView(
   CreateMaterializedViewRequest.of("my-instance", "my-new-materialized-view")
     .setQuery(query)
 );
 

See Also:

CreateMaterializedViewRequest

createMaterializedViewAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<MaterializedView> createMaterializedViewAsync(CreateMaterializedViewRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.createMaterializedViewAsync(com.google.bigtable.admin.v2.CreateMaterializedViewRequest).

Asynchronously creates a new materialized view.

Sample code:

 ApiFuture<MaterializedView> materializedViewFuture = client.createMaterializedViewAsync(
   CreateMaterializedViewRequest.of("my-instance", "my-new-materialized-view")
     .setQuery(query)
 );

 MaterializedView materializedView = materializedViewFuture.get();
 

See Also:

CreateMaterializedViewRequest

getMaterializedView

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public MaterializedView getMaterializedView(String instanceId,
                                                                                                                                                String materializedViewId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getMaterializedView(com.google.bigtable.admin.v2.GetMaterializedViewRequest).

Gets the materialized view by ID.

Sample code:

 MaterializedView materializedView = client.getMaterializedView("my-instance", "my-materialized-view");
 

See Also:

MaterializedView

getMaterializedViewAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<MaterializedView> getMaterializedViewAsync(String instanceId,
                                                                                                                                                                                    String materializedViewId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getMaterializedView(com.google.bigtable.admin.v2.GetMaterializedViewRequest).

Asynchronously gets the materialized view by ID.

Sample code:

 ApiFuture<MaterializedView> materializedViewFuture = client.getMaterializedViewAsync("my-instance", "my-materialized-view");

 MaterializedView materializedView = materializedViewFuture.get();
 

See Also:

MaterializedView

listMaterializedViews

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public List<MaterializedView> listMaterializedViews(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.listMaterializedViews(com.google.bigtable.admin.v2.ListMaterializedViewsRequest).

Lists all materialized views of the specified instance.

Sample code:

 List<MaterializedView> materializedViews = client.listMaterializedViews("my-instance");
 

See Also:

MaterializedView

listMaterializedViewsAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<List<MaterializedView>> listMaterializedViewsAsync(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.listMaterializedViews(com.google.bigtable.admin.v2.ListMaterializedViewsRequest).

Asynchronously lists all materialized views of the specified instance.

Sample code:

 ApiFuture<List<MaterializedView>> materializedViewsFuture = client.listMaterializedViewsAsync("my-instance");

 List<MaterializedView> materializedViews = materializedViewFuture.get();
 

See Also:

MaterializedView

updateMaterializedView

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public MaterializedView updateMaterializedView(UpdateMaterializedViewRequest request)

This method is obsolete. For the recommended proto-based approach, please see com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminClient#updateMaterializedView(com.google.bigtable.admin.v2.UpdateMaterializedViewRequest).

Updates an existing materialized view.

Sample code:

 MaterializedView existingMaterializedView = client.getMaterializedView("my-instance", "my-materialized-view");

 MaterializedView updatedMaterializedView = client.updateMaterializedView(
   UpdateMaterializedViewRequest.of(existingMaterializedView)
     .setDeletionProtection(false)
 );
 

See Also:

UpdateMaterializedViewRequest

updateMaterializedViewAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<MaterializedView> updateMaterializedViewAsync(UpdateMaterializedViewRequest request)

This method is obsolete. For the recommended proto-based approach, please see com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminClient#updateMaterializedView(com.google.bigtable.admin.v2.UpdateMaterializedViewRequest).

Asynchronously updates an existing materialized view.

Sample code:

 ApiFuture<MaterializedView> existingMaterializedViewFuture = client.getMaterializedViewAsync("my-instance", "my-materialized-view");

 ApiFuture<MaterializedView> updatedMaterializedViewFuture = ApiFutures.transformAsync(
   existingMaterializedViewFuture,
   new ApiAsyncFunction<MaterializedView, MaterializedView>() {
     public ApiFuture<MaterializedView> apply(MaterializedView existingMaterializedView) {
       return client.updateMaterializedViewAsync(
         UpdateMaterializedViewRequest.of(existingMaterializedView)
           .setDeletionProtection(false)
       );
     }
   },
   MoreExecutors.directExecutor()
 );

 ApiFuture<MaterializedView> materializedView = updatedMaterializedViewFuture.get();
 

See Also:

UpdateMaterializedViewRequest

deleteMaterializedView

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public void deleteMaterializedView(String instanceId,
                                                                                                                                       String materializedViewId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteMaterializedView(com.google.bigtable.admin.v2.DeleteMaterializedViewRequest).

Deletes the specified materialized view.

Sample code:

 client.deleteMaterializedView("my-instance", "my-materialized-view");
 

deleteMaterializedViewAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Void> deleteMaterializedViewAsync(String instanceId,
                                                                                                                                                                           String materializedViewId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteMaterializedView(com.google.bigtable.admin.v2.DeleteMaterializedViewRequest).

Asynchronously deletes the specified materialized view.

Sample code:

 ApiFuture<Void> deleteFuture = client.deleteMaterializedViewAsync("my-instance", "my-materialized-view");

 deleteFuture.get();
 

createLogicalView

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public LogicalView createLogicalView(CreateLogicalViewRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.createLogicalViewAsync(com.google.bigtable.admin.v2.CreateLogicalViewRequest).

Creates a new logical view.

Sample code:

 LogicalView logicalView = client.createLogicalView(
   CreateLogicalViewRequest.of("my-instance", "my-new-logical-view")
     .setQuery(query)
 );
 

See Also:

CreateLogicalViewRequest

createLogicalViewAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<LogicalView> createLogicalViewAsync(CreateLogicalViewRequest request)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.createLogicalViewAsync(com.google.bigtable.admin.v2.CreateLogicalViewRequest).

Asynchronously creates a new logical view.

Sample code:

 ApiFuture<LogicalView> logicalViewFuture = client.createLogicalViewAsync(
   CreateLogicalViewRequest.of("my-instance", "my-new-logical-view")
     .setQuery(query)
 );

 LogicalView logicalView = logicalViewFuture.get();
 

See Also:

CreateLogicalViewRequest

getLogicalView

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public LogicalView getLogicalView(String instanceId,
                                                                                                                                      String logicalViewId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getLogicalView(com.google.bigtable.admin.v2.GetLogicalViewRequest).

Gets the logical view by ID.

Sample code:

 LogicalView logicalView = client.getLogicalView("my-instance", "my-logical-view");
 

See Also:

LogicalView

getLogicalViewAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<LogicalView> getLogicalViewAsync(String instanceId,
                                                                                                                                                                          String logicalViewId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.getLogicalView(com.google.bigtable.admin.v2.GetLogicalViewRequest).

Asynchronously gets the logical view by ID.

Sample code:

 ApiFuture<LogicalView> logicalViewFuture = client.getLogicalViewAsync("my-instance", "my-logical-view");

 LogicalView logicalView = logicalViewFuture.get();
 

See Also:

LogicalView

listLogicalViews

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public List<LogicalView> listLogicalViews(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.listLogicalViews(com.google.bigtable.admin.v2.ListLogicalViewsRequest).

Lists all logical views of the specified instance.

Sample code:

 List<LogicalView> logicalViews = client.listLogicalViews("my-instance");
 

See Also:

LogicalView

listLogicalViewsAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<List<LogicalView>> listLogicalViewsAsync(String instanceId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.listLogicalViews(com.google.bigtable.admin.v2.ListLogicalViewsRequest).

Asynchronously lists all logical views of the specified instance.

Sample code:

 ApiFuture<List<LogicalView>> logicalViewsFuture = client.listLogicalViewsAsync("my-instance");

 List<LogicalView> logicalViews = logicalViewFuture.get();
 

See Also:

LogicalView

updateLogicalView

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public LogicalView updateLogicalView(UpdateLogicalViewRequest request)

This method is obsolete. For the recommended proto-based approach, please see com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminClient#updateLogicalView(com.google.bigtable.admin.v2.UpdateLogicalViewRequest).

Updates an existing logical view.

Sample code:

 LogicalView existingLogicalView = client.getLogicalView("my-instance", "my-logical-view");

 LogicalView updatedLogicalView = client.updateLogicalView(
   UpdateLogicalViewRequest.of(existingLogicalView)
     .setQuery(query)
 );
 

See Also:

UpdateLogicalViewRequest

updateLogicalViewAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<LogicalView> updateLogicalViewAsync(UpdateLogicalViewRequest request)

This method is obsolete. For the recommended proto-based approach, please see com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminClient#updateLogicalView(com.google.bigtable.admin.v2.UpdateLogicalViewRequest).

Asynchronously updates an existing logical view.

Sample code:

 ApiFuture<LogicalView> existingLogicalViewFuture = client.getLogicalViewAsync("my-instance", "my-logical-view");

 ApiFuture<LogicalView> updatedLogicalViewFuture = ApiFutures.transformAsync(
   existingLogicalViewFuture,
   new ApiAsyncFunction<LogicalView, LogicalView>() {
     public ApiFuture<LogicalView> apply(LogicalView existingLogicalView) {
       return client.updateLogicalViewAsync(
         UpdateLogicalViewRequest.of(existingLogicalView)
           .setQuery(query)
       );
     }
   },
   MoreExecutors.directExecutor()
 );

 ApiFuture<LogicalView> logicalView = updatedLogicalViewFuture.get();
 

See Also:

UpdateLogicalViewRequest

deleteLogicalView

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public void deleteLogicalView(String instanceId,
                                                                                                                                  String logicalViewId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteLogicalView(com.google.bigtable.admin.v2.DeleteLogicalViewRequest).

Deletes the specified logical view.

Sample code:

 client.deleteLogicalView("my-instance", "my-logical-view");
 

deleteLogicalViewAsync

@ObsoleteApi(value="Use getBaseClient() to access the auto-generated proto-based methods instead.")
public com.google.api.core.ApiFuture<Void> deleteLogicalViewAsync(String instanceId,
                                                                                                                                                                      String logicalViewId)

This method is obsolete. For the recommended proto-based approach, please see BaseBigtableInstanceAdminClient.deleteLogicalView(com.google.bigtable.admin.v2.DeleteLogicalViewRequest).

Asynchronously deletes the specified logical view.

Sample code:

 ApiFuture<Void> deleteFuture = client.deleteLogicalViewAsync("my-instance", "my-logical-view");

 deleteFuture.get();