Class BigtableInstanceAdminGrpc.BigtableInstanceAdminBlockingStub (2.9.0)

public static final class BigtableInstanceAdminGrpc.BigtableInstanceAdminBlockingStub extends AbstractBlockingStub<BigtableInstanceAdminGrpc.BigtableInstanceAdminBlockingStub>

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.AbstractBlockingStub > BigtableInstanceAdminGrpc.BigtableInstanceAdminBlockingStub

Inherited Members

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

io.grpc.stub.AbstractBlockingStub.<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.BigtableInstanceAdminBlockingStub build(Channel channel, CallOptions callOptions)

Parameters

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

Returns

Type	Description
BigtableInstanceAdminGrpc.BigtableInstanceAdminBlockingStub

Overrides

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

createAppProfile(CreateAppProfileRequest request)

public AppProfile createAppProfile(CreateAppProfileRequest request)

Creates an app profile within an instance.

Parameter

Name	Description
request	`CreateAppProfileRequest`

Returns

Type	Description
AppProfile

createCluster(CreateClusterRequest request)

public Operation createCluster(CreateClusterRequest request)

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

Parameter

Name	Description
request	`CreateClusterRequest`

Returns

Type	Description
Operation

createInstance(CreateInstanceRequest request)

public Operation createInstance(CreateInstanceRequest request)

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

Parameter

Name	Description
request	`CreateInstanceRequest`

Returns

Type	Description
Operation

deleteAppProfile(DeleteAppProfileRequest request)

public Empty deleteAppProfile(DeleteAppProfileRequest request)

Deletes an app profile from an instance.

Parameter

Name	Description
request	`DeleteAppProfileRequest`

Returns

Type	Description
Empty

deleteCluster(DeleteClusterRequest request)

public Empty deleteCluster(DeleteClusterRequest request)

Deletes a cluster from an instance.

Parameter

Name	Description
request	`DeleteClusterRequest`

Returns

Type	Description
Empty

deleteInstance(DeleteInstanceRequest request)

public Empty deleteInstance(DeleteInstanceRequest request)

Delete an instance from a project.

Parameter

Name	Description
request	`DeleteInstanceRequest`

Returns

Type	Description
Empty

getAppProfile(GetAppProfileRequest request)

public AppProfile getAppProfile(GetAppProfileRequest request)

Gets information about an app profile.

Parameter

Name	Description
request	`GetAppProfileRequest`

Returns

Type	Description
AppProfile

getCluster(GetClusterRequest request)

public Cluster getCluster(GetClusterRequest request)

Gets information about a cluster.

Parameter

Name	Description
request	`GetClusterRequest`

Returns

Type	Description
Cluster

getIamPolicy(GetIamPolicyRequest request)

public Policy getIamPolicy(GetIamPolicyRequest request)

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

Parameter

Name	Description
request	`com.google.iam.v1.GetIamPolicyRequest`

Returns

Type	Description
com.google.iam.v1.Policy

getInstance(GetInstanceRequest request)

public Instance getInstance(GetInstanceRequest request)

Gets information about an instance.

Parameter

Name	Description
request	`GetInstanceRequest`

Returns

Type	Description
Instance

listAppProfiles(ListAppProfilesRequest request)

public ListAppProfilesResponse listAppProfiles(ListAppProfilesRequest request)

Lists information about app profiles in an instance.

Parameter

Name	Description
request	`ListAppProfilesRequest`

Returns

Type	Description
ListAppProfilesResponse

listClusters(ListClustersRequest request)

public ListClustersResponse listClusters(ListClustersRequest request)

Lists information about clusters in an instance.

Parameter

Name	Description
request	`ListClustersRequest`

Returns

Type	Description
ListClustersResponse

listHotTablets(ListHotTabletsRequest request)

public ListHotTabletsResponse listHotTablets(ListHotTabletsRequest request)

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

Parameter

Name	Description
request	`ListHotTabletsRequest`

Returns

Type	Description
ListHotTabletsResponse

listInstances(ListInstancesRequest request)

public ListInstancesResponse listInstances(ListInstancesRequest request)

Lists information about instances in a project.

Parameter

Name	Description
request	`ListInstancesRequest`

Returns

Type	Description
ListInstancesResponse

partialUpdateCluster(PartialUpdateClusterRequest request)

public Operation partialUpdateCluster(PartialUpdateClusterRequest request)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Parameter

Name	Description
request	`PartialUpdateClusterRequest`

Returns

Type	Description
Operation

partialUpdateInstance(PartialUpdateInstanceRequest request)

public Operation partialUpdateInstance(PartialUpdateInstanceRequest request)

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

Parameter

Name	Description
request	`PartialUpdateInstanceRequest`

Returns

Type	Description
Operation

setIamPolicy(SetIamPolicyRequest request)

public Policy setIamPolicy(SetIamPolicyRequest request)

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

Parameter

Name	Description
request	`com.google.iam.v1.SetIamPolicyRequest`

Returns

Type	Description
com.google.iam.v1.Policy

testIamPermissions(TestIamPermissionsRequest request)

public TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

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

Parameter

Name	Description
request	`com.google.iam.v1.TestIamPermissionsRequest`

Returns

Type	Description
com.google.iam.v1.TestIamPermissionsResponse

updateAppProfile(UpdateAppProfileRequest request)

public Operation updateAppProfile(UpdateAppProfileRequest request)

Updates an app profile within an instance.

Parameter

Name	Description
request	`UpdateAppProfileRequest`

Returns

Type	Description
Operation

updateCluster(Cluster request)

public Operation updateCluster(Cluster request)

Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

Parameter

Name	Description
request	`Cluster`

Returns

Type	Description
Operation

updateInstance(Instance request)

public Instance updateInstance(Instance request)

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

Parameter

Name	Description
request	`Instance`

Returns

Type	Description
Instance