Package com.google.bigtable.cassandra

Class BigtableCqlConfiguration.Builder

java.lang.Object

com.google.bigtable.cassandra.BigtableCqlConfiguration.Builder

Enclosing class:

BigtableCqlConfiguration

public abstract static class BigtableCqlConfiguration.Builder
extends Object

Builder for BigtableCqlConfiguration.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
abstract BigtableCqlConfiguration	build()	Builds the BigtableCqlConfiguration.
BigtableCqlConfiguration.Builder	disableOpenTelemetry()	Disables OpenTelemetry.
BigtableCqlConfiguration.Builder	enableOpenTelemetry(OpenTelemetryConfiguration config)	Enables Opentelemetry health-checks, metrics and tracing instrumentation.
BigtableCqlConfiguration.Builder	setAppProfileId(String appProfileId)	Sets the Bigtable App Profile ID to use.
BigtableCqlConfiguration.Builder	setBigtableChannelPoolSize(int bigtableChannelPoolSize)	Sets the Bigtable channel pool size.
BigtableCqlConfiguration.Builder	setDefaultColumnFamily(String defaultColumnFamily)	Sets the default column family name.
BigtableCqlConfiguration.Builder	setDefaultKeyspace(String keyspace)	Sets the default keyspace for the session.
abstract BigtableCqlConfiguration.Builder	setInstanceId(String instanceId)	Sets the Bigtable instance ID.
abstract BigtableCqlConfiguration.Builder	setProjectId(String projectId)	Sets the Google Cloud Project ID.
BigtableCqlConfiguration.Builder	setSchemaMappingTable(String schemaMappingTable)	Sets the schema mapping table name.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

setProjectId

public abstract BigtableCqlConfiguration.Builder setProjectId(String projectId)

Sets the Google Cloud Project ID. This should be the Google Cloud project ID that contains the targeted Bigtable Instance. This should be the bare project identifier (i.e. my-project) rather than the fully qualified path (e.g. projects/my-project).

Parameters:

projectId - The project ID.

Returns:

This BigtableCqlConfiguration.Builder instance.

setInstanceId

public abstract BigtableCqlConfiguration.Builder setInstanceId(String instanceId)

Sets the Bigtable instance ID. This should be the bare instance ID (e.g. my-instance) rather than the full qualified path (e.g. projects/my-project/instances/my-instance). See documentation for details.

Parameters:

instanceId - The instance ID.

Returns:

This BigtableCqlConfiguration.Builder instance.

setAppProfileId

public BigtableCqlConfiguration.Builder setAppProfileId(String appProfileId)

Sets the Bigtable App Profile ID to use. See documentation for details

Parameters:

appProfileId - The app profile ID.

Returns:

This BigtableCqlConfiguration.Builder instance.

setSchemaMappingTable

public BigtableCqlConfiguration.Builder setSchemaMappingTable(String schemaMappingTable)

Sets the schema mapping table name. This is the schema mapping table created during the Schema Setup process. The schema_mapping table acts as a metadata repository, holding the schema configuration for your Cassandra-like tables in Bigtable. It stores details such as column names, data types, and primary key information.

Parameters:

schemaMappingTable - The schema mapping table name.

Returns:

This BigtableCqlConfiguration.Builder instance.

setDefaultColumnFamily

public BigtableCqlConfiguration.Builder setDefaultColumnFamily(String defaultColumnFamily)

Sets the default column family name. This is the name of the Bigtable column family to target for columns with 'primitive' data types when the column family is not set explicitly set.

Parameters:

defaultColumnFamily - The default column family name.

Returns:

This BigtableCqlConfiguration.Builder instance.

setDefaultKeyspace

public BigtableCqlConfiguration.Builder setDefaultKeyspace(String keyspace)

Sets the default keyspace for the session.

Parameters:

keyspace - The default keyspace to use.

Returns:

This BigtableCqlConfiguration.Builder instance.

setBigtableChannelPoolSize

public BigtableCqlConfiguration.Builder setBigtableChannelPoolSize(int bigtableChannelPoolSize)

Sets the Bigtable channel pool size. The number of gRPC channels that the bigtable client will use. The Bigtable client uses an underlying round-robin channel pool that allows it to spread load across shared load balancers. A good rule of thumb is to limit each channel to at most 50 qps.

Parameters:

bigtableChannelPoolSize - The Bigtable channel pool size.

Returns:

This BigtableCqlConfiguration.Builder instance.

enableOpenTelemetry

public BigtableCqlConfiguration.Builder enableOpenTelemetry(OpenTelemetryConfiguration config)

Enables Opentelemetry health-checks, metrics and tracing instrumentation. Currently only `OpenTelemetryCollectorConfiguration is supported. This only affects monitoring of the proxy itself. Please note, Bigtable client's builtin metrics are separate and are not affected by this configuration.

Parameters:

config - The OpenTelemetryConfiguration.

Returns:

This BigtableCqlConfiguration.Builder instance.

disableOpenTelemetry

public BigtableCqlConfiguration.Builder disableOpenTelemetry()

Disables OpenTelemetry.

Returns:

This BigtableCqlConfiguration.Builder instance.

build

public abstract BigtableCqlConfiguration build()

Builds the BigtableCqlConfiguration.

Returns:

The built BigtableCqlConfiguration.