Package com.google.cloud.bigtable.data.v2

Class BigtableDataClientFactory

java.lang.Object

com.google.cloud.bigtable.data.v2.BigtableDataClientFactory

All Implemented Interfaces:

AutoCloseable

@BetaApi("This feature is currently experimental and can change in the future")
public final class BigtableDataClientFactory
extends Object
implements AutoCloseable

A factory to create multiple BigtableDataClient instances that all share the same channel pool.

This allows multiple client instances to share the same gRPC channel pool, which makes client creation very cheap. The intended use case is for applications that need to access multiple Bigtable Instances from the same process.

Example Usage:

 BigtableDataSettings defaultSettings = BigtableDataSettings.newBuilder()
   .setProject("my-default-project")
   .setInstance("my-default-instance")
   .build();

 BigtableDataClientFactory clientFactory = BigtableDataClientFactory.create(defaultSettings);

 // Create a new client for "my-default-instance" in "my-default-project";
 BigtableDataClient defaultInstanceClient = clientFactory.createDefault();

 // Create a new client for a different application profile
 BigtableDataClient otherAppProfileClient = clientFactory.createForAppProfile("other-app-profile");

 // Create a new client for a completely different instance and application profile.
 BigtableDataClient otherInstanceClient = clientFactory
   .createForInstance("my-other-project", "my-other-instance", "my-other-app-profile");

 // Clean up: make sure close the clients AND the factory.
 defaultInstanceClient.close();
 otherAppProfileClient.close();
 otherInstanceClient.close();

 clientFactory.close();

 <p>Please note that this is an experimental feature and might be changed or removed in future.
 

Method Summary

Modifier and Type	Method	Description
void	close()	Release all of the resources associated with this factory.
static BigtableDataClientFactory	create(BigtableDataSettings defaultSettings)	Create a instance of this factory.
BigtableDataClient	createDefault()	Create a lightweight client using the default settings in this factory.
BigtableDataClient	createForAppProfile(String appProfileId)	Create a lightweight client with an overriden application profile and the factory default project and instance ids.
BigtableDataClient	createForInstance(String projectId, String instanceId)	Create a lightweight client with the specified project and instance id.
BigtableDataClient	createForInstance(String projectId, String instanceId, String appProfileId)	Create a lightweight client to the specified project, instance and application profile id.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static BigtableDataClientFactory create(BigtableDataSettings defaultSettings)
                                        throws IOException

Create a instance of this factory.

The factory will be used to create clients using the provided settings as the base. Make sure to call close() on the factory after closing all clients.

Throws:

IOException

close

public void close()
           throws Exception

Release all of the resources associated with this factory.

This will close the underlying channel pooling, disconnecting all create clients.

Specified by:

close in interface AutoCloseable

Throws:

Exception

createDefault

public BigtableDataClient createDefault()

Create a lightweight client using the default settings in this factory. This will use the factory default project, instance and application profile ids. The client will also share resources like the channel pool with other clients created using this factory.

The client should be closed when it is no longer needed. Closing the client will release client specific resources, but will leave shared resources like the channel pool open. To release all resources, first close all of the created clients and then this factory instance.

createForAppProfile

public BigtableDataClient createForAppProfile(@Nonnull
                                              String appProfileId)
                                       throws IOException

Create a lightweight client with an overriden application profile and the factory default project and instance ids. The client will also share resources like the channel pool with other clients created using this factory.

The client should be closed when it is no longer needed. Closing the client will release client specific resources, but will leave shared resources like the channel pool open. To release all resources, first close all of the created clients and then this factory instance.

Throws:

IOException

createForInstance

public BigtableDataClient createForInstance(@Nonnull
                                            String projectId,
                                            @Nonnull
                                            String instanceId)
                                     throws IOException

Create a lightweight client with the specified project and instance id. The resulting client will use the server default application profile. The client will also share resources like the channel pool with other clients created using this factory.

The client should be closed when it is no longer needed. Closing the client will release client specific resources, but will leave shared resources like the channel pool open. To release all resources, first close all of the created clients and then this factory instance.

Throws:

IOException

createForInstance

public BigtableDataClient createForInstance(@Nonnull
                                            String projectId,
                                            @Nonnull
                                            String instanceId,
                                            @Nonnull
                                            String appProfileId)
                                     throws IOException

Create a lightweight client to the specified project, instance and application profile id. The client will share resources like the channel pool with other clients created using this factory.

The client should be closed when it is no longer needed. Closing the client will release client specific resources, but will leave shared resources like the channel pool open. To release all resources, first close all of the created clients and then this factory instance.

Throws:

IOException