Class BigtableInstanceAdminGrpc.BigtableInstanceAdminStub (2.7.0)

public static final class BigtableInstanceAdminGrpc.BigtableInstanceAdminStub extends AbstractAsyncStub<BigtableInstanceAdminGrpc.BigtableInstanceAdminStub>

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > BigtableInstanceAdminGrpc.BigtableInstanceAdminStub

Inherited Members

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected BigtableInstanceAdminGrpc.BigtableInstanceAdminStub build(Channel channel, CallOptions callOptions)

Parameters

Name	Description
channel	`io.grpc.Channel`
callOptions	`io.grpc.CallOptions`

Returns

Type	Description
BigtableInstanceAdminGrpc.BigtableInstanceAdminStub

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAppProfile(CreateAppProfileRequest request, StreamObserver<AppProfile> responseObserver)

public void createAppProfile(CreateAppProfileRequest request, StreamObserver<AppProfile> responseObserver)

Creates an app profile within an instance.

Parameters

Name	Description
request	`CreateAppProfileRequest`
responseObserver	`io.grpc.stub.StreamObserver<AppProfile>`

createCluster(CreateClusterRequest request, StreamObserver<Operation> responseObserver)

public void createCluster(CreateClusterRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters

Name	Description
request	`CreateClusterRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

public void createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters

Name	Description
request	`CreateInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

deleteAppProfile(DeleteAppProfileRequest request, StreamObserver<Empty> responseObserver)

public void deleteAppProfile(DeleteAppProfileRequest request, StreamObserver<Empty> responseObserver)

Deletes an app profile from an instance.

Parameters

Name	Description
request	`DeleteAppProfileRequest`
responseObserver	`io.grpc.stub.StreamObserver<Empty>`

deleteCluster(DeleteClusterRequest request, StreamObserver<Empty> responseObserver)

public void deleteCluster(DeleteClusterRequest request, StreamObserver<Empty> responseObserver)

Deletes a cluster from an instance.

Parameters

Name	Description
request	`DeleteClusterRequest`
responseObserver	`io.grpc.stub.StreamObserver<Empty>`

deleteInstance(DeleteInstanceRequest request, StreamObserver<Empty> responseObserver)

public void deleteInstance(DeleteInstanceRequest request, StreamObserver<Empty> responseObserver)

Delete an instance from a project.

Parameters

Name	Description
request	`DeleteInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Empty>`

getAppProfile(GetAppProfileRequest request, StreamObserver<AppProfile> responseObserver)

public void getAppProfile(GetAppProfileRequest request, StreamObserver<AppProfile> responseObserver)

Gets information about an app profile.

Parameters

Name	Description
request	`GetAppProfileRequest`
responseObserver	`io.grpc.stub.StreamObserver<AppProfile>`

getCluster(GetClusterRequest request, StreamObserver<Cluster> responseObserver)

public void getCluster(GetClusterRequest request, StreamObserver<Cluster> responseObserver)

Gets information about a cluster.

Parameters

Name	Description
request	`GetClusterRequest`
responseObserver	`io.grpc.stub.StreamObserver<Cluster>`

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public void getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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

Parameters

Name	Description
request	`com.google.iam.v1.GetIamPolicyRequest`
responseObserver	`io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>`

getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

public void getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

Gets information about an instance.

Parameters

Name	Description
request	`GetInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Instance>`

listAppProfiles(ListAppProfilesRequest request, StreamObserver<ListAppProfilesResponse> responseObserver)

public void listAppProfiles(ListAppProfilesRequest request, StreamObserver<ListAppProfilesResponse> responseObserver)

Lists information about app profiles in an instance.

Parameters

Name	Description
request	`ListAppProfilesRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListAppProfilesResponse>`

listClusters(ListClustersRequest request, StreamObserver<ListClustersResponse> responseObserver)

public void listClusters(ListClustersRequest request, StreamObserver<ListClustersResponse> responseObserver)

Lists information about clusters in an instance.

Parameters

Name	Description
request	`ListClustersRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListClustersResponse>`

listHotTablets(ListHotTabletsRequest request, StreamObserver<ListHotTabletsResponse> responseObserver)

public void listHotTablets(ListHotTabletsRequest request, StreamObserver<ListHotTabletsResponse> responseObserver)

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

Parameters

Name	Description
request	`ListHotTabletsRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListHotTabletsResponse>`

listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

public void listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

Lists information about instances in a project.

Parameters

Name	Description
request	`ListInstancesRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListInstancesResponse>`

partialUpdateCluster(PartialUpdateClusterRequest request, StreamObserver<Operation> responseObserver)

public void partialUpdateCluster(PartialUpdateClusterRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters

Name	Description
request	`PartialUpdateClusterRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

partialUpdateInstance(PartialUpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

public void partialUpdateInstance(PartialUpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters

Name	Description
request	`PartialUpdateInstanceRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

Sets the access control policy on an instance resource. Replaces any existing policy.

Parameters

Name	Description
request	`com.google.iam.v1.SetIamPolicyRequest`
responseObserver	`io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>`

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

public void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

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

Parameters

Name	Description
request	`com.google.iam.v1.TestIamPermissionsRequest`
responseObserver	`io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>`

updateAppProfile(UpdateAppProfileRequest request, StreamObserver<Operation> responseObserver)

public void updateAppProfile(UpdateAppProfileRequest request, StreamObserver<Operation> responseObserver)

Updates an app profile within an instance.

Parameters

Name	Description
request	`UpdateAppProfileRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

updateCluster(Cluster request, StreamObserver<Operation> responseObserver)

public void updateCluster(Cluster request, StreamObserver<Operation> responseObserver)

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.

Parameters

Name	Description
request	`Cluster`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

updateInstance(Instance request, StreamObserver<Instance> responseObserver)

public void updateInstance(Instance request, StreamObserver<Instance> responseObserver)

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.

Parameters

Name	Description
request	`Instance`
responseObserver	`io.grpc.stub.StreamObserver<Instance>`