com.google.cloud.bigtable.grpc

Class BigtableSession

java.lang.Object

com.google.cloud.bigtable.grpc.BigtableSession

All Implemented Interfaces:

Closeable, AutoCloseable

@InternalExtensionOnly
public class BigtableSession
extends Object
implements Closeable

Encapsulates the creation of Bigtable Grpc services.

The following functionality is handled by this class:

1. Creates Executors
2. Creates Channels - netty ChannelImpls, ReconnectingChannel and ChannelPools
3. Creates ChannelInterceptors - auth headers, performance interceptors.
4. Close anything above that needs to be closed (ExecutorService, ChannelImpls)

See Also:

google-cloud-bigtable java idiomatic client to access cloud Bigtable API.

Constructor Summary

Constructors

Constructor and Description
BigtableSession(BigtableOptions opts) Constructor for BigtableSession.

Method Summary

Modifier and Type	Method and Description
void	close()
BulkMutation	createBulkMutation(BigtableTableName tableName) createBulkMutation.
IBulkMutation	createBulkMutationWrapper(BigtableTableName tableName) For internal use only - public for technical reasons.
BulkRead	createBulkRead(BigtableTableName tableName) createBulkRead.
protected io.grpc.ManagedChannel	createChannelPool(ChannelPool.ChannelFactory channelFactory, int count) Deprecated. Channel creation is now considered an internal implementation detail channel creation methods will be removed from the public surface in the future
static io.grpc.ManagedChannel	createChannelPool(String host, BigtableOptions options) Deprecated. Channel creation is now considered an internal implementation detail channel creation methods will be removed from the public surface in the future
static io.grpc.ManagedChannel	createChannelPool(String host, BigtableOptions options, int count) Deprecated. Channel creation is now considered an internal implementation detail channel creation methods will be removed in the future
protected io.grpc.ManagedChannel	createChannelPool(String hostString, int count) Deprecated. Channel creation is now considered an internal implementation detail channel creation methods will be removed from the public surface in the future
static BigtableInstanceClient	createInstanceClient(BigtableOptions options) Deprecated.
protected io.grpc.ManagedChannel	createManagedPool(String host, int channelCount) Deprecated. Channel creation is now considered an internal implementation detail channel creation methods will be removed from the public surface in the future
static io.grpc.ManagedChannel	createNettyChannel(String host, BigtableOptions options, io.grpc.ClientInterceptor... interceptors) For internal use only - public for technical reasons.
Map<String,com.google.api.gax.rpc.ClientContext>	getCachedClientContexts() Getter for the field cachedClientContexts.
BigtableClusterName	getClusterName() Snapshot operations need various aspects of a BigtableClusterName.
BigtableDataClient	getDataClient() Getter for the field dataClient.
IBigtableDataClient	getDataClientWrapper() Getter for the field clientWrapper.
BigtableInstanceClient	getInstanceAdminClient() Getter for the field instanceAdminClient.
BigtableOptions	getOptions() Getter for the field options.
BigtableTableAdminClient	getTableAdminClient() Getter for the field tableAdminClient.
IBigtableTableAdminClient	getTableAdminClientWrapper() Initializes bigtableTableAdminClient based on flag to use GCJ adapter, available in BigtableOptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

BigtableSession

public BigtableSession(BigtableOptions opts)
                throws IOException

Constructor for BigtableSession.

Parameters:

opts - a BigtableOptions object.

Throws:

IOException - if any.

Method Detail

createManagedPool

@Deprecated
protected io.grpc.ManagedChannel createManagedPool(String host,
                                                               int channelCount)
                                                        throws IOException

Deprecated. Channel creation is now considered an internal implementation detail channel creation methods will be removed from the public surface in the future

Throws:

IOException

createChannelPool

@Deprecated
protected io.grpc.ManagedChannel createChannelPool(String hostString,
                                                               int count)
                                                        throws IOException

Deprecated. Channel creation is now considered an internal implementation detail channel creation methods will be removed from the public surface in the future

Throws:

IOException

createChannelPool

@Deprecated
 @InternalApi(value="For internal usage only")
protected io.grpc.ManagedChannel createChannelPool(ChannelPool.ChannelFactory channelFactory,
                                                                                                              int count)
                                                                                                       throws IOException

Deprecated. Channel creation is now considered an internal implementation detail channel creation methods will be removed from the public surface in the future

Throws:

IOException

createChannelPool

@Deprecated
 @InternalApi(value="For internal usage only")
public static io.grpc.ManagedChannel createChannelPool(String host,
                                                                                                                  BigtableOptions options)
                                                                                                           throws IOException,
                                                                                                                  GeneralSecurityException

Deprecated. Channel creation is now considered an internal implementation detail channel creation methods will be removed from the public surface in the future

Throws:

IOException

GeneralSecurityException

createChannelPool

@Deprecated
 @InternalApi(value="For internal usage only")
public static io.grpc.ManagedChannel createChannelPool(String host,
                                                                                                                  BigtableOptions options,
                                                                                                                  int count)
                                                                                                           throws IOException,
                                                                                                                  GeneralSecurityException

Deprecated. Channel creation is now considered an internal implementation detail channel creation methods will be removed in the future

Throws:

IOException

GeneralSecurityException

createNettyChannel

@InternalApi(value="For internal usage only")
public static io.grpc.ManagedChannel createNettyChannel(String host,
                                                                                                      BigtableOptions options,
                                                                                                      io.grpc.ClientInterceptor... interceptors)
                                                                                               throws SSLException

For internal use only - public for technical reasons.

Throws:

SSLException

getClusterName

public BigtableClusterName getClusterName()
                                   throws IOException

Snapshot operations need various aspects of a BigtableClusterName. This method gets a clusterId from either a lookup (projectId and instanceId translate to a single clusterId when an instance has only one cluster).

Throws:

IOException

getDataClient

public BigtableDataClient getDataClient()

Getter for the field dataClient.

Returns:

a BigtableDataClient object.

getDataClientWrapper

@InternalApi(value="For internal usage only")
public IBigtableDataClient getDataClientWrapper()

Getter for the field clientWrapper.

For internal use only - public for technical reasons.

Please use getDataClient() as a public alternative.

createBulkMutation

public BulkMutation createBulkMutation(BigtableTableName tableName)

createBulkMutation.

Parameters:

tableName - a BigtableTableName object.

Returns:

a BulkMutation object.

createBulkMutationWrapper

@InternalApi(value="For internal usage only")
public IBulkMutation createBulkMutationWrapper(BigtableTableName tableName)

For internal use only - public for technical reasons.

Please use createBulkMutation(BigtableTableName) as a public alternative.

createBulkRead

public BulkRead createBulkRead(BigtableTableName tableName)

createBulkRead.

Parameters:

tableName - a BigtableTableName object.

Returns:

a BulkRead object.

getTableAdminClient

public BigtableTableAdminClient getTableAdminClient()
                                             throws IOException

Getter for the field tableAdminClient.

Returns:

a BigtableTableAdminClient object.

Throws:

IOException - if any.

getTableAdminClientWrapper

@InternalApi(value="For internal usage only")
public IBigtableTableAdminClient getTableAdminClientWrapper()
                                                                                                   throws IOException

Initializes bigtableTableAdminClient based on flag to use GCJ adapter, available in BigtableOptions.

For internal use only - public for technical reasons.

Please use getTableAdminClient() as a public alternative.

Throws:

IOException

getInstanceAdminClient

public BigtableInstanceClient getInstanceAdminClient()
                                              throws IOException

Getter for the field instanceAdminClient.

Returns:

a BigtableInstanceClient object.

Throws:

IOException - if any.

createInstanceClient

@Deprecated
 @InternalApi(value="For internal usage only")
public static BigtableInstanceClient createInstanceClient(BigtableOptions options)
                                                                                                              throws IOException,
                                                                                                                     GeneralSecurityException

Deprecated.

Throws:

IOException

GeneralSecurityException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getOptions

public BigtableOptions getOptions()

Getter for the field options.

Returns:

a BigtableOptions object.

getCachedClientContexts

@InternalApi(value="VisibleForTesting")
public Map<String,com.google.api.gax.rpc.ClientContext> getCachedClientContexts()

Getter for the field cachedClientContexts.

For internal usage only - public for technical reasons.

Returns:

a HashMap of Connection Name (String) to ClientContext object.