com.google.cloud.bigtable.data.v2

Class BigtableDataSettings

java.lang.Object

com.google.cloud.bigtable.data.v2.BigtableDataSettings

public final class BigtableDataSettings
extends Object

Settings class to configure an instance of BigtableDataClient.

Sane defaults are provided for most settings:

• The default service address (bigtable.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The only required setting is the instance name.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

 BigtableDataSettings.Builder settingsBuilder = BigtableDataSettings.newBuilder()
   .setProjectId("my-project")
   .setInstanceId("my-instance-id")
   .setAppProfileId("default");

 BigtableDataSettings settings = builder.build();
 

For fine grained control of individual RPCs, please refer to EnhancedBigtableStubSettings, which is exposed as BigtableDataSettings.Builder.stubSettings().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BigtableDataSettings.Builder Builder for BigtableDataSettings.

Method Summary

Modifier and Type	Method and Description
String	getAppProfileId() Returns the configured AppProfile id to use.
String	getInstanceId() Returns the target instance id.
String	getProjectId() Returns the target project id.
EnhancedBigtableStubSettings	getStubSettings() Returns the underlying RPC settings.
static BigtableDataSettings.Builder	newBuilder() Create a new builder.
static BigtableDataSettings.Builder	newBuilderForEmulator(int port) Create a new builder preconfigured to connect to the Bigtable emulator.
com.google.api.gax.rpc.UnaryCallSettings<Query,Row>	readRowSettings() Returns the object with the settings used for point reads via ReadRow.
BigtableDataSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static BigtableDataSettings.Builder newBuilder()

Create a new builder.

newBuilderForEmulator

public static BigtableDataSettings.Builder newBuilderForEmulator(int port)

Create a new builder preconfigured to connect to the Bigtable emulator.

getProjectId

public String getProjectId()

Returns the target project id.

getInstanceId

public String getInstanceId()

Returns the target instance id.

getAppProfileId

public String getAppProfileId()

Returns the configured AppProfile id to use.

getStubSettings

public EnhancedBigtableStubSettings getStubSettings()

Returns the underlying RPC settings.

readRowSettings

public com.google.api.gax.rpc.UnaryCallSettings<Query,Row> readRowSettings()

Returns the object with the settings used for point reads via ReadRow.

toBuilder

public BigtableDataSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.