@Generated(value="by gapic-generator-java") public class BaseBigtableInstanceAdminClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
| 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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetInstance |
Gets information about an instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetCluster |
Gets information about a cluster. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of 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.
| Modifier and Type | Class and Description |
|---|---|
static class |
BaseBigtableInstanceAdminClient.ListAppProfilesFixedSizeCollection |
static class |
BaseBigtableInstanceAdminClient.ListAppProfilesPage |
static class |
BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse |
static class |
BaseBigtableInstanceAdminClient.ListHotTabletsFixedSizeCollection |
static class |
BaseBigtableInstanceAdminClient.ListHotTabletsPage |
static class |
BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse |
static class |
BaseBigtableInstanceAdminClient.ListLogicalViewsFixedSizeCollection |
static class |
BaseBigtableInstanceAdminClient.ListLogicalViewsPage |
static class |
BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse |
static class |
BaseBigtableInstanceAdminClient.ListMaterializedViewsFixedSizeCollection |
static class |
BaseBigtableInstanceAdminClient.ListMaterializedViewsPage |
static class |
BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
BaseBigtableInstanceAdminClient(BaseBigtableInstanceAdminSettings settings)
Constructs an instance of BaseBigtableInstanceAdminClient, using the given settings.
|
protected |
BaseBigtableInstanceAdminClient(BigtableInstanceAdminStub stub) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
protected static BaseBigtableInstanceAdminClient |
create()
Constructs an instance of BaseBigtableInstanceAdminClient with default settings.
|
protected static BaseBigtableInstanceAdminClient |
create(BaseBigtableInstanceAdminSettings settings)
Constructs an instance of BaseBigtableInstanceAdminClient, using the given settings.
|
protected static BaseBigtableInstanceAdminClient |
create(BigtableInstanceAdminStub stub)
Constructs an instance of BaseBigtableInstanceAdminClient, using the given stub for making
calls.
|
AppProfile |
createAppProfile(CreateAppProfileRequest request)
Creates an app profile within an instance.
|
AppProfile |
createAppProfile(InstanceName parent,
String appProfileId,
AppProfile appProfile)
Creates an app profile within an instance.
|
AppProfile |
createAppProfile(String parent,
String appProfileId,
AppProfile appProfile)
Creates an app profile within an instance.
|
com.google.api.gax.rpc.UnaryCallable<CreateAppProfileRequest,AppProfile> |
createAppProfileCallable()
Creates an app profile within an instance.
|
com.google.api.gax.longrunning.OperationFuture<Cluster,CreateClusterMetadata> |
createClusterAsync(CreateClusterRequest request)
Creates a cluster within an instance.
|
com.google.api.gax.longrunning.OperationFuture<Cluster,CreateClusterMetadata> |
createClusterAsync(InstanceName parent,
String clusterId,
Cluster cluster)
Creates a cluster within an instance.
|
com.google.api.gax.longrunning.OperationFuture<Cluster,CreateClusterMetadata> |
createClusterAsync(String parent,
String clusterId,
Cluster cluster)
Creates a cluster within an instance.
|
com.google.api.gax.rpc.UnaryCallable<CreateClusterRequest,com.google.longrunning.Operation> |
createClusterCallable()
Creates a cluster within an instance.
|
com.google.api.gax.rpc.OperationCallable<CreateClusterRequest,Cluster,CreateClusterMetadata> |
createClusterOperationCallable()
Creates a cluster within an instance.
|
com.google.api.gax.longrunning.OperationFuture<Instance,CreateInstanceMetadata> |
createInstanceAsync(CreateInstanceRequest request)
Create an instance within a project.
|
com.google.api.gax.longrunning.OperationFuture<Instance,CreateInstanceMetadata> |
createInstanceAsync(ProjectName parent,
String instanceId,
Instance instance,
Map<String,Cluster> clusters)
Create an instance within a project.
|
com.google.api.gax.longrunning.OperationFuture<Instance,CreateInstanceMetadata> |
createInstanceAsync(String parent,
String instanceId,
Instance instance,
Map<String,Cluster> clusters)
Create an instance within a project.
|
com.google.api.gax.rpc.UnaryCallable<CreateInstanceRequest,com.google.longrunning.Operation> |
createInstanceCallable()
Create an instance within a project.
|
com.google.api.gax.rpc.OperationCallable<CreateInstanceRequest,Instance,CreateInstanceMetadata> |
createInstanceOperationCallable()
Create an instance within a project.
|
com.google.api.gax.longrunning.OperationFuture<LogicalView,CreateLogicalViewMetadata> |
createLogicalViewAsync(CreateLogicalViewRequest request)
Creates a logical view within an instance.
|
com.google.api.gax.longrunning.OperationFuture<LogicalView,CreateLogicalViewMetadata> |
createLogicalViewAsync(InstanceName parent,
LogicalView logicalView,
String logicalViewId)
Creates a logical view within an instance.
|
com.google.api.gax.longrunning.OperationFuture<LogicalView,CreateLogicalViewMetadata> |
createLogicalViewAsync(String parent,
LogicalView logicalView,
String logicalViewId)
Creates a logical view within an instance.
|
com.google.api.gax.rpc.UnaryCallable<CreateLogicalViewRequest,com.google.longrunning.Operation> |
createLogicalViewCallable()
Creates a logical view within an instance.
|
com.google.api.gax.rpc.OperationCallable<CreateLogicalViewRequest,LogicalView,CreateLogicalViewMetadata> |
createLogicalViewOperationCallable()
Creates a logical view within an instance.
|
com.google.api.gax.longrunning.OperationFuture<MaterializedView,CreateMaterializedViewMetadata> |
createMaterializedViewAsync(CreateMaterializedViewRequest request)
Creates a materialized view within an instance.
|
com.google.api.gax.longrunning.OperationFuture<MaterializedView,CreateMaterializedViewMetadata> |
createMaterializedViewAsync(InstanceName parent,
MaterializedView materializedView,
String materializedViewId)
Creates a materialized view within an instance.
|
com.google.api.gax.longrunning.OperationFuture<MaterializedView,CreateMaterializedViewMetadata> |
createMaterializedViewAsync(String parent,
MaterializedView materializedView,
String materializedViewId)
Creates a materialized view within an instance.
|
com.google.api.gax.rpc.UnaryCallable<CreateMaterializedViewRequest,com.google.longrunning.Operation> |
createMaterializedViewCallable()
Creates a materialized view within an instance.
|
com.google.api.gax.rpc.OperationCallable<CreateMaterializedViewRequest,MaterializedView,CreateMaterializedViewMetadata> |
createMaterializedViewOperationCallable()
Creates a materialized view within an instance.
|
void |
deleteAppProfile(AppProfileName name)
Deletes an app profile from an instance.
|
void |
deleteAppProfile(AppProfileName name,
boolean ignoreWarnings)
Deletes an app profile from an instance.
|
void |
deleteAppProfile(DeleteAppProfileRequest request)
Deletes an app profile from an instance.
|
void |
deleteAppProfile(String name)
Deletes an app profile from an instance.
|
void |
deleteAppProfile(String name,
boolean ignoreWarnings)
Deletes an app profile from an instance.
|
com.google.api.gax.rpc.UnaryCallable<DeleteAppProfileRequest,com.google.protobuf.Empty> |
deleteAppProfileCallable()
Deletes an app profile from an instance.
|
void |
deleteCluster(ClusterName name)
Deletes a cluster from an instance.
|
void |
deleteCluster(DeleteClusterRequest request)
Deletes a cluster from an instance.
|
void |
deleteCluster(String name)
Deletes a cluster from an instance.
|
com.google.api.gax.rpc.UnaryCallable<DeleteClusterRequest,com.google.protobuf.Empty> |
deleteClusterCallable()
Deletes a cluster from an instance.
|
void |
deleteInstance(DeleteInstanceRequest request)
Delete an instance from a project.
|
void |
deleteInstance(InstanceName name)
Delete an instance from a project.
|
void |
deleteInstance(String name)
Delete an instance from a project.
|
com.google.api.gax.rpc.UnaryCallable<DeleteInstanceRequest,com.google.protobuf.Empty> |
deleteInstanceCallable()
Delete an instance from a project.
|
void |
deleteLogicalView(DeleteLogicalViewRequest request)
Deletes a logical view from an instance.
|
void |
deleteLogicalView(LogicalViewName name)
Deletes a logical view from an instance.
|
void |
deleteLogicalView(String name)
Deletes a logical view from an instance.
|
com.google.api.gax.rpc.UnaryCallable<DeleteLogicalViewRequest,com.google.protobuf.Empty> |
deleteLogicalViewCallable()
Deletes a logical view from an instance.
|
void |
deleteMaterializedView(DeleteMaterializedViewRequest request)
Deletes a materialized view from an instance.
|
void |
deleteMaterializedView(MaterializedViewName name)
Deletes a materialized view from an instance.
|
void |
deleteMaterializedView(String name)
Deletes a materialized view from an instance.
|
com.google.api.gax.rpc.UnaryCallable<DeleteMaterializedViewRequest,com.google.protobuf.Empty> |
deleteMaterializedViewCallable()
Deletes a materialized view from an instance.
|
AppProfile |
getAppProfile(AppProfileName name)
Gets information about an app profile.
|
AppProfile |
getAppProfile(GetAppProfileRequest request)
Gets information about an app profile.
|
AppProfile |
getAppProfile(String name)
Gets information about an app profile.
|
com.google.api.gax.rpc.UnaryCallable<GetAppProfileRequest,AppProfile> |
getAppProfileCallable()
Gets information about an app profile.
|
Cluster |
getCluster(ClusterName name)
Gets information about a cluster.
|
Cluster |
getCluster(GetClusterRequest request)
Gets information about a cluster.
|
Cluster |
getCluster(String name)
Gets information about a cluster.
|
com.google.api.gax.rpc.UnaryCallable<GetClusterRequest,Cluster> |
getClusterCallable()
Gets information about a cluster.
|
com.google.iam.v1.Policy |
getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the access control policy for an instance resource.
|
com.google.iam.v1.Policy |
getIamPolicy(com.google.api.resourcenames.ResourceName resource)
Gets the access control policy for an instance resource.
|
com.google.iam.v1.Policy |
getIamPolicy(String resource)
Gets the access control policy for an instance resource.
|
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getIamPolicyCallable()
Gets the access control policy for an instance resource.
|
Instance |
getInstance(GetInstanceRequest request)
Gets information about an instance.
|
Instance |
getInstance(InstanceName name)
Gets information about an instance.
|
Instance |
getInstance(String name)
Gets information about an instance.
|
com.google.api.gax.rpc.UnaryCallable<GetInstanceRequest,Instance> |
getInstanceCallable()
Gets information about an instance.
|
LogicalView |
getLogicalView(GetLogicalViewRequest request)
Gets information about a logical view.
|
LogicalView |
getLogicalView(LogicalViewName name)
Gets information about a logical view.
|
LogicalView |
getLogicalView(String name)
Gets information about a logical view.
|
com.google.api.gax.rpc.UnaryCallable<GetLogicalViewRequest,LogicalView> |
getLogicalViewCallable()
Gets information about a logical view.
|
MaterializedView |
getMaterializedView(GetMaterializedViewRequest request)
Gets information about a materialized view.
|
MaterializedView |
getMaterializedView(MaterializedViewName name)
Gets information about a materialized view.
|
MaterializedView |
getMaterializedView(String name)
Gets information about a materialized view.
|
com.google.api.gax.rpc.UnaryCallable<GetMaterializedViewRequest,MaterializedView> |
getMaterializedViewCallable()
Gets information about a materialized view.
|
com.google.longrunning.OperationsClient |
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation
returned by another API method call.
|
BaseBigtableInstanceAdminSettings |
getSettings() |
BigtableInstanceAdminStub |
getStub() |
boolean |
isShutdown() |
boolean |
isTerminated() |
BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse |
listAppProfiles(InstanceName parent)
Lists information about app profiles in an instance.
|
BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse |
listAppProfiles(ListAppProfilesRequest request)
Lists information about app profiles in an instance.
|
BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse |
listAppProfiles(String parent)
Lists information about app profiles in an instance.
|
com.google.api.gax.rpc.UnaryCallable<ListAppProfilesRequest,ListAppProfilesResponse> |
listAppProfilesCallable()
Lists information about app profiles in an instance.
|
com.google.api.gax.rpc.UnaryCallable<ListAppProfilesRequest,BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse> |
listAppProfilesPagedCallable()
Lists information about app profiles in an instance.
|
ListClustersResponse |
listClusters(InstanceName parent)
Lists information about clusters in an instance.
|
ListClustersResponse |
listClusters(ListClustersRequest request)
Lists information about clusters in an instance.
|
ListClustersResponse |
listClusters(String parent)
Lists information about clusters in an instance.
|
com.google.api.gax.rpc.UnaryCallable<ListClustersRequest,ListClustersResponse> |
listClustersCallable()
Lists information about clusters in an instance.
|
BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse |
listHotTablets(ClusterName parent)
Lists hot tablets in a cluster, within the time range provided.
|
BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse |
listHotTablets(ListHotTabletsRequest request)
Lists hot tablets in a cluster, within the time range provided.
|
BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse |
listHotTablets(String parent)
Lists hot tablets in a cluster, within the time range provided.
|
com.google.api.gax.rpc.UnaryCallable<ListHotTabletsRequest,ListHotTabletsResponse> |
listHotTabletsCallable()
Lists hot tablets in a cluster, within the time range provided.
|
com.google.api.gax.rpc.UnaryCallable<ListHotTabletsRequest,BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse> |
listHotTabletsPagedCallable()
Lists hot tablets in a cluster, within the time range provided.
|
ListInstancesResponse |
listInstances(ListInstancesRequest request)
Lists information about instances in a project.
|
ListInstancesResponse |
listInstances(ProjectName parent)
Lists information about instances in a project.
|
ListInstancesResponse |
listInstances(String parent)
Lists information about instances in a project.
|
com.google.api.gax.rpc.UnaryCallable<ListInstancesRequest,ListInstancesResponse> |
listInstancesCallable()
Lists information about instances in a project.
|
BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse |
listLogicalViews(InstanceName parent)
Lists information about logical views in an instance.
|
BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse |
listLogicalViews(ListLogicalViewsRequest request)
Lists information about logical views in an instance.
|
BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse |
listLogicalViews(String parent)
Lists information about logical views in an instance.
|
com.google.api.gax.rpc.UnaryCallable<ListLogicalViewsRequest,ListLogicalViewsResponse> |
listLogicalViewsCallable()
Lists information about logical views in an instance.
|
com.google.api.gax.rpc.UnaryCallable<ListLogicalViewsRequest,BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse> |
listLogicalViewsPagedCallable()
Lists information about logical views in an instance.
|
BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse |
listMaterializedViews(InstanceName parent)
Lists information about materialized views in an instance.
|
BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse |
listMaterializedViews(ListMaterializedViewsRequest request)
Lists information about materialized views in an instance.
|
BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse |
listMaterializedViews(String parent)
Lists information about materialized views in an instance.
|
com.google.api.gax.rpc.UnaryCallable<ListMaterializedViewsRequest,ListMaterializedViewsResponse> |
listMaterializedViewsCallable()
Lists information about materialized views in an instance.
|
com.google.api.gax.rpc.UnaryCallable<ListMaterializedViewsRequest,BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse> |
listMaterializedViewsPagedCallable()
Lists information about materialized views in an instance.
|
com.google.api.gax.longrunning.OperationFuture<Cluster,PartialUpdateClusterMetadata> |
partialUpdateClusterAsync(Cluster cluster,
com.google.protobuf.FieldMask updateMask)
Partially updates a cluster within a project.
|
com.google.api.gax.longrunning.OperationFuture<Cluster,PartialUpdateClusterMetadata> |
partialUpdateClusterAsync(PartialUpdateClusterRequest request)
Partially updates a cluster within a project.
|
com.google.api.gax.rpc.UnaryCallable<PartialUpdateClusterRequest,com.google.longrunning.Operation> |
partialUpdateClusterCallable()
Partially updates a cluster within a project.
|
com.google.api.gax.rpc.OperationCallable<PartialUpdateClusterRequest,Cluster,PartialUpdateClusterMetadata> |
partialUpdateClusterOperationCallable()
Partially updates a cluster within a project.
|
com.google.api.gax.longrunning.OperationFuture<Instance,UpdateInstanceMetadata> |
partialUpdateInstanceAsync(Instance instance,
com.google.protobuf.FieldMask updateMask)
Partially updates an instance within a project.
|
com.google.api.gax.longrunning.OperationFuture<Instance,UpdateInstanceMetadata> |
partialUpdateInstanceAsync(PartialUpdateInstanceRequest request)
Partially updates an instance within a project.
|
com.google.api.gax.rpc.UnaryCallable<PartialUpdateInstanceRequest,com.google.longrunning.Operation> |
partialUpdateInstanceCallable()
Partially updates an instance within a project.
|
com.google.api.gax.rpc.OperationCallable<PartialUpdateInstanceRequest,Instance,UpdateInstanceMetadata> |
partialUpdateInstanceOperationCallable()
Partially updates an instance within a project.
|
com.google.iam.v1.Policy |
setIamPolicy(com.google.api.resourcenames.ResourceName resource,
com.google.iam.v1.Policy policy)
Sets the access control policy on an instance resource.
|
com.google.iam.v1.Policy |
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on an instance resource.
|
com.google.iam.v1.Policy |
setIamPolicy(String resource,
com.google.iam.v1.Policy policy)
Sets the access control policy on an instance resource.
|
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
setIamPolicyCallable()
Sets the access control policy on an instance resource.
|
void |
shutdown() |
void |
shutdownNow() |
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissions(com.google.api.resourcenames.ResourceName resource,
List<String> permissions)
Returns permissions that the caller has on the specified instance resource.
|
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissions(String resource,
List<String> permissions)
Returns permissions that the caller has on the specified instance resource.
|
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns permissions that the caller has on the specified instance resource.
|
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
testIamPermissionsCallable()
Returns permissions that the caller has on the specified instance resource.
|
com.google.api.gax.longrunning.OperationFuture<AppProfile,UpdateAppProfileMetadata> |
updateAppProfileAsync(AppProfile appProfile,
com.google.protobuf.FieldMask updateMask)
Updates an app profile within an instance.
|
com.google.api.gax.longrunning.OperationFuture<AppProfile,UpdateAppProfileMetadata> |
updateAppProfileAsync(UpdateAppProfileRequest request)
Updates an app profile within an instance.
|
com.google.api.gax.rpc.UnaryCallable<UpdateAppProfileRequest,com.google.longrunning.Operation> |
updateAppProfileCallable()
Updates an app profile within an instance.
|
com.google.api.gax.rpc.OperationCallable<UpdateAppProfileRequest,AppProfile,UpdateAppProfileMetadata> |
updateAppProfileOperationCallable()
Updates an app profile within an instance.
|
com.google.api.gax.longrunning.OperationFuture<Cluster,UpdateClusterMetadata> |
updateClusterAsync(Cluster request)
Updates a cluster within an instance.
|
com.google.api.gax.rpc.UnaryCallable<Cluster,com.google.longrunning.Operation> |
updateClusterCallable()
Updates a cluster within an instance.
|
com.google.api.gax.rpc.OperationCallable<Cluster,Cluster,UpdateClusterMetadata> |
updateClusterOperationCallable()
Updates a cluster within an instance.
|
Instance |
updateInstance(Instance request)
Updates an instance within a project.
|
com.google.api.gax.rpc.UnaryCallable<Instance,Instance> |
updateInstanceCallable()
Updates an instance within a project.
|
com.google.api.gax.longrunning.OperationFuture<LogicalView,UpdateLogicalViewMetadata> |
updateLogicalViewAsync(LogicalView logicalView,
com.google.protobuf.FieldMask updateMask)
Updates a logical view within an instance.
|
com.google.api.gax.longrunning.OperationFuture<LogicalView,UpdateLogicalViewMetadata> |
updateLogicalViewAsync(UpdateLogicalViewRequest request)
Updates a logical view within an instance.
|
com.google.api.gax.rpc.UnaryCallable<UpdateLogicalViewRequest,com.google.longrunning.Operation> |
updateLogicalViewCallable()
Updates a logical view within an instance.
|
com.google.api.gax.rpc.OperationCallable<UpdateLogicalViewRequest,LogicalView,UpdateLogicalViewMetadata> |
updateLogicalViewOperationCallable()
Updates a logical view within an instance.
|
com.google.api.gax.longrunning.OperationFuture<MaterializedView,UpdateMaterializedViewMetadata> |
updateMaterializedViewAsync(MaterializedView materializedView,
com.google.protobuf.FieldMask updateMask)
Updates a materialized view within an instance.
|
com.google.api.gax.longrunning.OperationFuture<MaterializedView,UpdateMaterializedViewMetadata> |
updateMaterializedViewAsync(UpdateMaterializedViewRequest request)
Updates a materialized view within an instance.
|
com.google.api.gax.rpc.UnaryCallable<UpdateMaterializedViewRequest,com.google.longrunning.Operation> |
updateMaterializedViewCallable()
Updates a materialized view within an instance.
|
com.google.api.gax.rpc.OperationCallable<UpdateMaterializedViewRequest,MaterializedView,UpdateMaterializedViewMetadata> |
updateMaterializedViewOperationCallable()
Updates a materialized view within an instance.
|
protected BaseBigtableInstanceAdminClient(BaseBigtableInstanceAdminSettings settings) throws IOException
IOExceptionprotected BaseBigtableInstanceAdminClient(BigtableInstanceAdminStub stub)
protected static BaseBigtableInstanceAdminClient create() throws IOException
IOExceptionprotected static BaseBigtableInstanceAdminClient create(BaseBigtableInstanceAdminSettings settings) throws IOException
IOExceptionprotected static BaseBigtableInstanceAdminClient create(BigtableInstanceAdminStub stub)
public final BaseBigtableInstanceAdminSettings getSettings()
public BigtableInstanceAdminStub getStub()
public final com.google.longrunning.OperationsClient getOperationsClient()
public final com.google.api.gax.longrunning.OperationFuture<Instance,CreateInstanceMetadata> createInstanceAsync(ProjectName parent, String instanceId, Instance instance, Map<String,Cluster> clusters)
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();
}
parent - Required. The unique name of the project in which to create the new instance.
Values are of the form `projects/{project}`.instanceId - 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 - Required. The instance to create. Fields marked `OutputOnly` must be left
blank.clusters - 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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Instance,CreateInstanceMetadata> createInstanceAsync(String parent, String instanceId, Instance instance, Map<String,Cluster> clusters)
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();
}
parent - Required. The unique name of the project in which to create the new instance.
Values are of the form `projects/{project}`.instanceId - 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 - Required. The instance to create. Fields marked `OutputOnly` must be left
blank.clusters - 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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Instance,CreateInstanceMetadata> createInstanceAsync(CreateInstanceRequest request)
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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<CreateInstanceRequest,Instance,CreateInstanceMetadata> createInstanceOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<CreateInstanceRequest,com.google.longrunning.Operation> createInstanceCallable()
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();
}
public final Instance getInstance(InstanceName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
Instance response = baseBigtableInstanceAdminClient.getInstance(name);
}
name - Required. The unique name of the requested instance. Values are of the form
`projects/{project}/instances/{instance}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Instance getInstance(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
String name = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
Instance response = baseBigtableInstanceAdminClient.getInstance(name);
}
name - Required. The unique name of the requested instance. Values are of the form
`projects/{project}/instances/{instance}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Instance getInstance(GetInstanceRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
GetInstanceRequest request =
GetInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
.build();
Instance response = baseBigtableInstanceAdminClient.getInstance(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final ListInstancesResponse listInstances(ProjectName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
parent - Required. The unique name of the project for which a list of instances is
requested. Values are of the form `projects/{project}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ListInstancesResponse listInstances(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
parent - Required. The unique name of the project for which a list of instances is
requested. Values are of the form `projects/{project}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ListInstancesResponse listInstances(ListInstancesRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
ListInstancesRequest request =
ListInstancesRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageToken("pageToken873572522")
.build();
ListInstancesResponse response = baseBigtableInstanceAdminClient.listInstances(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final Instance updateInstance(Instance request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<Instance,Instance> updateInstanceCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.api.gax.longrunning.OperationFuture<Instance,UpdateInstanceMetadata> partialUpdateInstanceAsync(Instance instance, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
instance - Required. The Instance which will (partially) replace the current value.updateMask - Required. The subset of Instance fields which should be replaced. Must be
explicitly set.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Instance,UpdateInstanceMetadata> partialUpdateInstanceAsync(PartialUpdateInstanceRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
PartialUpdateInstanceRequest request =
PartialUpdateInstanceRequest.newBuilder()
.setInstance(Instance.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Instance response = baseBigtableInstanceAdminClient.partialUpdateInstanceAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<PartialUpdateInstanceRequest,Instance,UpdateInstanceMetadata> partialUpdateInstanceOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.api.gax.rpc.UnaryCallable<PartialUpdateInstanceRequest,com.google.longrunning.Operation> partialUpdateInstanceCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final void deleteInstance(InstanceName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
baseBigtableInstanceAdminClient.deleteInstance(name);
}
name - Required. The unique name of the instance to be deleted. Values are of the form
`projects/{project}/instances/{instance}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteInstance(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
String name = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
baseBigtableInstanceAdminClient.deleteInstance(name);
}
name - Required. The unique name of the instance to be deleted. Values are of the form
`projects/{project}/instances/{instance}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteInstance(DeleteInstanceRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
.build();
baseBigtableInstanceAdminClient.deleteInstance(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteInstanceRequest,com.google.protobuf.Empty> deleteInstanceCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.api.gax.longrunning.OperationFuture<Cluster,CreateClusterMetadata> createClusterAsync(InstanceName parent, String clusterId, Cluster cluster)
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();
}
parent - Required. The unique name of the instance in which to create the new cluster.
Values are of the form `projects/{project}/instances/{instance}`.clusterId - 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 - Required. The cluster to be created. Fields marked `OutputOnly` must be left
blank.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Cluster,CreateClusterMetadata> createClusterAsync(String parent, String clusterId, Cluster cluster)
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();
}
parent - Required. The unique name of the instance in which to create the new cluster.
Values are of the form `projects/{project}/instances/{instance}`.clusterId - 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 - Required. The cluster to be created. Fields marked `OutputOnly` must be left
blank.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Cluster,CreateClusterMetadata> createClusterAsync(CreateClusterRequest request)
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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<CreateClusterRequest,Cluster,CreateClusterMetadata> createClusterOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<CreateClusterRequest,com.google.longrunning.Operation> createClusterCallable()
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();
}
public final Cluster getCluster(ClusterName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
ClusterName name = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
Cluster response = baseBigtableInstanceAdminClient.getCluster(name);
}
name - Required. The unique name of the requested cluster. Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Cluster getCluster(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
String name = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
Cluster response = baseBigtableInstanceAdminClient.getCluster(name);
}
name - Required. The unique name of the requested cluster. Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Cluster getCluster(GetClusterRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
GetClusterRequest request =
GetClusterRequest.newBuilder()
.setName(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
.build();
Cluster response = baseBigtableInstanceAdminClient.getCluster(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetClusterRequest,Cluster> getClusterCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final ListClustersResponse listClusters(InstanceName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
parent - 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/-`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ListClustersResponse listClusters(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
parent - 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/-`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ListClustersResponse listClusters(ListClustersRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
ListClustersRequest request =
ListClustersRequest.newBuilder()
.setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
.setPageToken("pageToken873572522")
.build();
ListClustersResponse response = baseBigtableInstanceAdminClient.listClusters(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListClustersRequest,ListClustersResponse> listClustersCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.api.gax.longrunning.OperationFuture<Cluster,UpdateClusterMetadata> updateClusterAsync(Cluster request)
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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<Cluster,Cluster,UpdateClusterMetadata> updateClusterOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<Cluster,com.google.longrunning.Operation> updateClusterCallable()
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();
}
public final com.google.api.gax.longrunning.OperationFuture<Cluster,PartialUpdateClusterMetadata> partialUpdateClusterAsync(Cluster cluster, com.google.protobuf.FieldMask updateMask)
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();
}
cluster - Required. The Cluster which contains the partial updates to be applied, subject
to the update_mask.updateMask - Required. The subset of Cluster fields which should be replaced.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Cluster,PartialUpdateClusterMetadata> partialUpdateClusterAsync(PartialUpdateClusterRequest request)
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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<PartialUpdateClusterRequest,Cluster,PartialUpdateClusterMetadata> partialUpdateClusterOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<PartialUpdateClusterRequest,com.google.longrunning.Operation> partialUpdateClusterCallable()
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();
}
public final void deleteCluster(ClusterName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
ClusterName name = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]");
baseBigtableInstanceAdminClient.deleteCluster(name);
}
name - Required. The unique name of the cluster to be deleted. Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteCluster(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
String name = ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString();
baseBigtableInstanceAdminClient.deleteCluster(name);
}
name - Required. The unique name of the cluster to be deleted. Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteCluster(DeleteClusterRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
DeleteClusterRequest request =
DeleteClusterRequest.newBuilder()
.setName(ClusterName.of("[PROJECT]", "[INSTANCE]", "[CLUSTER]").toString())
.build();
baseBigtableInstanceAdminClient.deleteCluster(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteClusterRequest,com.google.protobuf.Empty> deleteClusterCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final AppProfile createAppProfile(InstanceName parent, String appProfileId, AppProfile appProfile)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
parent - 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 - 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 - Required. The app profile to be created. Fields marked `OutputOnly` will be
ignored.com.google.api.gax.rpc.ApiException - if the remote call failspublic final AppProfile createAppProfile(String parent, String appProfileId, AppProfile appProfile)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
parent - 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 - 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 - Required. The app profile to be created. Fields marked `OutputOnly` will be
ignored.com.google.api.gax.rpc.ApiException - if the remote call failspublic final AppProfile createAppProfile(CreateAppProfileRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateAppProfileRequest,AppProfile> createAppProfileCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final AppProfile getAppProfile(AppProfileName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
AppProfileName name = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
AppProfile response = baseBigtableInstanceAdminClient.getAppProfile(name);
}
name - Required. The unique name of the requested app profile. Values are of the form
`projects/{project}/instances/{instance}/appProfiles/{app_profile}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final AppProfile getAppProfile(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
String name = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
AppProfile response = baseBigtableInstanceAdminClient.getAppProfile(name);
}
name - Required. The unique name of the requested app profile. Values are of the form
`projects/{project}/instances/{instance}/appProfiles/{app_profile}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final AppProfile getAppProfile(GetAppProfileRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
GetAppProfileRequest request =
GetAppProfileRequest.newBuilder()
.setName(AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString())
.build();
AppProfile response = baseBigtableInstanceAdminClient.getAppProfile(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetAppProfileRequest,AppProfile> getAppProfileCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse listAppProfiles(InstanceName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
parent - 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/-`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse listAppProfiles(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
parent - 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/-`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse listAppProfiles(ListAppProfilesRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListAppProfilesRequest,BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse> listAppProfilesPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListAppProfilesRequest,ListAppProfilesResponse> listAppProfilesCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<AppProfile,UpdateAppProfileMetadata> updateAppProfileAsync(AppProfile appProfile, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
appProfile - Required. The app profile which will (partially) replace the current value.updateMask - Required. The subset of app profile fields which should be replaced. If
unset, all fields will be replaced.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<AppProfile,UpdateAppProfileMetadata> updateAppProfileAsync(UpdateAppProfileRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<UpdateAppProfileRequest,AppProfile,UpdateAppProfileMetadata> updateAppProfileOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.api.gax.rpc.UnaryCallable<UpdateAppProfileRequest,com.google.longrunning.Operation> updateAppProfileCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final void deleteAppProfile(AppProfileName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
AppProfileName name = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]");
baseBigtableInstanceAdminClient.deleteAppProfile(name);
}
name - Required. The unique name of the app profile to be deleted. Values are of the form
`projects/{project}/instances/{instance}/appProfiles/{app_profile}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteAppProfile(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
String name = AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString();
baseBigtableInstanceAdminClient.deleteAppProfile(name);
}
name - Required. The unique name of the app profile to be deleted. Values are of the form
`projects/{project}/instances/{instance}/appProfiles/{app_profile}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteAppProfile(AppProfileName name, boolean ignoreWarnings)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
name - Required. The unique name of the app profile to be deleted. Values are of the form
`projects/{project}/instances/{instance}/appProfiles/{app_profile}`.ignoreWarnings - Required. If true, ignore safety checks when deleting the app profile.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteAppProfile(String name, boolean ignoreWarnings)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
name - Required. The unique name of the app profile to be deleted. Values are of the form
`projects/{project}/instances/{instance}/appProfiles/{app_profile}`.ignoreWarnings - Required. If true, ignore safety checks when deleting the app profile.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteAppProfile(DeleteAppProfileRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
DeleteAppProfileRequest request =
DeleteAppProfileRequest.newBuilder()
.setName(AppProfileName.of("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]").toString())
.setIgnoreWarnings(true)
.build();
baseBigtableInstanceAdminClient.deleteAppProfile(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteAppProfileRequest,com.google.protobuf.Empty> deleteAppProfileCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.iam.v1.Policy getIamPolicy(com.google.api.resourcenames.ResourceName 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]");
Policy response = baseBigtableInstanceAdminClient.getIamPolicy(resource);
}
resource - REQUIRED: The resource for which the policy is being requested. See the
operation documentation for the appropriate value for this field.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.Policy getIamPolicy(String 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();
Policy response = baseBigtableInstanceAdminClient.getIamPolicy(resource);
}
resource - REQUIRED: The resource for which the policy is being requested. See the
operation documentation for the appropriate value for this field.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = baseBigtableInstanceAdminClient.getIamPolicy(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.iam.v1.Policy setIamPolicy(com.google.api.resourcenames.ResourceName resource,
com.google.iam.v1.Policy 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);
}
resource - REQUIRED: The resource for which the policy is being specified. See the
operation documentation for the appropriate value for this field.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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.Policy setIamPolicy(String resource, com.google.iam.v1.Policy 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);
}
resource - REQUIRED: The resource for which the policy is being specified. See the
operation documentation for the appropriate value for this field.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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.api.resourcenames.ResourceName resource,
List<String> permissions)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
resource - REQUIRED: The resource for which the policy detail is being requested. See the
operation documentation for the appropriate value for this field.permissions - 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](https://cloud.google.com/iam/docs/overview#permissions).com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(String resource, List<String> permissions)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
resource - REQUIRED: The resource for which the policy detail is being requested. See the
operation documentation for the appropriate value for this field.permissions - 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](https://cloud.google.com/iam/docs/overview#permissions).com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response =
baseBigtableInstanceAdminClient.testIamPermissions(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse listHotTablets(ClusterName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
parent - Required. The cluster name to list hot tablets. Value is in the following form:
`projects/{project}/instances/{instance}/clusters/{cluster}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse listHotTablets(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
parent - Required. The cluster name to list hot tablets. Value is in the following form:
`projects/{project}/instances/{instance}/clusters/{cluster}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse listHotTablets(ListHotTabletsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListHotTabletsRequest,BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse> listHotTabletsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListHotTabletsRequest,ListHotTabletsResponse> listHotTabletsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<LogicalView,CreateLogicalViewMetadata> createLogicalViewAsync(InstanceName parent, LogicalView logicalView, String logicalViewId)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
parent - Required. The parent instance where this logical view will be created. Format:
`projects/{project}/instances/{instance}`.logicalView - Required. The logical view to create.logicalViewId - Required. The ID to use for the logical view, which will become the final
component of the logical view's resource name.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<LogicalView,CreateLogicalViewMetadata> createLogicalViewAsync(String parent, LogicalView logicalView, String logicalViewId)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
parent - Required. The parent instance where this logical view will be created. Format:
`projects/{project}/instances/{instance}`.logicalView - Required. The logical view to create.logicalViewId - Required. The ID to use for the logical view, which will become the final
component of the logical view's resource name.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<LogicalView,CreateLogicalViewMetadata> createLogicalViewAsync(CreateLogicalViewRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<CreateLogicalViewRequest,LogicalView,CreateLogicalViewMetadata> createLogicalViewOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.api.gax.rpc.UnaryCallable<CreateLogicalViewRequest,com.google.longrunning.Operation> createLogicalViewCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final LogicalView getLogicalView(LogicalViewName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
LogicalViewName name = LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]");
LogicalView response = baseBigtableInstanceAdminClient.getLogicalView(name);
}
name - Required. The unique name of the requested logical view. Values are of the form
`projects/{project}/instances/{instance}/logicalViews/{logical_view}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final LogicalView getLogicalView(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
String name = LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]").toString();
LogicalView response = baseBigtableInstanceAdminClient.getLogicalView(name);
}
name - Required. The unique name of the requested logical view. Values are of the form
`projects/{project}/instances/{instance}/logicalViews/{logical_view}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final LogicalView getLogicalView(GetLogicalViewRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
GetLogicalViewRequest request =
GetLogicalViewRequest.newBuilder()
.setName(LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]").toString())
.build();
LogicalView response = baseBigtableInstanceAdminClient.getLogicalView(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetLogicalViewRequest,LogicalView> getLogicalViewCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse listLogicalViews(InstanceName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
parent - 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}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse listLogicalViews(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
parent - 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}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse listLogicalViews(ListLogicalViewsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListLogicalViewsRequest,BaseBigtableInstanceAdminClient.ListLogicalViewsPagedResponse> listLogicalViewsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListLogicalViewsRequest,ListLogicalViewsResponse> listLogicalViewsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<LogicalView,UpdateLogicalViewMetadata> updateLogicalViewAsync(LogicalView logicalView, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
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 - Optional. The list of fields to update.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<LogicalView,UpdateLogicalViewMetadata> updateLogicalViewAsync(UpdateLogicalViewRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
UpdateLogicalViewRequest request =
UpdateLogicalViewRequest.newBuilder()
.setLogicalView(LogicalView.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
LogicalView response = baseBigtableInstanceAdminClient.updateLogicalViewAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<UpdateLogicalViewRequest,LogicalView,UpdateLogicalViewMetadata> updateLogicalViewOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.api.gax.rpc.UnaryCallable<UpdateLogicalViewRequest,com.google.longrunning.Operation> updateLogicalViewCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final void deleteLogicalView(LogicalViewName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
LogicalViewName name = LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]");
baseBigtableInstanceAdminClient.deleteLogicalView(name);
}
name - Required. The unique name of the logical view to be deleted. Format:
`projects/{project}/instances/{instance}/logicalViews/{logical_view}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteLogicalView(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
String name = LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]").toString();
baseBigtableInstanceAdminClient.deleteLogicalView(name);
}
name - Required. The unique name of the logical view to be deleted. Format:
`projects/{project}/instances/{instance}/logicalViews/{logical_view}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteLogicalView(DeleteLogicalViewRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
DeleteLogicalViewRequest request =
DeleteLogicalViewRequest.newBuilder()
.setName(LogicalViewName.of("[PROJECT]", "[INSTANCE]", "[LOGICAL_VIEW]").toString())
.setEtag("etag3123477")
.build();
baseBigtableInstanceAdminClient.deleteLogicalView(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteLogicalViewRequest,com.google.protobuf.Empty> deleteLogicalViewCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.api.gax.longrunning.OperationFuture<MaterializedView,CreateMaterializedViewMetadata> createMaterializedViewAsync(InstanceName parent, MaterializedView materializedView, String materializedViewId)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
parent - Required. The parent instance where this materialized view will be created.
Format: `projects/{project}/instances/{instance}`.materializedView - Required. The materialized view to create.materializedViewId - Required. The ID to use for the materialized view, which will become
the final component of the materialized view's resource name.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<MaterializedView,CreateMaterializedViewMetadata> createMaterializedViewAsync(String parent, MaterializedView materializedView, String materializedViewId)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
parent - Required. The parent instance where this materialized view will be created.
Format: `projects/{project}/instances/{instance}`.materializedView - Required. The materialized view to create.materializedViewId - Required. The ID to use for the materialized view, which will become
the final component of the materialized view's resource name.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<MaterializedView,CreateMaterializedViewMetadata> createMaterializedViewAsync(CreateMaterializedViewRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<CreateMaterializedViewRequest,MaterializedView,CreateMaterializedViewMetadata> createMaterializedViewOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.api.gax.rpc.UnaryCallable<CreateMaterializedViewRequest,com.google.longrunning.Operation> createMaterializedViewCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final MaterializedView getMaterializedView(MaterializedViewName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
MaterializedViewName name =
MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]");
MaterializedView response = baseBigtableInstanceAdminClient.getMaterializedView(name);
}
name - Required. The unique name of the requested materialized view. Values are of the
form `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final MaterializedView getMaterializedView(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
String name =
MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]").toString();
MaterializedView response = baseBigtableInstanceAdminClient.getMaterializedView(name);
}
name - Required. The unique name of the requested materialized view. Values are of the
form `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final MaterializedView getMaterializedView(GetMaterializedViewRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
GetMaterializedViewRequest request =
GetMaterializedViewRequest.newBuilder()
.setName(
MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]")
.toString())
.build();
MaterializedView response = baseBigtableInstanceAdminClient.getMaterializedView(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetMaterializedViewRequest,MaterializedView> getMaterializedViewCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse listMaterializedViews(InstanceName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
parent - 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}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse listMaterializedViews(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
parent - 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}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse listMaterializedViews(ListMaterializedViewsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListMaterializedViewsRequest,BaseBigtableInstanceAdminClient.ListMaterializedViewsPagedResponse> listMaterializedViewsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListMaterializedViewsRequest,ListMaterializedViewsResponse> listMaterializedViewsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<MaterializedView,UpdateMaterializedViewMetadata> updateMaterializedViewAsync(MaterializedView materializedView, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
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 - Optional. The list of fields to update.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<MaterializedView,UpdateMaterializedViewMetadata> updateMaterializedViewAsync(UpdateMaterializedViewRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
UpdateMaterializedViewRequest request =
UpdateMaterializedViewRequest.newBuilder()
.setMaterializedView(MaterializedView.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
MaterializedView response =
baseBigtableInstanceAdminClient.updateMaterializedViewAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<UpdateMaterializedViewRequest,MaterializedView,UpdateMaterializedViewMetadata> updateMaterializedViewOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final com.google.api.gax.rpc.UnaryCallable<UpdateMaterializedViewRequest,com.google.longrunning.Operation> updateMaterializedViewCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final void deleteMaterializedView(MaterializedViewName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
MaterializedViewName name =
MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]");
baseBigtableInstanceAdminClient.deleteMaterializedView(name);
}
name - Required. The unique name of the materialized view to be deleted. Format:
`projects/{project}/instances/{instance}/materializedViews/{materialized_view}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteMaterializedView(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
String name =
MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]").toString();
baseBigtableInstanceAdminClient.deleteMaterializedView(name);
}
name - Required. The unique name of the materialized view to be deleted. Format:
`projects/{project}/instances/{instance}/materializedViews/{materialized_view}`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteMaterializedView(DeleteMaterializedViewRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
BaseBigtableInstanceAdminClient.create()) {
DeleteMaterializedViewRequest request =
DeleteMaterializedViewRequest.newBuilder()
.setName(
MaterializedViewName.of("[PROJECT]", "[INSTANCE]", "[MATERIALIZED_VIEW]")
.toString())
.setEtag("etag3123477")
.build();
baseBigtableInstanceAdminClient.deleteMaterializedView(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteMaterializedViewRequest,com.google.protobuf.Empty> deleteMaterializedViewCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2026 Google LLC. All rights reserved.