com.google.cloud.bigtable.grpc

Class BigtableClusterAdminGrpcClient

java.lang.Object

com.google.cloud.bigtable.grpc.BigtableClusterAdminGrpcClient

All Implemented Interfaces:

BigtableClusterAdminClient, AutoCloseable

public class BigtableClusterAdminGrpcClient
extends Object
implements BigtableClusterAdminClient

A gRPC client for accessing the Bigtable Cluster Admin API.

Constructor Summary

Constructors

Constructor and Description
BigtableClusterAdminGrpcClient(io.grpc.Channel channel)

Method Summary

Modifier and Type	Method and Description
void	close()
Cluster	createCluster(CreateClusterRequest request) Creates a cluster and begins preparing it to begin serving.
void	deleteCluster(DeleteClusterRequest request) Marks a cluster and all of its tables for permanent deletion in 7 days.
Cluster	getCluster(GetClusterRequest request) Gets information about a particular cluster.
Operation	getOperation(GetOperationRequest request) Gets the latest state of a long-running operation.
ListClustersResponse	listClusters(ListClustersRequest request) Lists all clusters in the given project, along with any zones for which cluster information could not be retrieved.
ListZonesResponse	listZones(ListZonesRequest request) Lists the names of all zones for a given project.
Cluster	updateCluster(Cluster cluster) Updates a cluster, and begins allocating or releasing resources as requested.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BigtableClusterAdminGrpcClient

public BigtableClusterAdminGrpcClient(io.grpc.Channel channel)

Method Detail

listZones

public ListZonesResponse listZones(ListZonesRequest request)

Description copied from interface: BigtableClusterAdminClient

Lists the names of all zones for a given project.

Specified by:

listZones in interface BigtableClusterAdminClient

listClusters

public ListClustersResponse listClusters(ListClustersRequest request)

Description copied from interface: BigtableClusterAdminClient

Lists all clusters in the given project, along with any zones for which cluster information could not be retrieved.

Specified by:

listClusters in interface BigtableClusterAdminClient

getCluster

public Cluster getCluster(GetClusterRequest request)

Description copied from interface: BigtableClusterAdminClient

Gets information about a particular cluster.

Specified by:

getCluster in interface BigtableClusterAdminClient

getOperation

public Operation getOperation(GetOperationRequest request)

Description copied from interface: BigtableClusterAdminClient

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.

BigtableClusterAdminClient.createCluster(CreateClusterRequest) will return a Cluster with a set Cluster.getCurrentOperation(). Use this method and pass in the Operation's name in the request to see if the Operation is done via Operation.getDone(). The cluster will not be created until that happens.

Specified by:

getOperation in interface BigtableClusterAdminClient

createCluster

public Cluster createCluster(CreateClusterRequest request)

Description copied from interface: BigtableClusterAdminClient

Creates a cluster and begins preparing it to begin serving. The returned cluster embeds as its "current_operation" a long-running operation which can be used to track the progress of turning up the new cluster. Immediately upon completion of this request:

• The cluster will be readable via the API, with all requested attributes but no allocated resources.

Until completion of the embedded operation:

• Cancelling the operation will render the cluster immediately unreadable via the API.
• All other attempts to modify or delete the cluster will be rejected.

Upon completion of the embedded operation:

• Billing for all successfully-allocated resources will begin (some types may have lower than the requested levels).
• New tables can be created in the cluster.
• The cluster's allocated resource levels will be readable via the API.

The embedded operation's "metadata" field type is [CreateClusterMetadata][google.bigtable.admin.cluster.v1.CreateClusterMetadata] The embedded operation's "response" field type is [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.

Specified by:

createCluster in interface BigtableClusterAdminClient

updateCluster

public Cluster updateCluster(Cluster cluster)

Description copied from interface: BigtableClusterAdminClient

Updates a cluster, and begins allocating or releasing resources as requested. The returned cluster embeds as its "current_operation" a long-running operation which can be used to track the progress of updating the cluster. Immediately upon completion of this request: * For resource types where a decrease in the cluster's allocation has been requested, billing will be based on the newly-requested level. Until completion of the embedded operation: * Cancelling the operation will set its metadata's "cancelled_at_time", and begin restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it will terminate with a CANCELLED status. * All other attempts to modify or delete the cluster will be rejected. * Reading the cluster via the API will continue to give the pre-request resource levels. Upon completion of the embedded operation: * Billing will begin for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources will be available for serving the cluster's tables. * The cluster's new resource levels will be readable via the API. [UpdateClusterMetadata][google.bigtable.admin.cluster.v1.UpdateClusterMetadata] (-- NOLINT --) The embedded operation's "response" field type is [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.

Specified by:

updateCluster in interface BigtableClusterAdminClient

deleteCluster

public void deleteCluster(DeleteClusterRequest request)

Description copied from interface: BigtableClusterAdminClient

Marks a cluster and all of its tables for permanent deletion in 7 days. Immediately upon completion of the request: * Billing will cease for all of the cluster's reserved resources. * The cluster's "delete_time" field will be set 7 days in the future. Soon afterward: * All tables within the cluster will become unavailable. Prior to the cluster's "delete_time": * The cluster can be recovered with a call to UndeleteCluster. * All other attempts to modify or delete the cluster will be rejected. At the cluster's "delete_time": * The cluster and *all of its tables* will immediately and irrevocably disappear from the API, and their data will be permanently deleted.

Specified by:

deleteCluster in interface BigtableClusterAdminClient

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception