Class BaseBigtableInstanceAdminClient (2.77.0)

GitHub RepositoryProduct Reference

Service Description: Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
   Instance response = baseBigtableInstanceAdminClient.getInstance(name);
 }
 

Note: close() needs to be called on the BaseBigtableInstanceAdminClient 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

CreateInstance

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createInstanceAsync(CreateInstanceRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createInstanceAsync(ProjectName parent, String instanceId, Instance instance, Map<String, Cluster> clusters)

  • createInstanceAsync(String parent, String instanceId, Instance instance, Map<String, Cluster> clusters)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createInstanceOperationCallable()

  • createInstanceCallable()

GetInstance

Gets information about an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getInstance(GetInstanceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getInstance(InstanceName name)

  • getInstance(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.

  • getInstanceCallable()

ListInstances

Lists information about instances in a project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listInstances(ListInstancesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listInstances(ProjectName parent)

  • listInstances(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.

  • listInstancesCallable()

UpdateInstance

Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateInstance(Instance request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateInstanceCallable()

PartialUpdateInstance

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • partialUpdateInstanceAsync(PartialUpdateInstanceRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • partialUpdateInstanceAsync(Instance instance, 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.

  • partialUpdateInstanceOperationCallable()

  • partialUpdateInstanceCallable()

DeleteInstance

Delete an instance from a project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteInstance(DeleteInstanceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteInstance(InstanceName name)

  • deleteInstance(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.

  • deleteInstanceCallable()

CreateCluster

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createClusterAsync(CreateClusterRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createClusterAsync(InstanceName parent, String clusterId, Cluster cluster)

  • createClusterAsync(String parent, String clusterId, Cluster cluster)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createClusterOperationCallable()

  • createClusterCallable()

GetCluster

Gets information about a cluster.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getCluster(GetClusterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getCluster(ClusterName name)

  • getCluster(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.

  • getClusterCallable()

ListClusters

Lists information about clusters in an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listClusters(ListClustersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listClusters(InstanceName parent)

  • listClusters(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.

  • listClustersCallable()

UpdateCluster

Updates a cluster within an instance.

Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateClusterAsync(Cluster request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateClusterOperationCallable()

  • updateClusterCallable()

PartialUpdateCluster

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • partialUpdateClusterAsync(PartialUpdateClusterRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • partialUpdateClusterAsync(Cluster cluster, 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.

  • partialUpdateClusterOperationCallable()

  • partialUpdateClusterCallable()

DeleteCluster

Deletes a cluster from an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteCluster(DeleteClusterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteCluster(ClusterName name)

  • deleteCluster(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.

  • deleteClusterCallable()

CreateAppProfile

Creates an app profile within an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAppProfile(CreateAppProfileRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createAppProfile(InstanceName parent, String appProfileId, AppProfile appProfile)

  • createAppProfile(String parent, String appProfileId, AppProfile appProfile)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAppProfileCallable()

GetAppProfile

Gets information about an app profile.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAppProfile(GetAppProfileRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAppProfile(AppProfileName name)

  • getAppProfile(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.

  • getAppProfileCallable()

ListAppProfiles

Lists information about app profiles in an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAppProfiles(ListAppProfilesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAppProfiles(InstanceName parent)

  • listAppProfiles(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.

  • listAppProfilesPagedCallable()

  • listAppProfilesCallable()

UpdateAppProfile

Updates an app profile within an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAppProfileAsync(UpdateAppProfileRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateAppProfileAsync(AppProfile appProfile, 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.

  • updateAppProfileOperationCallable()

  • updateAppProfileCallable()

DeleteAppProfile

Deletes an app profile from an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAppProfile(DeleteAppProfileRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteAppProfile(AppProfileName name)

  • deleteAppProfile(String name)

  • deleteAppProfile(AppProfileName name, boolean ignoreWarnings)

  • deleteAppProfile(String name, boolean ignoreWarnings)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAppProfileCallable()

GetIamPolicy

Gets the access control policy for an instance resource. Returns an empty policy if an instance 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 an instance 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 instance 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()

ListHotTablets

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listHotTablets(ListHotTabletsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listHotTablets(ClusterName parent)

  • listHotTablets(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.

  • listHotTabletsPagedCallable()

  • listHotTabletsCallable()

CreateLogicalView

Creates a logical view within an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createLogicalViewAsync(CreateLogicalViewRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createLogicalViewAsync(InstanceName parent, LogicalView logicalView, String logicalViewId)

  • createLogicalViewAsync(String parent, LogicalView logicalView, String logicalViewId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createLogicalViewOperationCallable()

  • createLogicalViewCallable()

GetLogicalView

Gets information about a logical view.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLogicalView(GetLogicalViewRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getLogicalView(LogicalViewName name)

  • getLogicalView(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.

  • getLogicalViewCallable()

ListLogicalViews

Lists information about logical views in an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLogicalViews(ListLogicalViewsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listLogicalViews(InstanceName parent)

  • listLogicalViews(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.

  • listLogicalViewsPagedCallable()

  • listLogicalViewsCallable()

UpdateLogicalView

Updates a logical view within an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateLogicalViewAsync(UpdateLogicalViewRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateLogicalViewAsync(LogicalView logicalView, 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.

  • updateLogicalViewOperationCallable()

  • updateLogicalViewCallable()

DeleteLogicalView

Deletes a logical view from an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteLogicalView(DeleteLogicalViewRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteLogicalView(LogicalViewName name)

  • deleteLogicalView(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.

  • deleteLogicalViewCallable()

CreateMaterializedView

Creates a materialized view within an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createMaterializedViewAsync(CreateMaterializedViewRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createMaterializedViewAsync(InstanceName parent, MaterializedView materializedView, String materializedViewId)

  • createMaterializedViewAsync(String parent, MaterializedView materializedView, String materializedViewId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createMaterializedViewOperationCallable()

  • createMaterializedViewCallable()

GetMaterializedView

Gets information about a materialized view.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getMaterializedView(GetMaterializedViewRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getMaterializedView(MaterializedViewName name)

  • getMaterializedView(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.

  • getMaterializedViewCallable()

ListMaterializedViews

Lists information about materialized views in an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listMaterializedViews(ListMaterializedViewsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listMaterializedViews(InstanceName parent)

  • listMaterializedViews(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.

  • listMaterializedViewsPagedCallable()

  • listMaterializedViewsCallable()

UpdateMaterializedView

Updates a materialized view within an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateMaterializedViewAsync(UpdateMaterializedViewRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateMaterializedViewAsync(MaterializedView materializedView, 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.

  • updateMaterializedViewOperationCallable()

  • updateMaterializedViewCallable()

DeleteMaterializedView

Deletes a materialized view from an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteMaterializedView(DeleteMaterializedViewRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteMaterializedView(MaterializedViewName name)

  • deleteMaterializedView(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.

  • deleteMaterializedViewCallable()

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 BaseBigtableInstanceAdminSettings 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
 BaseBigtableInstanceAdminSettings baseBigtableInstanceAdminSettings =
     BaseBigtableInstanceAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create(baseBigtableInstanceAdminSettings);
 

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
 BaseBigtableInstanceAdminSettings baseBigtableInstanceAdminSettings =
     BaseBigtableInstanceAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create(baseBigtableInstanceAdminSettings);
 

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

Inheritance

java.lang.Object > BaseBigtableInstanceAdminClient

Static Methods

create()

public static final BaseBigtableInstanceAdminClient create()

Constructs an instance of BaseBigtableInstanceAdminClient with default settings.

Returns
Type Description
BaseBigtableInstanceAdminClient
Exceptions
Type Description
IOException

create(BaseBigtableInstanceAdminSettings settings)

public static final BaseBigtableInstanceAdminClient create(BaseBigtableInstanceAdminSettings settings)

Constructs an instance of BaseBigtableInstanceAdminClient, 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 BaseBigtableInstanceAdminSettings
Returns
Type Description
BaseBigtableInstanceAdminClient
Exceptions
Type Description
IOException

create(BigtableInstanceAdminStub stub)

public static final BaseBigtableInstanceAdminClient create(BigtableInstanceAdminStub stub)

Constructs an instance of BaseBigtableInstanceAdminClient, using the given stub for making calls. This is for advanced usage - prefer using create(BaseBigtableInstanceAdminSettings).

Parameter
Name Description
stub BigtableInstanceAdminStub
Returns
Type Description
BaseBigtableInstanceAdminClient

Constructors

BaseBigtableInstanceAdminClient(BaseBigtableInstanceAdminSettings settings)

protected BaseBigtableInstanceAdminClient(BaseBigtableInstanceAdminSettings settings)

Constructs an instance of BaseBigtableInstanceAdminClient, 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 BaseBigtableInstanceAdminSettings

BaseBigtableInstanceAdminClient(BigtableInstanceAdminStub stub)

protected BaseBigtableInstanceAdminClient(BigtableInstanceAdminStub stub)
Parameter
Name Description
stub BigtableInstanceAdminStub

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

close()

public final void close()

createAppProfile(CreateAppProfileRequest request)

public final AppProfile createAppProfile(CreateAppProfileRequest request)

Creates an app profile within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateAppProfileRequest request =
       CreateAppProfileRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setAppProfileId("appProfileId704923523")
           .setAppProfile(AppProfile.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   AppProfile response = baseBigtableInstanceAdminClient.createAppProfile(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.CreateAppProfileRequest

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

Returns
Type Description
com.google.bigtable.admin.v2.AppProfile

createAppProfile(InstanceName parent, String appProfileId, AppProfile appProfile)

public final AppProfile createAppProfile(InstanceName parent, String appProfileId, AppProfile appProfile)

Creates an app profile within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String appProfileId = "appProfileId704923523";
   AppProfile appProfile = AppProfile.newBuilder().build();
   AppProfile response =
       baseBigtableInstanceAdminClient.createAppProfile(parent, appProfileId, appProfile);
 }
 
Parameters
Name Description
parent com.google.bigtable.admin.v2.InstanceName

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

appProfileId String

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

appProfile com.google.bigtable.admin.v2.AppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

Returns
Type Description
com.google.bigtable.admin.v2.AppProfile

createAppProfile(String parent, String appProfileId, AppProfile appProfile)

public final AppProfile createAppProfile(String parent, String appProfileId, AppProfile appProfile)

Creates an app profile within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   String appProfileId = "appProfileId704923523";
   AppProfile appProfile = AppProfile.newBuilder().build();
   AppProfile response =
       baseBigtableInstanceAdminClient.createAppProfile(parent, appProfileId, appProfile);
 }
 
Parameters
Name Description
parent String

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

appProfileId String

Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

appProfile com.google.bigtable.admin.v2.AppProfile

Required. The app profile to be created. Fields marked OutputOnly will be ignored.

Returns
Type Description
com.google.bigtable.admin.v2.AppProfile

createAppProfileCallable()

public final UnaryCallable<CreateAppProfileRequest,AppProfile> createAppProfileCallable()

Creates an app profile within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateAppProfileRequest request =
       CreateAppProfileRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setAppProfileId("appProfileId704923523")
           .setAppProfile(AppProfile.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   ApiFuture<AppProfile> future =
       baseBigtableInstanceAdminClient.createAppProfileCallable().futureCall(request);
   // Do something.
   AppProfile response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.CreateAppProfileRequest,com.google.bigtable.admin.v2.AppProfile>

createClusterAsync(CreateClusterRequest request)

public final OperationFuture<Cluster,CreateClusterMetadata> createClusterAsync(CreateClusterRequest request)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .build();
   Cluster response = baseBigtableInstanceAdminClient.createClusterAsync(request).get();
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.CreateClusterRequest

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

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata>

createClusterAsync(InstanceName parent, String clusterId, Cluster cluster)

public final OperationFuture<Cluster,CreateClusterMetadata> createClusterAsync(InstanceName parent, String clusterId, Cluster cluster)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   String clusterId = "clusterId561939637";
   Cluster cluster = Cluster.newBuilder().build();
   Cluster response =
       baseBigtableInstanceAdminClient.createClusterAsync(parent, clusterId, cluster).get();
 }
 
Parameters
Name Description
parent com.google.bigtable.admin.v2.InstanceName

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

clusterId String

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

cluster com.google.bigtable.admin.v2.Cluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata>

createClusterAsync(String parent, String clusterId, Cluster cluster)

public final OperationFuture<Cluster,CreateClusterMetadata> createClusterAsync(String parent, String clusterId, Cluster cluster)

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   String clusterId = "clusterId561939637";
   Cluster cluster = Cluster.newBuilder().build();
   Cluster response =
       baseBigtableInstanceAdminClient.createClusterAsync(parent, clusterId, cluster).get();
 }
 
Parameters
Name Description
parent String

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

clusterId String

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

cluster com.google.bigtable.admin.v2.Cluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata>

createClusterCallable()

public final UnaryCallable<CreateClusterRequest,Operation> createClusterCallable()

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableInstanceAdminClient.createClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.CreateClusterRequest,Operation>

createClusterOperationCallable()

public final OperationCallable<CreateClusterRequest,Cluster,CreateClusterMetadata> createClusterOperationCallable()

Creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .build();
   OperationFuture<Cluster, CreateClusterMetadata> future =
       baseBigtableInstanceAdminClient.createClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
 
Returns
Type Description
OperationCallable<com.google.bigtable.admin.v2.CreateClusterRequest,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata>

createInstanceAsync(CreateInstanceRequest request)

public final OperationFuture<Instance,CreateInstanceMetadata> createInstanceAsync(CreateInstanceRequest request)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setInstanceId("instanceId902024336")
           .setInstance(Instance.newBuilder().build())
           .putAllClusters(new HashMap<String, Cluster>())
           .build();
   Instance response = baseBigtableInstanceAdminClient.createInstanceAsync(request).get();
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.CreateInstanceRequest

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

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata>

createInstanceAsync(ProjectName parent, String instanceId, Instance instance, Map<String,Cluster> clusters)

public final OperationFuture<Instance,CreateInstanceMetadata> createInstanceAsync(ProjectName parent, String instanceId, Instance instance, Map<String,Cluster> clusters)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String instanceId = "instanceId902024336";
   Instance instance = Instance.newBuilder().build();
   Map<String, Cluster> clusters = new HashMap<>();
   Instance response =
       baseBigtableInstanceAdminClient
           .createInstanceAsync(parent, instanceId, instance, clusters)
           .get();
 }
 
Parameters
Name Description
parent com.google.bigtable.admin.v2.ProjectName

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

instanceId String

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.

instance com.google.bigtable.admin.v2.Instance

Required. The instance to create. Fields marked OutputOnly must be left blank.

clusters Map<String,com.google.bigtable.admin.v2.Cluster>

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata>

createInstanceAsync(String parent, String instanceId, Instance instance, Map<String,Cluster> clusters)

public final OperationFuture<Instance,CreateInstanceMetadata> createInstanceAsync(String parent, String instanceId, Instance instance, Map<String,Cluster> clusters)

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   String instanceId = "instanceId902024336";
   Instance instance = Instance.newBuilder().build();
   Map<String, Cluster> clusters = new HashMap<>();
   Instance response =
       baseBigtableInstanceAdminClient
           .createInstanceAsync(parent, instanceId, instance, clusters)
           .get();
 }
 
Parameters
Name Description
parent String

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

instanceId String

Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.

instance com.google.bigtable.admin.v2.Instance

Required. The instance to create. Fields marked OutputOnly must be left blank.

clusters Map<String,com.google.bigtable.admin.v2.Cluster>

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata>

createInstanceCallable()

public final UnaryCallable<CreateInstanceRequest,Operation> createInstanceCallable()

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setInstanceId("instanceId902024336")
           .setInstance(Instance.newBuilder().build())
           .putAllClusters(new HashMap<String, Cluster>())
           .build();
   ApiFuture<Operation> future =
       baseBigtableInstanceAdminClient.createInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.CreateInstanceRequest,Operation>

createInstanceOperationCallable()

public final OperationCallable<CreateInstanceRequest,Instance,CreateInstanceMetadata> createInstanceOperationCallable()

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setInstanceId("instanceId902024336")
           .setInstance(Instance.newBuilder().build())
           .putAllClusters(new HashMap<String, Cluster>())
           .build();
   OperationFuture<Instance, CreateInstanceMetadata> future =
       baseBigtableInstanceAdminClient.createInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
OperationCallable<com.google.bigtable.admin.v2.CreateInstanceRequest,com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata>

createLogicalViewAsync(CreateLogicalViewRequest request)

public final OperationFuture<LogicalView,CreateLogicalViewMetadata> createLogicalViewAsync(CreateLogicalViewRequest request)

Creates a logical view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateLogicalViewRequest request =
       CreateLogicalViewRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setLogicalViewId("logicalViewId-1408054263")
           .setLogicalView(LogicalView.newBuilder().build())
           .build();
   LogicalView response = baseBigtableInstanceAdminClient.createLogicalViewAsync(request).get();
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.CreateLogicalViewRequest

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

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.LogicalView,com.google.bigtable.admin.v2.CreateLogicalViewMetadata>

createLogicalViewAsync(InstanceName parent, LogicalView logicalView, String logicalViewId)

public final OperationFuture<LogicalView,CreateLogicalViewMetadata> createLogicalViewAsync(InstanceName parent, LogicalView logicalView, String logicalViewId)

Creates a logical view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   LogicalView logicalView = LogicalView.newBuilder().build();
   String logicalViewId = "logicalViewId-1408054263";
   LogicalView response =
       baseBigtableInstanceAdminClient
           .createLogicalViewAsync(parent, logicalView, logicalViewId)
           .get();
 }
 
Parameters
Name Description
parent com.google.bigtable.admin.v2.InstanceName

Required. The parent instance where this logical view will be created. Format: projects/{project}/instances/{instance}.

logicalView com.google.bigtable.admin.v2.LogicalView

Required. The logical view to create.

logicalViewId String

Required. The ID to use for the logical view, which will become the final component of the logical view's resource name.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.LogicalView,com.google.bigtable.admin.v2.CreateLogicalViewMetadata>

createLogicalViewAsync(String parent, LogicalView logicalView, String logicalViewId)

public final OperationFuture<LogicalView,CreateLogicalViewMetadata> createLogicalViewAsync(String parent, LogicalView logicalView, String logicalViewId)

Creates a logical view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   LogicalView logicalView = LogicalView.newBuilder().build();
   String logicalViewId = "logicalViewId-1408054263";
   LogicalView response =
       baseBigtableInstanceAdminClient
           .createLogicalViewAsync(parent, logicalView, logicalViewId)
           .get();
 }
 
Parameters
Name Description
parent String

Required. The parent instance where this logical view will be created. Format: projects/{project}/instances/{instance}.

logicalView com.google.bigtable.admin.v2.LogicalView

Required. The logical view to create.

logicalViewId String

Required. The ID to use for the logical view, which will become the final component of the logical view's resource name.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.LogicalView,com.google.bigtable.admin.v2.CreateLogicalViewMetadata>

createLogicalViewCallable()

public final UnaryCallable<CreateLogicalViewRequest,Operation> createLogicalViewCallable()

Creates a logical view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateLogicalViewRequest request =
       CreateLogicalViewRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setLogicalViewId("logicalViewId-1408054263")
           .setLogicalView(LogicalView.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableInstanceAdminClient.createLogicalViewCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.CreateLogicalViewRequest,Operation>

createLogicalViewOperationCallable()

public final OperationCallable<CreateLogicalViewRequest,LogicalView,CreateLogicalViewMetadata> createLogicalViewOperationCallable()

Creates a logical view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateLogicalViewRequest request =
       CreateLogicalViewRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setLogicalViewId("logicalViewId-1408054263")
           .setLogicalView(LogicalView.newBuilder().build())
           .build();
   OperationFuture<LogicalView, CreateLogicalViewMetadata> future =
       baseBigtableInstanceAdminClient.createLogicalViewOperationCallable().futureCall(request);
   // Do something.
   LogicalView response = future.get();
 }
 
Returns
Type Description
OperationCallable<com.google.bigtable.admin.v2.CreateLogicalViewRequest,com.google.bigtable.admin.v2.LogicalView,com.google.bigtable.admin.v2.CreateLogicalViewMetadata>

createMaterializedViewAsync(CreateMaterializedViewRequest request)

public final OperationFuture<MaterializedView,CreateMaterializedViewMetadata> createMaterializedViewAsync(CreateMaterializedViewRequest request)

Creates a materialized view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateMaterializedViewRequest request =
       CreateMaterializedViewRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setMaterializedViewId("materializedViewId682270903")
           .setMaterializedView(MaterializedView.newBuilder().build())
           .build();
   MaterializedView response =
       baseBigtableInstanceAdminClient.createMaterializedViewAsync(request).get();
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.CreateMaterializedViewRequest

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

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.MaterializedView,com.google.bigtable.admin.v2.CreateMaterializedViewMetadata>

createMaterializedViewAsync(InstanceName parent, MaterializedView materializedView, String materializedViewId)

public final OperationFuture<MaterializedView,CreateMaterializedViewMetadata> createMaterializedViewAsync(InstanceName parent, MaterializedView materializedView, String materializedViewId)

Creates a materialized view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   MaterializedView materializedView = MaterializedView.newBuilder().build();
   String materializedViewId = "materializedViewId682270903";
   MaterializedView response =
       baseBigtableInstanceAdminClient
           .createMaterializedViewAsync(parent, materializedView, materializedViewId)
           .get();
 }
 
Parameters
Name Description
parent com.google.bigtable.admin.v2.InstanceName

Required. The parent instance where this materialized view will be created. Format: projects/{project}/instances/{instance}.

materializedView com.google.bigtable.admin.v2.MaterializedView

Required. The materialized view to create.

materializedViewId String

Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.MaterializedView,com.google.bigtable.admin.v2.CreateMaterializedViewMetadata>

createMaterializedViewAsync(String parent, MaterializedView materializedView, String materializedViewId)

public final OperationFuture<MaterializedView,CreateMaterializedViewMetadata> createMaterializedViewAsync(String parent, MaterializedView materializedView, String materializedViewId)

Creates a materialized view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   MaterializedView materializedView = MaterializedView.newBuilder().build();
   String materializedViewId = "materializedViewId682270903";
   MaterializedView response =
       baseBigtableInstanceAdminClient
           .createMaterializedViewAsync(parent, materializedView, materializedViewId)
           .get();
 }
 
Parameters
Name Description
parent String

Required. The parent instance where this materialized view will be created. Format: projects/{project}/instances/{instance}.

materializedView com.google.bigtable.admin.v2.MaterializedView

Required. The materialized view to create.

materializedViewId String

Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.MaterializedView,com.google.bigtable.admin.v2.CreateMaterializedViewMetadata>

createMaterializedViewCallable()

public final UnaryCallable<CreateMaterializedViewRequest,Operation> createMaterializedViewCallable()

Creates a materialized view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateMaterializedViewRequest request =
       CreateMaterializedViewRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setMaterializedViewId("materializedViewId682270903")
           .setMaterializedView(MaterializedView.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableInstanceAdminClient.createMaterializedViewCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.CreateMaterializedViewRequest,Operation>

createMaterializedViewOperationCallable()

public final OperationCallable<CreateMaterializedViewRequest,MaterializedView,CreateMaterializedViewMetadata> createMaterializedViewOperationCallable()

Creates a materialized view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   CreateMaterializedViewRequest request =
       CreateMaterializedViewRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setMaterializedViewId("materializedViewId682270903")
           .setMaterializedView(MaterializedView.newBuilder().build())
           .build();
   OperationFuture<MaterializedView, CreateMaterializedViewMetadata> future =
       baseBigtableInstanceAdminClient
           .createMaterializedViewOperationCallable()
           .futureCall(request);
   // Do something.
   MaterializedView response = future.get();
 }
 
Returns
Type Description
OperationCallable<com.google.bigtable.admin.v2.CreateMaterializedViewRequest,com.google.bigtable.admin.v2.MaterializedView,com.google.bigtable.admin.v2.CreateMaterializedViewMetadata>

deleteAppProfile(AppProfileName name)

public final void deleteAppProfile(AppProfileName name)

Deletes an app profile from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   AppProfileName name = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
   baseBigtableInstanceAdminClient.deleteAppProfile(name);
 }
 
Parameter
Name Description
name com.google.bigtable.admin.v2.AppProfileName

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

deleteAppProfile(AppProfileName name, boolean ignoreWarnings)

public final void deleteAppProfile(AppProfileName name, boolean ignoreWarnings)

Deletes an app profile from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   AppProfileName name = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
   boolean ignoreWarnings = true;
   baseBigtableInstanceAdminClient.deleteAppProfile(name, ignoreWarnings);
 }
 
Parameters
Name Description
name com.google.bigtable.admin.v2.AppProfileName

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

ignoreWarnings boolean

Required. If true, ignore safety checks when deleting the app profile.

deleteAppProfile(DeleteAppProfileRequest request)

public final void deleteAppProfile(DeleteAppProfileRequest request)

Deletes an app profile from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   DeleteAppProfileRequest request =
       DeleteAppProfileRequest.newBuilder()
           .setName(AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString())
           .setIgnoreWarnings(true)
           .build();
   baseBigtableInstanceAdminClient.deleteAppProfile(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.DeleteAppProfileRequest

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

deleteAppProfile(String name)

public final void deleteAppProfile(String name)

Deletes an app profile from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
   baseBigtableInstanceAdminClient.deleteAppProfile(name);
 }
 
Parameter
Name Description
name String

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

deleteAppProfile(String name, boolean ignoreWarnings)

public final void deleteAppProfile(String name, boolean ignoreWarnings)

Deletes an app profile from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
   boolean ignoreWarnings = true;
   baseBigtableInstanceAdminClient.deleteAppProfile(name, ignoreWarnings);
 }
 
Parameters
Name Description
name String

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

ignoreWarnings boolean

Required. If true, ignore safety checks when deleting the app profile.

deleteAppProfileCallable()

public final UnaryCallable<DeleteAppProfileRequest,Empty> deleteAppProfileCallable()

Deletes an app profile from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   DeleteAppProfileRequest request =
       DeleteAppProfileRequest.newBuilder()
           .setName(AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString())
           .setIgnoreWarnings(true)
           .build();
   ApiFuture<Empty> future =
       baseBigtableInstanceAdminClient.deleteAppProfileCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.DeleteAppProfileRequest,Empty>

deleteCluster(ClusterName name)

public final void deleteCluster(ClusterName name)

Deletes a cluster from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   baseBigtableInstanceAdminClient.deleteCluster(name);
 }
 
Parameter
Name Description
name com.google.bigtable.admin.v2.ClusterName

Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

deleteCluster(DeleteClusterRequest request)

public final void deleteCluster(DeleteClusterRequest request)

Deletes a cluster from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .build();
   baseBigtableInstanceAdminClient.deleteCluster(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.DeleteClusterRequest

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

deleteCluster(String name)

public final void deleteCluster(String name)

Deletes a cluster from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
   baseBigtableInstanceAdminClient.deleteCluster(name);
 }
 
Parameter
Name Description
name String

Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

deleteClusterCallable()

public final UnaryCallable<DeleteClusterRequest,Empty> deleteClusterCallable()

Deletes a cluster from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .build();
   ApiFuture<Empty> future =
       baseBigtableInstanceAdminClient.deleteClusterCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.DeleteClusterRequest,Empty>

deleteInstance(DeleteInstanceRequest request)

public final void deleteInstance(DeleteInstanceRequest request)

Delete an instance from a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .build();
   baseBigtableInstanceAdminClient.deleteInstance(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.DeleteInstanceRequest

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

deleteInstance(InstanceName name)

public final void deleteInstance(InstanceName name)

Delete an instance from a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
   baseBigtableInstanceAdminClient.deleteInstance(name);
 }
 
Parameter
Name Description
name com.google.bigtable.admin.v2.InstanceName

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.

deleteInstance(String name)

public final void deleteInstance(String name)

Delete an instance from a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   baseBigtableInstanceAdminClient.deleteInstance(name);
 }
 
Parameter
Name Description
name String

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.

deleteInstanceCallable()

public final UnaryCallable<DeleteInstanceRequest,Empty> deleteInstanceCallable()

Delete an instance from a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Empty> future =
       baseBigtableInstanceAdminClient.deleteInstanceCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.DeleteInstanceRequest,Empty>

deleteLogicalView(DeleteLogicalViewRequest request)

public final void deleteLogicalView(DeleteLogicalViewRequest request)

Deletes a logical view from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   DeleteLogicalViewRequest request =
       DeleteLogicalViewRequest.newBuilder()
           .setName(LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]").toString())
           .setEtag("etag3123477")
           .build();
   baseBigtableInstanceAdminClient.deleteLogicalView(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.DeleteLogicalViewRequest

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

deleteLogicalView(LogicalViewName name)

public final void deleteLogicalView(LogicalViewName name)

Deletes a logical view from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   LogicalViewName name = LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]");
   baseBigtableInstanceAdminClient.deleteLogicalView(name);
 }
 
Parameter
Name Description
name com.google.bigtable.admin.v2.LogicalViewName

Required. The unique name of the logical view to be deleted. Format: projects/{project}/instances/{instance}/logicalViews/{logical_view}.

deleteLogicalView(String name)

public final void deleteLogicalView(String name)

Deletes a logical view from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name = LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]").toString();
   baseBigtableInstanceAdminClient.deleteLogicalView(name);
 }
 
Parameter
Name Description
name String

Required. The unique name of the logical view to be deleted. Format: projects/{project}/instances/{instance}/logicalViews/{logical_view}.

deleteLogicalViewCallable()

public final UnaryCallable<DeleteLogicalViewRequest,Empty> deleteLogicalViewCallable()

Deletes a logical view from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   DeleteLogicalViewRequest request =
       DeleteLogicalViewRequest.newBuilder()
           .setName(LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       baseBigtableInstanceAdminClient.deleteLogicalViewCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.DeleteLogicalViewRequest,Empty>

deleteMaterializedView(DeleteMaterializedViewRequest request)

public final void deleteMaterializedView(DeleteMaterializedViewRequest request)

Deletes a materialized view from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   DeleteMaterializedViewRequest request =
       DeleteMaterializedViewRequest.newBuilder()
           .setName(
               MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   baseBigtableInstanceAdminClient.deleteMaterializedView(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.DeleteMaterializedViewRequest

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

deleteMaterializedView(MaterializedViewName name)

public final void deleteMaterializedView(MaterializedViewName name)

Deletes a materialized view from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   MaterializedViewName name =
       MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]");
   baseBigtableInstanceAdminClient.deleteMaterializedView(name);
 }
 
Parameter
Name Description
name com.google.bigtable.admin.v2.MaterializedViewName

Required. The unique name of the materialized view to be deleted. Format: projects/{project}/instances/{instance}/materializedViews/{materialized_view}.

deleteMaterializedView(String name)

public final void deleteMaterializedView(String name)

Deletes a materialized view from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name =
       MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]").toString();
   baseBigtableInstanceAdminClient.deleteMaterializedView(name);
 }
 
Parameter
Name Description
name String

Required. The unique name of the materialized view to be deleted. Format: projects/{project}/instances/{instance}/materializedViews/{materialized_view}.

deleteMaterializedViewCallable()

public final UnaryCallable<DeleteMaterializedViewRequest,Empty> deleteMaterializedViewCallable()

Deletes a materialized view from an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   DeleteMaterializedViewRequest request =
       DeleteMaterializedViewRequest.newBuilder()
           .setName(
               MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       baseBigtableInstanceAdminClient.deleteMaterializedViewCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.DeleteMaterializedViewRequest,Empty>

getAppProfile(AppProfileName name)

public final AppProfile getAppProfile(AppProfileName name)

Gets information about an app profile.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   AppProfileName name = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
   AppProfile response = baseBigtableInstanceAdminClient.getAppProfile(name);
 }
 
Parameter
Name Description
name com.google.bigtable.admin.v2.AppProfileName

Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

Returns
Type Description
com.google.bigtable.admin.v2.AppProfile

getAppProfile(GetAppProfileRequest request)

public final AppProfile getAppProfile(GetAppProfileRequest request)

Gets information about an app profile.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetAppProfileRequest request =
       GetAppProfileRequest.newBuilder()
           .setName(AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString())
           .build();
   AppProfile response = baseBigtableInstanceAdminClient.getAppProfile(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.GetAppProfileRequest

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

Returns
Type Description
com.google.bigtable.admin.v2.AppProfile

getAppProfile(String name)

public final AppProfile getAppProfile(String name)

Gets information about an app profile.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
   AppProfile response = baseBigtableInstanceAdminClient.getAppProfile(name);
 }
 
Parameter
Name Description
name String

Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

Returns
Type Description
com.google.bigtable.admin.v2.AppProfile

getAppProfileCallable()

public final UnaryCallable<GetAppProfileRequest,AppProfile> getAppProfileCallable()

Gets information about an app profile.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetAppProfileRequest request =
       GetAppProfileRequest.newBuilder()
           .setName(AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString())
           .build();
   ApiFuture<AppProfile> future =
       baseBigtableInstanceAdminClient.getAppProfileCallable().futureCall(request);
   // Do something.
   AppProfile response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.GetAppProfileRequest,com.google.bigtable.admin.v2.AppProfile>

getCluster(ClusterName name)

public final Cluster getCluster(ClusterName name)

Gets information about a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   Cluster response = baseBigtableInstanceAdminClient.getCluster(name);
 }
 
Parameter
Name Description
name com.google.bigtable.admin.v2.ClusterName

Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
Type Description
com.google.bigtable.admin.v2.Cluster

getCluster(GetClusterRequest request)

public final Cluster getCluster(GetClusterRequest request)

Gets information about a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetClusterRequest request =
       GetClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .build();
   Cluster response = baseBigtableInstanceAdminClient.getCluster(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.GetClusterRequest

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

Returns
Type Description
com.google.bigtable.admin.v2.Cluster

getCluster(String name)

public final Cluster getCluster(String name)

Gets information about a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
   Cluster response = baseBigtableInstanceAdminClient.getCluster(name);
 }
 
Parameter
Name Description
name String

Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
Type Description
com.google.bigtable.admin.v2.Cluster

getClusterCallable()

public final UnaryCallable<GetClusterRequest,Cluster> getClusterCallable()

Gets information about a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetClusterRequest request =
       GetClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .build();
   ApiFuture<Cluster> future =
       baseBigtableInstanceAdminClient.getClusterCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.GetClusterRequest,com.google.bigtable.admin.v2.Cluster>

getIamPolicy(ResourceName resource)

public final Policy getIamPolicy(ResourceName resource)

Gets the access control policy for an instance resource. Returns an empty policy if an instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ResourceName resource = InstanceName.of("[PROJECT]", "[INSTANCE]");
   Policy response = baseBigtableInstanceAdminClient.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 an instance resource. Returns an empty policy if an instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = baseBigtableInstanceAdminClient.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 an instance resource. Returns an empty policy if an instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String resource = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
   Policy response = baseBigtableInstanceAdminClient.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 an instance resource. Returns an empty policy if an instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       baseBigtableInstanceAdminClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getInstance(GetInstanceRequest request)

public final Instance getInstance(GetInstanceRequest request)

Gets information about an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .build();
   Instance response = baseBigtableInstanceAdminClient.getInstance(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.GetInstanceRequest

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

Returns
Type Description
com.google.bigtable.admin.v2.Instance

getInstance(InstanceName name)

public final Instance getInstance(InstanceName name)

Gets information about an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
   Instance response = baseBigtableInstanceAdminClient.getInstance(name);
 }
 
Parameter
Name Description
name com.google.bigtable.admin.v2.InstanceName

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

Returns
Type Description
com.google.bigtable.admin.v2.Instance

getInstance(String name)

public final Instance getInstance(String name)

Gets information about an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   Instance response = baseBigtableInstanceAdminClient.getInstance(name);
 }
 
Parameter
Name Description
name String

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

Returns
Type Description
com.google.bigtable.admin.v2.Instance

getInstanceCallable()

public final UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()

Gets information about an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Instance> future =
       baseBigtableInstanceAdminClient.getInstanceCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.GetInstanceRequest,com.google.bigtable.admin.v2.Instance>

getLogicalView(GetLogicalViewRequest request)

public final LogicalView getLogicalView(GetLogicalViewRequest request)

Gets information about a logical view.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetLogicalViewRequest request =
       GetLogicalViewRequest.newBuilder()
           .setName(LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]").toString())
           .build();
   LogicalView response = baseBigtableInstanceAdminClient.getLogicalView(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.GetLogicalViewRequest

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

Returns
Type Description
com.google.bigtable.admin.v2.LogicalView

getLogicalView(LogicalViewName name)

public final LogicalView getLogicalView(LogicalViewName name)

Gets information about a logical view.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   LogicalViewName name = LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]");
   LogicalView response = baseBigtableInstanceAdminClient.getLogicalView(name);
 }
 
Parameter
Name Description
name com.google.bigtable.admin.v2.LogicalViewName

Required. The unique name of the requested logical view. Values are of the form projects/{project}/instances/{instance}/logicalViews/{logical_view}.

Returns
Type Description
com.google.bigtable.admin.v2.LogicalView

getLogicalView(String name)

public final LogicalView getLogicalView(String name)

Gets information about a logical view.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name = LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]").toString();
   LogicalView response = baseBigtableInstanceAdminClient.getLogicalView(name);
 }
 
Parameter
Name Description
name String

Required. The unique name of the requested logical view. Values are of the form projects/{project}/instances/{instance}/logicalViews/{logical_view}.

Returns
Type Description
com.google.bigtable.admin.v2.LogicalView

getLogicalViewCallable()

public final UnaryCallable<GetLogicalViewRequest,LogicalView> getLogicalViewCallable()

Gets information about a logical view.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetLogicalViewRequest request =
       GetLogicalViewRequest.newBuilder()
           .setName(LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]").toString())
           .build();
   ApiFuture<LogicalView> future =
       baseBigtableInstanceAdminClient.getLogicalViewCallable().futureCall(request);
   // Do something.
   LogicalView response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.GetLogicalViewRequest,com.google.bigtable.admin.v2.LogicalView>

getMaterializedView(GetMaterializedViewRequest request)

public final MaterializedView getMaterializedView(GetMaterializedViewRequest request)

Gets information about a materialized view.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetMaterializedViewRequest request =
       GetMaterializedViewRequest.newBuilder()
           .setName(
               MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]")
                   .toString())
           .build();
   MaterializedView response = baseBigtableInstanceAdminClient.getMaterializedView(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.GetMaterializedViewRequest

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

Returns
Type Description
com.google.bigtable.admin.v2.MaterializedView

getMaterializedView(MaterializedViewName name)

public final MaterializedView getMaterializedView(MaterializedViewName name)

Gets information about a materialized view.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   MaterializedViewName name =
       MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]");
   MaterializedView response = baseBigtableInstanceAdminClient.getMaterializedView(name);
 }
 
Parameter
Name Description
name com.google.bigtable.admin.v2.MaterializedViewName

Required. The unique name of the requested materialized view. Values are of the form projects/{project}/instances/{instance}/materializedViews/{materialized_view}.

Returns
Type Description
com.google.bigtable.admin.v2.MaterializedView

getMaterializedView(String name)

public final MaterializedView getMaterializedView(String name)

Gets information about a materialized view.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String name =
       MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]").toString();
   MaterializedView response = baseBigtableInstanceAdminClient.getMaterializedView(name);
 }
 
Parameter
Name Description
name String

Required. The unique name of the requested materialized view. Values are of the form projects/{project}/instances/{instance}/materializedViews/{materialized_view}.

Returns
Type Description
com.google.bigtable.admin.v2.MaterializedView

getMaterializedViewCallable()

public final UnaryCallable<GetMaterializedViewRequest,MaterializedView> getMaterializedViewCallable()

Gets information about a materialized view.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   GetMaterializedViewRequest request =
       GetMaterializedViewRequest.newBuilder()
           .setName(
               MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]")
                   .toString())
           .build();
   ApiFuture<MaterializedView> future =
       baseBigtableInstanceAdminClient.getMaterializedViewCallable().futureCall(request);
   // Do something.
   MaterializedView response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.GetMaterializedViewRequest,com.google.bigtable.admin.v2.MaterializedView>

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

getSettings()

public final BaseBigtableInstanceAdminSettings getSettings()
Returns
Type Description
BaseBigtableInstanceAdminSettings

getStub()

public BigtableInstanceAdminStub getStub()
Returns
Type Description
BigtableInstanceAdminStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listAppProfiles(InstanceName parent)

public final BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse listAppProfiles(InstanceName parent)

Lists information about app profiles in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   for (AppProfile element :
       baseBigtableInstanceAdminClient.listAppProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent com.google.bigtable.admin.v2.InstanceName

Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.

Returns
Type Description
BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse

listAppProfiles(ListAppProfilesRequest request)

public final BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse listAppProfiles(ListAppProfilesRequest request)

Lists information about app profiles in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListAppProfilesRequest request =
       ListAppProfilesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AppProfile element :
       baseBigtableInstanceAdminClient.listAppProfiles(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.ListAppProfilesRequest

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

Returns
Type Description
BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse

listAppProfiles(String parent)

public final BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse listAppProfiles(String parent)

Lists information about app profiles in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   for (AppProfile element :
       baseBigtableInstanceAdminClient.listAppProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.

Returns
Type Description
BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse

listAppProfilesCallable()

public final UnaryCallable<ListAppProfilesRequest,ListAppProfilesResponse> listAppProfilesCallable()

Lists information about app profiles in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListAppProfilesRequest request =
       ListAppProfilesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAppProfilesResponse response =
         baseBigtableInstanceAdminClient.listAppProfilesCallable().call(request);
     for (AppProfile element : response.getAppProfilesList()) {
       // 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.ListAppProfilesRequest,com.google.bigtable.admin.v2.ListAppProfilesResponse>

listAppProfilesPagedCallable()

public final UnaryCallable<ListAppProfilesRequest,BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse> listAppProfilesPagedCallable()

Lists information about app profiles in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListAppProfilesRequest request =
       ListAppProfilesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AppProfile> future =
       baseBigtableInstanceAdminClient.listAppProfilesPagedCallable().futureCall(request);
   // Do something.
   for (AppProfile element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.ListAppProfilesRequest,ListAppProfilesPagedResponse>

listClusters(InstanceName parent)

public final ListClustersResponse listClusters(InstanceName parent)

Lists information about clusters in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   ListClustersResponse response = baseBigtableInstanceAdminClient.listClusters(parent);
 }
 
Parameter
Name Description
parent com.google.bigtable.admin.v2.InstanceName

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

Returns
Type Description
com.google.bigtable.admin.v2.ListClustersResponse

listClusters(ListClustersRequest request)

public final ListClustersResponse listClusters(ListClustersRequest request)

Lists information about clusters in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageToken("pageToken873572522")
           .build();
   ListClustersResponse response = baseBigtableInstanceAdminClient.listClusters(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.ListClustersRequest

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

Returns
Type Description
com.google.bigtable.admin.v2.ListClustersResponse

listClusters(String parent)

public final ListClustersResponse listClusters(String parent)

Lists information about clusters in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   ListClustersResponse response = baseBigtableInstanceAdminClient.listClusters(parent);
 }
 
Parameter
Name Description
parent String

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

Returns
Type Description
com.google.bigtable.admin.v2.ListClustersResponse

listClustersCallable()

public final UnaryCallable<ListClustersRequest,ListClustersResponse> listClustersCallable()

Lists information about clusters in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ListClustersResponse> future =
       baseBigtableInstanceAdminClient.listClustersCallable().futureCall(request);
   // Do something.
   ListClustersResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.ListClustersRequest,com.google.bigtable.admin.v2.ListClustersResponse>

listHotTablets(ClusterName parent)

public final BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse listHotTablets(ClusterName parent)

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
   for (HotTablet element :
       baseBigtableInstanceAdminClient.listHotTablets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent com.google.bigtable.admin.v2.ClusterName

Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
Type Description
BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse

listHotTablets(ListHotTabletsRequest request)

public final BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse listHotTablets(ListHotTabletsRequest request)

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListHotTabletsRequest request =
       ListHotTabletsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (HotTablet element :
       baseBigtableInstanceAdminClient.listHotTablets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.ListHotTabletsRequest

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

Returns
Type Description
BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse

listHotTablets(String parent)

public final BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse listHotTablets(String parent)

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
   for (HotTablet element :
       baseBigtableInstanceAdminClient.listHotTablets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
Type Description
BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse

listHotTabletsCallable()

public final UnaryCallable<ListHotTabletsRequest,ListHotTabletsResponse> listHotTabletsCallable()

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListHotTabletsRequest request =
       ListHotTabletsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListHotTabletsResponse response =
         baseBigtableInstanceAdminClient.listHotTabletsCallable().call(request);
     for (HotTablet element : response.getHotTabletsList()) {
       // 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.ListHotTabletsRequest,com.google.bigtable.admin.v2.ListHotTabletsResponse>

listHotTabletsPagedCallable()

public final UnaryCallable<ListHotTabletsRequest,BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse> listHotTabletsPagedCallable()

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListHotTabletsRequest request =
       ListHotTabletsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<HotTablet> future =
       baseBigtableInstanceAdminClient.listHotTabletsPagedCallable().futureCall(request);
   // Do something.
   for (HotTablet element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.ListHotTabletsRequest,ListHotTabletsPagedResponse>

listInstances(ListInstancesRequest request)

public final ListInstancesResponse listInstances(ListInstancesRequest request)

Lists information about instances in a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageToken("pageToken873572522")
           .build();
   ListInstancesResponse response = baseBigtableInstanceAdminClient.listInstances(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.ListInstancesRequest

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

Returns
Type Description
com.google.bigtable.admin.v2.ListInstancesResponse

listInstances(ProjectName parent)

public final ListInstancesResponse listInstances(ProjectName parent)

Lists information about instances in a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListInstancesResponse response = baseBigtableInstanceAdminClient.listInstances(parent);
 }
 
Parameter
Name Description
parent com.google.bigtable.admin.v2.ProjectName

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.

Returns
Type Description
com.google.bigtable.admin.v2.ListInstancesResponse

listInstances(String parent)

public final ListInstancesResponse listInstances(String parent)

Lists information about instances in a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   ListInstancesResponse response = baseBigtableInstanceAdminClient.listInstances(parent);
 }
 
Parameter
Name Description
parent String

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.

Returns
Type Description
com.google.bigtable.admin.v2.ListInstancesResponse

listInstancesCallable()

public final UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()

Lists information about instances in a 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ListInstancesResponse> future =
       baseBigtableInstanceAdminClient.listInstancesCallable().futureCall(request);
   // Do something.
   ListInstancesResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.ListInstancesRequest,com.google.bigtable.admin.v2.ListInstancesResponse>

listLogicalViews(InstanceName parent)

public final BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse listLogicalViews(InstanceName parent)

Lists information about logical views in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   for (LogicalView element :
       baseBigtableInstanceAdminClient.listLogicalViews(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent com.google.bigtable.admin.v2.InstanceName

Required. The unique name of the instance for which the list of logical views is requested. Values are of the form projects/{project}/instances/{instance}.

Returns
Type Description
BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse

listLogicalViews(ListLogicalViewsRequest request)

public final BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse listLogicalViews(ListLogicalViewsRequest request)

Lists information about logical views in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListLogicalViewsRequest request =
       ListLogicalViewsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (LogicalView element :
       baseBigtableInstanceAdminClient.listLogicalViews(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.ListLogicalViewsRequest

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

Returns
Type Description
BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse

listLogicalViews(String parent)

public final BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse listLogicalViews(String parent)

Lists information about logical views in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   for (LogicalView element :
       baseBigtableInstanceAdminClient.listLogicalViews(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The unique name of the instance for which the list of logical views is requested. Values are of the form projects/{project}/instances/{instance}.

Returns
Type Description
BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse

listLogicalViewsCallable()

public final UnaryCallable<ListLogicalViewsRequest,ListLogicalViewsResponse> listLogicalViewsCallable()

Lists information about logical views in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListLogicalViewsRequest request =
       ListLogicalViewsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLogicalViewsResponse response =
         baseBigtableInstanceAdminClient.listLogicalViewsCallable().call(request);
     for (LogicalView element : response.getLogicalViewsList()) {
       // 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.ListLogicalViewsRequest,com.google.bigtable.admin.v2.ListLogicalViewsResponse>

listLogicalViewsPagedCallable()

public final UnaryCallable<ListLogicalViewsRequest,BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse> listLogicalViewsPagedCallable()

Lists information about logical views in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListLogicalViewsRequest request =
       ListLogicalViewsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<LogicalView> future =
       baseBigtableInstanceAdminClient.listLogicalViewsPagedCallable().futureCall(request);
   // Do something.
   for (LogicalView element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.ListLogicalViewsRequest,ListLogicalViewsPagedResponse>

listMaterializedViews(InstanceName parent)

public final BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse listMaterializedViews(InstanceName parent)

Lists information about materialized views in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
   for (MaterializedView element :
       baseBigtableInstanceAdminClient.listMaterializedViews(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent com.google.bigtable.admin.v2.InstanceName

Required. The unique name of the instance for which the list of materialized views is requested. Values are of the form projects/{project}/instances/{instance}.

Returns
Type Description
BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse

listMaterializedViews(ListMaterializedViewsRequest request)

public final BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse listMaterializedViews(ListMaterializedViewsRequest request)

Lists information about materialized views in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListMaterializedViewsRequest request =
       ListMaterializedViewsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (MaterializedView element :
       baseBigtableInstanceAdminClient.listMaterializedViews(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.ListMaterializedViewsRequest

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

Returns
Type Description
BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse

listMaterializedViews(String parent)

public final BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse listMaterializedViews(String parent)

Lists information about materialized views in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
   for (MaterializedView element :
       baseBigtableInstanceAdminClient.listMaterializedViews(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The unique name of the instance for which the list of materialized views is requested. Values are of the form projects/{project}/instances/{instance}.

Returns
Type Description
BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse

listMaterializedViewsCallable()

public final UnaryCallable<ListMaterializedViewsRequest,ListMaterializedViewsResponse> listMaterializedViewsCallable()

Lists information about materialized views in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListMaterializedViewsRequest request =
       ListMaterializedViewsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListMaterializedViewsResponse response =
         baseBigtableInstanceAdminClient.listMaterializedViewsCallable().call(request);
     for (MaterializedView element : response.getMaterializedViewsList()) {
       // 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.ListMaterializedViewsRequest,com.google.bigtable.admin.v2.ListMaterializedViewsResponse>

listMaterializedViewsPagedCallable()

public final UnaryCallable<ListMaterializedViewsRequest,BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse> listMaterializedViewsPagedCallable()

Lists information about materialized views in an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ListMaterializedViewsRequest request =
       ListMaterializedViewsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<MaterializedView> future =
       baseBigtableInstanceAdminClient.listMaterializedViewsPagedCallable().futureCall(request);
   // Do something.
   for (MaterializedView element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.ListMaterializedViewsRequest,ListMaterializedViewsPagedResponse>

partialUpdateClusterAsync(Cluster cluster, FieldMask updateMask)

public final OperationFuture<Cluster,PartialUpdateClusterMetadata> partialUpdateClusterAsync(Cluster cluster, FieldMask updateMask)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   Cluster cluster = Cluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Cluster response =
       baseBigtableInstanceAdminClient.partialUpdateClusterAsync(cluster, updateMask).get();
 }
 
Parameters
Name Description
cluster com.google.bigtable.admin.v2.Cluster

Required. The Cluster which contains the partial updates to be applied, subject to the update_mask.

updateMask FieldMask

Required. The subset of Cluster fields which should be replaced.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.PartialUpdateClusterMetadata>

partialUpdateClusterAsync(PartialUpdateClusterRequest request)

public final OperationFuture<Cluster,PartialUpdateClusterMetadata> partialUpdateClusterAsync(PartialUpdateClusterRequest request)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   PartialUpdateClusterRequest request =
       PartialUpdateClusterRequest.newBuilder()
           .setCluster(Cluster.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Cluster response = baseBigtableInstanceAdminClient.partialUpdateClusterAsync(request).get();
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.PartialUpdateClusterRequest

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

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.PartialUpdateClusterMetadata>

partialUpdateClusterCallable()

public final UnaryCallable<PartialUpdateClusterRequest,Operation> partialUpdateClusterCallable()

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   PartialUpdateClusterRequest request =
       PartialUpdateClusterRequest.newBuilder()
           .setCluster(Cluster.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableInstanceAdminClient.partialUpdateClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.PartialUpdateClusterRequest,Operation>

partialUpdateClusterOperationCallable()

public final OperationCallable<PartialUpdateClusterRequest,Cluster,PartialUpdateClusterMetadata> partialUpdateClusterOperationCallable()

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   PartialUpdateClusterRequest request =
       PartialUpdateClusterRequest.newBuilder()
           .setCluster(Cluster.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Cluster, PartialUpdateClusterMetadata> future =
       baseBigtableInstanceAdminClient
           .partialUpdateClusterOperationCallable()
           .futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
 
Returns
Type Description
OperationCallable<com.google.bigtable.admin.v2.PartialUpdateClusterRequest,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.PartialUpdateClusterMetadata>

partialUpdateInstanceAsync(Instance instance, FieldMask updateMask)

public final OperationFuture<Instance,UpdateInstanceMetadata> partialUpdateInstanceAsync(Instance instance, FieldMask updateMask)

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   Instance instance = Instance.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Instance response =
       baseBigtableInstanceAdminClient.partialUpdateInstanceAsync(instance, updateMask).get();
 }
 
Parameters
Name Description
instance com.google.bigtable.admin.v2.Instance

Required. The Instance which will (partially) replace the current value.

updateMask FieldMask

Required. The subset of Instance fields which should be replaced. Must be explicitly set.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.UpdateInstanceMetadata>

partialUpdateInstanceAsync(PartialUpdateInstanceRequest request)

public final OperationFuture<Instance,UpdateInstanceMetadata> partialUpdateInstanceAsync(PartialUpdateInstanceRequest request)

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   PartialUpdateInstanceRequest request =
       PartialUpdateInstanceRequest.newBuilder()
           .setInstance(Instance.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Instance response = baseBigtableInstanceAdminClient.partialUpdateInstanceAsync(request).get();
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.PartialUpdateInstanceRequest

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

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.UpdateInstanceMetadata>

partialUpdateInstanceCallable()

public final UnaryCallable<PartialUpdateInstanceRequest,Operation> partialUpdateInstanceCallable()

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   PartialUpdateInstanceRequest request =
       PartialUpdateInstanceRequest.newBuilder()
           .setInstance(Instance.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableInstanceAdminClient.partialUpdateInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.PartialUpdateInstanceRequest,Operation>

partialUpdateInstanceOperationCallable()

public final OperationCallable<PartialUpdateInstanceRequest,Instance,UpdateInstanceMetadata> partialUpdateInstanceOperationCallable()

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   PartialUpdateInstanceRequest request =
       PartialUpdateInstanceRequest.newBuilder()
           .setInstance(Instance.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Instance, UpdateInstanceMetadata> future =
       baseBigtableInstanceAdminClient
           .partialUpdateInstanceOperationCallable()
           .futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
OperationCallable<com.google.bigtable.admin.v2.PartialUpdateInstanceRequest,com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.UpdateInstanceMetadata>

setIamPolicy(ResourceName resource, Policy policy)

public final Policy setIamPolicy(ResourceName resource, Policy policy)

Sets the access control policy on an instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ResourceName resource = InstanceName.of("[PROJECT]", "[INSTANCE]");
   Policy policy = Policy.newBuilder().build();
   Policy response = baseBigtableInstanceAdminClient.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 an instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = baseBigtableInstanceAdminClient.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 an instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String resource = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
   Policy policy = Policy.newBuilder().build();
   Policy response = baseBigtableInstanceAdminClient.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 an instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       baseBigtableInstanceAdminClient.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()

testIamPermissions(ResourceName resource, List<String> permissions)

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

Returns permissions that the caller has on the specified instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   ResourceName resource = InstanceName.of("[PROJECT]", "[INSTANCE]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response =
       baseBigtableInstanceAdminClient.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 instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       baseBigtableInstanceAdminClient.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 instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   String resource = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response =
       baseBigtableInstanceAdminClient.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 instance 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       baseBigtableInstanceAdminClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateAppProfileAsync(AppProfile appProfile, FieldMask updateMask)

public final OperationFuture<AppProfile,UpdateAppProfileMetadata> updateAppProfileAsync(AppProfile appProfile, FieldMask updateMask)

Updates an app profile within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   AppProfile appProfile = AppProfile.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AppProfile response =
       baseBigtableInstanceAdminClient.updateAppProfileAsync(appProfile, updateMask).get();
 }
 
Parameters
Name Description
appProfile com.google.bigtable.admin.v2.AppProfile

Required. The app profile which will (partially) replace the current value.

updateMask FieldMask

Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.AppProfile,com.google.bigtable.admin.v2.UpdateAppProfileMetadata>

updateAppProfileAsync(UpdateAppProfileRequest request)

public final OperationFuture<AppProfile,UpdateAppProfileMetadata> updateAppProfileAsync(UpdateAppProfileRequest request)

Updates an app profile within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   UpdateAppProfileRequest request =
       UpdateAppProfileRequest.newBuilder()
           .setAppProfile(AppProfile.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   AppProfile response = baseBigtableInstanceAdminClient.updateAppProfileAsync(request).get();
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.UpdateAppProfileRequest

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

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.AppProfile,com.google.bigtable.admin.v2.UpdateAppProfileMetadata>

updateAppProfileCallable()

public final UnaryCallable<UpdateAppProfileRequest,Operation> updateAppProfileCallable()

Updates an app profile within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   UpdateAppProfileRequest request =
       UpdateAppProfileRequest.newBuilder()
           .setAppProfile(AppProfile.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   ApiFuture<Operation> future =
       baseBigtableInstanceAdminClient.updateAppProfileCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.UpdateAppProfileRequest,Operation>

updateAppProfileOperationCallable()

public final OperationCallable<UpdateAppProfileRequest,AppProfile,UpdateAppProfileMetadata> updateAppProfileOperationCallable()

Updates an app profile within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   UpdateAppProfileRequest request =
       UpdateAppProfileRequest.newBuilder()
           .setAppProfile(AppProfile.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIgnoreWarnings(true)
           .build();
   OperationFuture<AppProfile, UpdateAppProfileMetadata> future =
       baseBigtableInstanceAdminClient.updateAppProfileOperationCallable().futureCall(request);
   // Do something.
   AppProfile response = future.get();
 }
 
Returns
Type Description
OperationCallable<com.google.bigtable.admin.v2.UpdateAppProfileRequest,com.google.bigtable.admin.v2.AppProfile,com.google.bigtable.admin.v2.UpdateAppProfileMetadata>

updateClusterAsync(Cluster request)

public final OperationFuture<Cluster,UpdateClusterMetadata> updateClusterAsync(Cluster request)

Updates a cluster within an instance.

Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   Cluster request =
       Cluster.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setServeNodes(-1288838783)
           .setDefaultStorageType(StorageType.forNumber(0))
           .setEncryptionConfig(Cluster.EncryptionConfig.newBuilder().build())
           .build();
   Cluster response = baseBigtableInstanceAdminClient.updateClusterAsync(request).get();
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.Cluster

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

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.UpdateClusterMetadata>

updateClusterCallable()

public final UnaryCallable<Cluster,Operation> updateClusterCallable()

Updates a cluster within an instance.

Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   Cluster request =
       Cluster.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setServeNodes(-1288838783)
           .setDefaultStorageType(StorageType.forNumber(0))
           .setEncryptionConfig(Cluster.EncryptionConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableInstanceAdminClient.updateClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.Cluster,Operation>

updateClusterOperationCallable()

public final OperationCallable<Cluster,Cluster,UpdateClusterMetadata> updateClusterOperationCallable()

Updates a cluster within an instance.

Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   Cluster request =
       Cluster.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setServeNodes(-1288838783)
           .setDefaultStorageType(StorageType.forNumber(0))
           .setEncryptionConfig(Cluster.EncryptionConfig.newBuilder().build())
           .build();
   OperationFuture<Cluster, UpdateClusterMetadata> future =
       baseBigtableInstanceAdminClient.updateClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
 
Returns
Type Description
OperationCallable<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.UpdateClusterMetadata>

updateInstance(Instance request)

public final Instance updateInstance(Instance request)

Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   Instance request =
       Instance.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setDisplayName("displayName1714148973")
           .putAllLabels(new HashMap<String, String>())
           .setCreateTime(Timestamp.newBuilder().build())
           .setSatisfiesPzs(true)
           .setSatisfiesPzi(true)
           .putAllTags(new HashMap<String, String>())
           .build();
   Instance response = baseBigtableInstanceAdminClient.updateInstance(request);
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.Instance

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

Returns
Type Description
com.google.bigtable.admin.v2.Instance

updateInstanceCallable()

public final UnaryCallable<Instance,Instance> updateInstanceCallable()

Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.

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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   Instance request =
       Instance.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
           .setDisplayName("displayName1714148973")
           .putAllLabels(new HashMap<String, String>())
           .setCreateTime(Timestamp.newBuilder().build())
           .setSatisfiesPzs(true)
           .setSatisfiesPzi(true)
           .putAllTags(new HashMap<String, String>())
           .build();
   ApiFuture<Instance> future =
       baseBigtableInstanceAdminClient.updateInstanceCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.Instance>

updateLogicalViewAsync(LogicalView logicalView, FieldMask updateMask)

public final OperationFuture<LogicalView,UpdateLogicalViewMetadata> updateLogicalViewAsync(LogicalView logicalView, FieldMask updateMask)

Updates a logical view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   LogicalView logicalView = LogicalView.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   LogicalView response =
       baseBigtableInstanceAdminClient.updateLogicalViewAsync(logicalView, updateMask).get();
 }
 
Parameters
Name Description
logicalView com.google.bigtable.admin.v2.LogicalView

Required. The logical view to update.

The logical view's name field is used to identify the view to update. Format: projects/{project}/instances/{instance}/logicalViews/{logical_view}.

updateMask FieldMask

Optional. The list of fields to update.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.LogicalView,com.google.bigtable.admin.v2.UpdateLogicalViewMetadata>

updateLogicalViewAsync(UpdateLogicalViewRequest request)

public final OperationFuture<LogicalView,UpdateLogicalViewMetadata> updateLogicalViewAsync(UpdateLogicalViewRequest request)

Updates a logical view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   UpdateLogicalViewRequest request =
       UpdateLogicalViewRequest.newBuilder()
           .setLogicalView(LogicalView.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   LogicalView response = baseBigtableInstanceAdminClient.updateLogicalViewAsync(request).get();
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.UpdateLogicalViewRequest

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

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.LogicalView,com.google.bigtable.admin.v2.UpdateLogicalViewMetadata>

updateLogicalViewCallable()

public final UnaryCallable<UpdateLogicalViewRequest,Operation> updateLogicalViewCallable()

Updates a logical view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   UpdateLogicalViewRequest request =
       UpdateLogicalViewRequest.newBuilder()
           .setLogicalView(LogicalView.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableInstanceAdminClient.updateLogicalViewCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.UpdateLogicalViewRequest,Operation>

updateLogicalViewOperationCallable()

public final OperationCallable<UpdateLogicalViewRequest,LogicalView,UpdateLogicalViewMetadata> updateLogicalViewOperationCallable()

Updates a logical view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   UpdateLogicalViewRequest request =
       UpdateLogicalViewRequest.newBuilder()
           .setLogicalView(LogicalView.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<LogicalView, UpdateLogicalViewMetadata> future =
       baseBigtableInstanceAdminClient.updateLogicalViewOperationCallable().futureCall(request);
   // Do something.
   LogicalView response = future.get();
 }
 
Returns
Type Description
OperationCallable<com.google.bigtable.admin.v2.UpdateLogicalViewRequest,com.google.bigtable.admin.v2.LogicalView,com.google.bigtable.admin.v2.UpdateLogicalViewMetadata>

updateMaterializedViewAsync(MaterializedView materializedView, FieldMask updateMask)

public final OperationFuture<MaterializedView,UpdateMaterializedViewMetadata> updateMaterializedViewAsync(MaterializedView materializedView, FieldMask updateMask)

Updates a materialized view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   MaterializedView materializedView = MaterializedView.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   MaterializedView response =
       baseBigtableInstanceAdminClient
           .updateMaterializedViewAsync(materializedView, updateMask)
           .get();
 }
 
Parameters
Name Description
materializedView com.google.bigtable.admin.v2.MaterializedView

Required. The materialized view to update.

The materialized view's name field is used to identify the view to update. Format: projects/{project}/instances/{instance}/materializedViews/{materialized_view}.

updateMask FieldMask

Optional. The list of fields to update.

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.MaterializedView,com.google.bigtable.admin.v2.UpdateMaterializedViewMetadata>

updateMaterializedViewAsync(UpdateMaterializedViewRequest request)

public final OperationFuture<MaterializedView,UpdateMaterializedViewMetadata> updateMaterializedViewAsync(UpdateMaterializedViewRequest request)

Updates a materialized view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   UpdateMaterializedViewRequest request =
       UpdateMaterializedViewRequest.newBuilder()
           .setMaterializedView(MaterializedView.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   MaterializedView response =
       baseBigtableInstanceAdminClient.updateMaterializedViewAsync(request).get();
 }
 
Parameter
Name Description
request com.google.bigtable.admin.v2.UpdateMaterializedViewRequest

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

Returns
Type Description
OperationFuture<com.google.bigtable.admin.v2.MaterializedView,com.google.bigtable.admin.v2.UpdateMaterializedViewMetadata>

updateMaterializedViewCallable()

public final UnaryCallable<UpdateMaterializedViewRequest,Operation> updateMaterializedViewCallable()

Updates a materialized view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   UpdateMaterializedViewRequest request =
       UpdateMaterializedViewRequest.newBuilder()
           .setMaterializedView(MaterializedView.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       baseBigtableInstanceAdminClient.updateMaterializedViewCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.bigtable.admin.v2.UpdateMaterializedViewRequest,Operation>

updateMaterializedViewOperationCallable()

public final OperationCallable<UpdateMaterializedViewRequest,MaterializedView,UpdateMaterializedViewMetadata> updateMaterializedViewOperationCallable()

Updates a materialized view within an 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 (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create()) {
   UpdateMaterializedViewRequest request =
       UpdateMaterializedViewRequest.newBuilder()
           .setMaterializedView(MaterializedView.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<MaterializedView, UpdateMaterializedViewMetadata> future =
       baseBigtableInstanceAdminClient
           .updateMaterializedViewOperationCallable()
           .futureCall(request);
   // Do something.
   MaterializedView response = future.get();
 }
 
Returns
Type Description
OperationCallable<com.google.bigtable.admin.v2.UpdateMaterializedViewRequest,com.google.bigtable.admin.v2.MaterializedView,com.google.bigtable.admin.v2.UpdateMaterializedViewMetadata>