BaseBigtableInstanceAdminClient (Google Cloud 0.89.0-alpha API)

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

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class BaseBigtableInstanceAdminClient
extends Object
implements BackgroundResource
```
Service Description: Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
```
 
 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().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of BaseBigtableInstanceAdminSettings to create(). For example:
To customize credentials:
```
 
 BaseBigtableInstanceAdminSettings baseBigtableInstanceAdminSettings =
     BaseBigtableInstanceAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create(baseBigtableInstanceAdminSettings);
 
 
```
To customize the endpoint:
```
 
 BaseBigtableInstanceAdminSettings baseBigtableInstanceAdminSettings =
     BaseBigtableInstanceAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 BaseBigtableInstanceAdminClient baseBigtableInstanceAdminClient =
     BaseBigtableInstanceAdminClient.create(baseBigtableInstanceAdminSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseBigtableInstanceAdminClient.ListAppProfilesFixedSizeCollection`
`static class`	`BaseBigtableInstanceAdminClient.ListAppProfilesPage`
`static class`	`BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseBigtableInstanceAdminClient(BaseBigtableInstanceAdminSettings settings)` Constructs an instance of BaseBigtableInstanceAdminClient, using the given settings.
`protected`	`BaseBigtableInstanceAdminClient(BigtableInstanceAdminStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static BaseBigtableInstanceAdminClient`	`create()` Constructs an instance of BaseBigtableInstanceAdminClient with default settings.
`static BaseBigtableInstanceAdminClient`	`create(BaseBigtableInstanceAdminSettings settings)` Constructs an instance of BaseBigtableInstanceAdminClient, using the given settings.
`static BaseBigtableInstanceAdminClient`	`create(BigtableInstanceAdminStub stub)` Constructs an instance of BaseBigtableInstanceAdminClient, using the given stub for making calls.
`com.google.bigtable.admin.v2.AppProfile`	`createAppProfile(com.google.bigtable.admin.v2.CreateAppProfileRequest request)` Creates an app profile within an instance.
`com.google.bigtable.admin.v2.AppProfile`	`createAppProfile(com.google.bigtable.admin.v2.InstanceName parent, String appProfileId, com.google.bigtable.admin.v2.AppProfile appProfile)` Creates an app profile within an instance.
`com.google.bigtable.admin.v2.AppProfile`	`createAppProfile(String parent, String appProfileId, com.google.bigtable.admin.v2.AppProfile appProfile)` Creates an app profile within an instance.
`UnaryCallable<com.google.bigtable.admin.v2.CreateAppProfileRequest,com.google.bigtable.admin.v2.AppProfile>`	`createAppProfileCallable()` Creates an app profile within an instance.
`OperationFuture<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata>`	`createClusterAsync(com.google.bigtable.admin.v2.CreateClusterRequest request)` Creates a cluster within an instance.
`OperationFuture<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata>`	`createClusterAsync(com.google.bigtable.admin.v2.InstanceName parent, String clusterId, com.google.bigtable.admin.v2.Cluster cluster)` Creates a cluster within an instance.
`OperationFuture<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata>`	`createClusterAsync(String parent, String clusterId, com.google.bigtable.admin.v2.Cluster cluster)` Creates a cluster within an instance.
`UnaryCallable<com.google.bigtable.admin.v2.CreateClusterRequest,Operation>`	`createClusterCallable()` Creates a cluster within an instance.
`OperationCallable<com.google.bigtable.admin.v2.CreateClusterRequest,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata>`	`createClusterOperationCallable()` Creates a cluster within an instance.
`OperationFuture<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata>`	`createInstanceAsync(com.google.bigtable.admin.v2.CreateInstanceRequest request)` Create an instance within a project.
`OperationFuture<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata>`	`createInstanceAsync(com.google.bigtable.admin.v2.ProjectName parent, String instanceId, com.google.bigtable.admin.v2.Instance instance, Map<String,com.google.bigtable.admin.v2.Cluster> clusters)` Create an instance within a project.
`OperationFuture<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata>`	`createInstanceAsync(String parent, String instanceId, com.google.bigtable.admin.v2.Instance instance, Map<String,com.google.bigtable.admin.v2.Cluster> clusters)` Create an instance within a project.
`UnaryCallable<com.google.bigtable.admin.v2.CreateInstanceRequest,Operation>`	`createInstanceCallable()` Create an instance within a project.
`OperationCallable<com.google.bigtable.admin.v2.CreateInstanceRequest,com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata>`	`createInstanceOperationCallable()` Create an instance within a project.
`void`	`deleteAppProfile(com.google.bigtable.admin.v2.AppProfileName name)` Deletes an app profile from an instance.
`void`	`deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest request)` Deletes an app profile from an instance.
`void`	`deleteAppProfile(String name)` Deletes an app profile from an instance.
`UnaryCallable<com.google.bigtable.admin.v2.DeleteAppProfileRequest,Empty>`	`deleteAppProfileCallable()` Deletes an app profile from an instance.
`void`	`deleteCluster(com.google.bigtable.admin.v2.ClusterName name)` Deletes a cluster from an instance.
`void`	`deleteCluster(com.google.bigtable.admin.v2.DeleteClusterRequest request)` Deletes a cluster from an instance.
`void`	`deleteCluster(String name)` Deletes a cluster from an instance.
`UnaryCallable<com.google.bigtable.admin.v2.DeleteClusterRequest,Empty>`	`deleteClusterCallable()` Deletes a cluster from an instance.
`void`	`deleteInstance(com.google.bigtable.admin.v2.DeleteInstanceRequest request)` Delete an instance from a project.
`void`	`deleteInstance(com.google.bigtable.admin.v2.InstanceName name)` Delete an instance from a project.
`void`	`deleteInstance(String name)` Delete an instance from a project.
`UnaryCallable<com.google.bigtable.admin.v2.DeleteInstanceRequest,Empty>`	`deleteInstanceCallable()` Delete an instance from a project.
`com.google.bigtable.admin.v2.AppProfile`	`getAppProfile(com.google.bigtable.admin.v2.AppProfileName name)` Gets information about an app profile.
`com.google.bigtable.admin.v2.AppProfile`	`getAppProfile(com.google.bigtable.admin.v2.GetAppProfileRequest request)` Gets information about an app profile.
`com.google.bigtable.admin.v2.AppProfile`	`getAppProfile(String name)` Gets information about an app profile.
`UnaryCallable<com.google.bigtable.admin.v2.GetAppProfileRequest,com.google.bigtable.admin.v2.AppProfile>`	`getAppProfileCallable()` Gets information about an app profile.
`com.google.bigtable.admin.v2.Cluster`	`getCluster(com.google.bigtable.admin.v2.ClusterName name)` Gets information about a cluster.
`com.google.bigtable.admin.v2.Cluster`	`getCluster(com.google.bigtable.admin.v2.GetClusterRequest request)` Gets information about a cluster.
`com.google.bigtable.admin.v2.Cluster`	`getCluster(String name)` Gets information about a cluster.
`UnaryCallable<com.google.bigtable.admin.v2.GetClusterRequest,com.google.bigtable.admin.v2.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(String resource)` Gets the access control policy for an instance resource.
`UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for an instance resource.
`com.google.bigtable.admin.v2.Instance`	`getInstance(com.google.bigtable.admin.v2.GetInstanceRequest request)` Gets information about an instance.
`com.google.bigtable.admin.v2.Instance`	`getInstance(com.google.bigtable.admin.v2.InstanceName name)` Gets information about an instance.
`com.google.bigtable.admin.v2.Instance`	`getInstance(String name)` Gets information about an instance.
`UnaryCallable<com.google.bigtable.admin.v2.GetInstanceRequest,com.google.bigtable.admin.v2.Instance>`	`getInstanceCallable()` Gets information about an instance.
`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(com.google.bigtable.admin.v2.InstanceName parent)` Lists information about app profiles in an instance.
`BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse`	`listAppProfiles(com.google.bigtable.admin.v2.ListAppProfilesRequest request)` Lists information about app profiles in an instance.
`BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse`	`listAppProfiles(String parent)` Lists information about app profiles in an instance.
`UnaryCallable<com.google.bigtable.admin.v2.ListAppProfilesRequest,com.google.bigtable.admin.v2.ListAppProfilesResponse>`	`listAppProfilesCallable()` Lists information about app profiles in an instance.
`UnaryCallable<com.google.bigtable.admin.v2.ListAppProfilesRequest,BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse>`	`listAppProfilesPagedCallable()` Lists information about app profiles in an instance.
`com.google.bigtable.admin.v2.ListClustersResponse`	`listClusters(com.google.bigtable.admin.v2.InstanceName parent)` Lists information about clusters in an instance.
`com.google.bigtable.admin.v2.ListClustersResponse`	`listClusters(com.google.bigtable.admin.v2.ListClustersRequest request)` Lists information about clusters in an instance.
`com.google.bigtable.admin.v2.ListClustersResponse`	`listClusters(String parent)` Lists information about clusters in an instance.
`UnaryCallable<com.google.bigtable.admin.v2.ListClustersRequest,com.google.bigtable.admin.v2.ListClustersResponse>`	`listClustersCallable()` Lists information about clusters in an instance.
`com.google.bigtable.admin.v2.ListInstancesResponse`	`listInstances(com.google.bigtable.admin.v2.ListInstancesRequest request)` Lists information about instances in a project.
`com.google.bigtable.admin.v2.ListInstancesResponse`	`listInstances(com.google.bigtable.admin.v2.ProjectName parent)` Lists information about instances in a project.
`com.google.bigtable.admin.v2.ListInstancesResponse`	`listInstances(String parent)` Lists information about instances in a project.
`UnaryCallable<com.google.bigtable.admin.v2.ListInstancesRequest,com.google.bigtable.admin.v2.ListInstancesResponse>`	`listInstancesCallable()` Lists information about instances in a project.
`OperationFuture<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.UpdateInstanceMetadata>`	`partialUpdateInstanceAsync(com.google.bigtable.admin.v2.Instance instance, FieldMask updateMask)` Partially updates an instance within a project.
`OperationFuture<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.UpdateInstanceMetadata>`	`partialUpdateInstanceAsync(com.google.bigtable.admin.v2.PartialUpdateInstanceRequest request)` Partially updates an instance within a project.
`UnaryCallable<com.google.bigtable.admin.v2.PartialUpdateInstanceRequest,Operation>`	`partialUpdateInstanceCallable()` Partially updates an instance within a project.
`OperationCallable<com.google.bigtable.admin.v2.PartialUpdateInstanceRequest,com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.UpdateInstanceMetadata>`	`partialUpdateInstanceOperationCallable()` Partially updates an instance within a project.
`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.
`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(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.
`UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that the caller has on the specified instance resource.
`OperationFuture<com.google.bigtable.admin.v2.AppProfile,com.google.bigtable.admin.v2.UpdateAppProfileMetadata>`	`updateAppProfileAsync(com.google.bigtable.admin.v2.AppProfile appProfile, FieldMask updateMask)` Updates an app profile within an instance.
`OperationFuture<com.google.bigtable.admin.v2.AppProfile,com.google.bigtable.admin.v2.UpdateAppProfileMetadata>`	`updateAppProfileAsync(com.google.bigtable.admin.v2.UpdateAppProfileRequest request)` Updates an app profile within an instance.
`UnaryCallable<com.google.bigtable.admin.v2.UpdateAppProfileRequest,Operation>`	`updateAppProfileCallable()` Updates an app profile within an instance.
`OperationCallable<com.google.bigtable.admin.v2.UpdateAppProfileRequest,com.google.bigtable.admin.v2.AppProfile,com.google.bigtable.admin.v2.UpdateAppProfileMetadata>`	`updateAppProfileOperationCallable()` Updates an app profile within an instance.
`OperationFuture<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.UpdateClusterMetadata>`	`updateClusterAsync(com.google.bigtable.admin.v2.Cluster request)` Updates a cluster within an instance.
`UnaryCallable<com.google.bigtable.admin.v2.Cluster,Operation>`	`updateClusterCallable()` Updates a cluster within an instance.
`OperationCallable<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.UpdateClusterMetadata>`	`updateClusterOperationCallable()` Updates a cluster within an instance.

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

Constructor Detail

BaseBigtableInstanceAdminClient
```
protected BaseBigtableInstanceAdminClient(BaseBigtableInstanceAdminSettings settings)
                                   throws IOException
```
Constructs an instance of BaseBigtableInstanceAdminClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

BaseBigtableInstanceAdminClient

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

Method Detail

create

public static final BaseBigtableInstanceAdminClient create()
                                                    throws IOException

Constructs an instance of BaseBigtableInstanceAdminClient with default settings.

Throws:: IOException

create
```
public static final BaseBigtableInstanceAdminClient create(BaseBigtableInstanceAdminSettings settings)
                                                    throws IOException
```
Constructs an instance of BaseBigtableInstanceAdminClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final BaseBigtableInstanceAdminClient create(BigtableInstanceAdminStub stub)

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

getSettings

public final BaseBigtableInstanceAdminSettings getSettings()

getStub

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

getOperationsClient

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

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