BigtableSession (Cloud Bigtable HBase Client for Java 1.12.0 API)

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, ChannelImpls)
Version:

$Id: $Id

Author:

sduskis

Constructor Summary

Constructors
Constructor and Description

BigtableSession(BigtableOptions opts)
Constructor for BigtableSession.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()`
`BulkMutation`	`createBulkMutation(BigtableTableName tableName)` createBulkMutation.
`IBulkMutation`	`createBulkMutationWrapper(BigtableTableName tableName)` createBulkMutationWrapper.
`BulkRead`	`createBulkRead(BigtableTableName tableName)` createBulkRead.
`protected io.grpc.ManagedChannel`	`createChannelPool(ChannelPool.ChannelFactory channelFactory, 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.
`protected io.grpc.ManagedChannel`	`createChannelPool(String hostString, 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.
`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()` Deprecated. Please use `getTableAdminClientWrapper()`.
`IBigtableTableAdminClient`	`getTableAdminClientWrapper()` Initializes bigtableTableAdminClient based on flag to use GCJ adapter, available in `BigtableOptions`.
`protected List<io.grpc.ClientInterceptor>`	`setupInterceptors()`

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

setupInterceptors

protected List<io.grpc.ClientInterceptor> setupInterceptors()
                                                     throws IOException

Throws:: IOException

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
```
public IBigtableDataClient getDataClientWrapper()
```
Getter for the field clientWrapper.

Returns:

a IBigtableDataClient object.

createBulkMutation
```
public BulkMutation createBulkMutation(BigtableTableName tableName)
```
createBulkMutation.

Parameters:

tableName - a BigtableTableName object.

Returns:

a BulkMutation object.

createBulkMutationWrapper
```
public IBulkMutation createBulkMutationWrapper(BigtableTableName tableName)
```
createBulkMutationWrapper.

Parameters:

tableName - a BigtableTableName object.

Returns:

a IBigtableDataClient object.

createBulkRead
```
public BulkRead createBulkRead(BigtableTableName tableName)
```
createBulkRead.

Parameters:

tableName - a BigtableTableName object.

Returns:

a BulkRead object.

getTableAdminClient
```
@Deprecated
public BigtableTableAdminClient getTableAdminClient()
                                                         throws IOException
```
Deprecated. Please use getTableAdminClientWrapper().

Getter for the field tableAdminClient.

Returns:

a BigtableTableAdminClient object.

Throws:

IOException - if any.

getTableAdminClientWrapper
```
public IBigtableTableAdminClient getTableAdminClientWrapper()
                                                     throws IOException
```
Initializes bigtableTableAdminClient based on flag to use GCJ adapter, available in BigtableOptions.

Returns:

a BigtableTableAdminClientWrapper 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 Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getOptions
```
public BigtableOptions getOptions()
```
Getter for the field options.

Returns:

a BigtableOptions object.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-02-15 UTC.

BigtableSession (Cloud Bigtable HBase Client for Java 1.12.0 API)

Class BigtableSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BigtableSession

Method Detail

setupInterceptors

getClusterName

getDataClient

getDataClientWrapper

createBulkMutation

createBulkMutationWrapper

createBulkRead

getTableAdminClient

getTableAdminClientWrapper

getInstanceAdminClient

createChannelPool

createChannelPool

createManagedPool

createInstanceClient

createChannelPool

createChannelPool

createNettyChannel

close

getOptions