Package com.google.cloud.bigtable.grpc

Class BigtableSession

java.lang.Object

com.google.cloud.bigtable.grpc.BigtableSession

All Implemented Interfaces:

Closeable, AutoCloseable

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, CahnnelImpls)

Version:

$Id: $Id

Author:

sduskis

Constructor Summary

Constructors

Constructor	Description
BigtableSession(BigtableOptions opts)	Constructor for BigtableSession.

Method Summary

Modifier and Type	Method	Description
void	close()
AsyncExecutor	createAsyncExecutor()	createAsyncExecutor.
BulkMutation	createBulkMutation(BigtableTableName tableName)	createBulkMutation.
BulkMutation	createBulkMutation(BigtableTableName tableName, AsyncExecutor asyncExecutor)	Deprecated. use createBulkMutation(BigtableTableName) instead.
BulkRead	createBulkRead(BigtableTableName tableName)	createBulkRead.
protected io.grpc.ManagedChannel	createChannelPool(ChannelPool.ChannelFactory channelFactory, int count)	Create a new ChannelPool, with auth headers.
protected io.grpc.ManagedChannel	createChannelPool(String hostString, int count)	Create a new ChannelPool, with auth headers.
static io.grpc.ManagedChannel	createChannelPool(String host, BigtableOptions options)	Create a new ChannelPool, with auth headers.
static io.grpc.ManagedChannel	createChannelPool(String host, BigtableOptions options, int count)	Create a new ChannelPool, with auth headers.
static BigtableInstanceClient	createInstanceClient(BigtableOptions options)	Create a BigtableInstanceClient.
protected io.grpc.ManagedChannel	createManagedPool(String host, int channelCount)	Create a new ChannelPool, with auth headers, that will be cleaned up when the connection closes.
static io.grpc.ManagedChannel	createNettyChannel(String host, BigtableOptions options, io.grpc.ClientInterceptor... interceptors)	createNettyChannel.
BigtableDataClientWrapper	getClientWrapper()	Getter for the field clientWrapper.
BigtableClusterName	getClusterName()	Snapshot operations need various aspects of a BigtableClusterName.
BigtableDataClient	getDataClient()	Getter for the field dataClient.
BigtableInstanceClient	getInstanceAdminClient()	Getter for the field instanceAdminClient.
BigtableOptions	getOptions()	Getter for the field options.
BigtableTableAdminClient	getTableAdminClient()	Getter for the field tableAdminClient.

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

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.

getClientWrapper

public BigtableDataClientWrapper getClientWrapper()

Getter for the field clientWrapper.

Returns:

a BigtableDataClientWrapper object.

createAsyncExecutor

public AsyncExecutor createAsyncExecutor()

createAsyncExecutor.

Returns:

a AsyncExecutor object.

createBulkMutation

@Deprecated
public BulkMutation createBulkMutation(BigtableTableName tableName,
                                       AsyncExecutor asyncExecutor)

Deprecated.

use createBulkMutation(BigtableTableName) instead.

createBulkMutation.

Parameters:

tableName - a BigtableTableName object.

asyncExecutor - a AsyncExecutor object.

Returns:

a BulkMutation object.

createBulkMutation

public BulkMutation createBulkMutation(BigtableTableName tableName)

createBulkMutation.

Parameters:

tableName - a BigtableTableName object.

Returns:

a BulkMutation object.

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.

getInstanceAdminClient

public BigtableInstanceClient getInstanceAdminClient()
                                              throws IOException

Getter for the field instanceAdminClient.

Returns:

a BigtableInstanceClient object.

Throws:

IOException - if any.

createChannelPool

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

Create a new ChannelPool, with auth headers.

Parameters:

hostString - a String object.

Returns:

a ChannelPool object.

Throws:

IOException - if any.

createChannelPool

protected io.grpc.ManagedChannel createChannelPool(ChannelPool.ChannelFactory channelFactory,
                                                   int count)
                                            throws IOException

Create a new ChannelPool, with auth headers. This method allows users to override the default implementation with their own.

Parameters:

channelFactory - a ChannelPool.ChannelFactory object.

count - The number of channels in the pool.

Returns:

a ChannelPool object.

Throws:

IOException - if any.

createManagedPool

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

Create a new ChannelPool, with auth headers, that will be cleaned up when the connection closes.

Parameters:

host - a String object.

Returns:

a ChannelPool object.

Throws:

IOException - if any.

createInstanceClient

public static BigtableInstanceClient createInstanceClient(BigtableOptions options)
                                                   throws IOException,
                                                          GeneralSecurityException

Create a BigtableInstanceClient. BigtableSession objects assume that BigtableOptions have a project and instance. A BigtableInstanceClient does not require project id or instance id, so BigtableOptions.getDefaultOptions() may be used if there are no service account credentials settings.

Returns:

a fully formed BigtableInstanceClient

Throws:

IOException

GeneralSecurityException

createChannelPool

public static io.grpc.ManagedChannel createChannelPool(String host,
                                                       BigtableOptions options)
                                                throws IOException,
                                                       GeneralSecurityException

Create a new ChannelPool, with auth headers.

Parameters:

host - a String object.

options - a BigtableOptions object.

Returns:

a ChannelPool object.

Throws:

IOException - if any.

GeneralSecurityException

createChannelPool

public static io.grpc.ManagedChannel createChannelPool(String host,
                                                       BigtableOptions options,
                                                       int count)
                                                throws IOException,
                                                       GeneralSecurityException

Create a new ChannelPool, with auth headers.

Parameters:

host - a String object specifying the host to connect to.

options - a BigtableOptions object with the credentials, retry and other connection options.

count - an int defining the number of channels to create

Returns:

a ChannelPool object.

Throws:

IOException - if any.

GeneralSecurityException

createNettyChannel

public static io.grpc.ManagedChannel createNettyChannel(String host,
                                                        BigtableOptions options,
                                                        io.grpc.ClientInterceptor... interceptors)
                                                 throws SSLException

createNettyChannel.

Parameters:

host - a String object.

options - a BigtableOptions object.

Returns:

a ManagedChannel object.

Throws:

SSLException - if any.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getOptions

public BigtableOptions getOptions()

Getter for the field options.

Returns:

a BigtableOptions object.