com.google.cloud.bigtable.grpc

Interface BigtableInstanceClient

All Known Implementing Classes:

BigtableInstanceGrpcClient

public interface BigtableInstanceClient

BigtableInstanceClient manages instances and clusters.

Version:

$Id: $Id

Author:

sduskis

Method Summary

Modifier and Type	Method and Description
com.google.longrunning.Operation	createInstance(com.google.bigtable.admin.v2.CreateInstanceRequest request) Create an instance within a project.
com.google.protobuf.Empty	deleteInstance(com.google.bigtable.admin.v2.DeleteInstanceRequest request) Updates an instance within a project.
com.google.bigtable.admin.v2.Cluster	getCluster(com.google.bigtable.admin.v2.GetClusterRequest request) Gets information about a cluster.
com.google.longrunning.Operation	getOperation(com.google.longrunning.GetOperationRequest request) Gets the latest state of a long-running operation.
com.google.bigtable.admin.v2.ListClustersResponse	listCluster(com.google.bigtable.admin.v2.ListClustersRequest request) Lists information about clusters in an instance.
com.google.bigtable.admin.v2.ListInstancesResponse	listInstances(com.google.bigtable.admin.v2.ListInstancesRequest request) Lists all instances in the given project.
com.google.longrunning.Operation	updateCluster(com.google.bigtable.admin.v2.Cluster cluster) Updates a cluster within an instance.
com.google.bigtable.admin.v2.Instance	updateInstance(com.google.bigtable.admin.v2.Instance instance) Updates an instance within a project.
void	waitForOperation(com.google.longrunning.Operation operation) Waits for the long running operation to complete by polling with exponential backoff.
void	waitForOperation(com.google.longrunning.Operation operation, long timeout, TimeUnit timeUnit) Waits for the long running operation to complete by polling with exponential backoff.

Method Detail

createInstance

com.google.longrunning.Operation createInstance(com.google.bigtable.admin.v2.CreateInstanceRequest request)

Create an instance within a project.

Parameters:

request - a CreateInstanceRequest object.

Returns:

a Operation object.

getOperation

com.google.longrunning.Operation getOperation(com.google.longrunning.GetOperationRequest request)

Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.

createInstance(CreateInstanceRequest) and updateCluster(Cluster) will return a Operation. Use this method and pass in the Operation's name in the request to see if the Operation is done via Operation.getDone(). The instance will not be available until that happens.

Parameters:

request - a GetOperationRequest object.

Returns:

a Operation object.

waitForOperation

void waitForOperation(com.google.longrunning.Operation operation)
               throws TimeoutException,
                      IOException

Waits for the long running operation to complete by polling with exponential backoff. A default timeout of 10 minutes is used.

Parameters:

operation -

Throws:

IOException

TimeoutException - If the timeout is exceeded.

waitForOperation

void waitForOperation(com.google.longrunning.Operation operation,
                      long timeout,
                      TimeUnit timeUnit)
               throws IOException,
                      TimeoutException

Waits for the long running operation to complete by polling with exponential backoff.

Parameters:

operation -

timeout -

timeUnit -

Throws:

IOException

TimeoutException - If the timeout is exceeded.

listInstances

com.google.bigtable.admin.v2.ListInstancesResponse listInstances(com.google.bigtable.admin.v2.ListInstancesRequest request)

Lists all instances in the given project.

Parameters:

request - a ListInstancesRequest object.

Returns:

a ListInstancesResponse object.

updateInstance

com.google.bigtable.admin.v2.Instance updateInstance(com.google.bigtable.admin.v2.Instance instance)

Updates an instance within a project.

Parameters:

instance - a Instance object.

Returns:

a Instance object.

deleteInstance

com.google.protobuf.Empty deleteInstance(com.google.bigtable.admin.v2.DeleteInstanceRequest request)

Updates an instance within a project.

Parameters:

request - a DeleteInstanceRequest object.

Returns:

a Empty object.

getCluster

com.google.bigtable.admin.v2.Cluster getCluster(com.google.bigtable.admin.v2.GetClusterRequest request)

Gets information about a cluster.

Parameters:

request - a GetClusterRequest object.

Returns:

a Cluster object.

listCluster

com.google.bigtable.admin.v2.ListClustersResponse listCluster(com.google.bigtable.admin.v2.ListClustersRequest request)

Lists information about clusters in an instance.

Parameters:

request - a ListClustersRequest object.

Returns:

a ListClustersResponse object.

updateCluster

com.google.longrunning.Operation updateCluster(com.google.bigtable.admin.v2.Cluster cluster)

Updates a cluster within an instance.

Parameters:

cluster - a Cluster object.

Returns:

a Operation object.