com.google.cloud.bigtable.data.v2

Class BigtableDataSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<BigtableDataSettings>

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

public class BigtableDataSettings
extends com.google.api.gax.rpc.ClientSettings<BigtableDataSettings>

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()
   .setInstanceName(InstanceName.of("my-project", "my-instance-id"))
   .setAppProfileId("default");

 settingsBuilder.readRowsSettings().setRetryableCodes(Code.DEADLINE_EXCEEDED, Code.UNAVAILABLE);

 BigtableDataSettings settings = builder.build();
 

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
com.google.api.gax.rpc.BatchingCallSettings<RowMutation,Void>	bulkMutationsSettings() Returns the object with the settings used for BulkMutations.
com.google.api.gax.rpc.UnaryCallSettings<ConditionalRowMutation,Boolean>	checkAndMutateRowSettings() Returns the object with the settings used for calls to checkAndMutateRow.
String	getAppProfileId() Returns the configured AppProfile to use
InstanceName	getInstanceName() Returns the target instance
com.google.api.gax.rpc.UnaryCallSettings<RowMutation,Void>	mutateRowSettings() Returns the object with the settings used for calls to MutateRow.
static BigtableDataSettings.Builder	newBuilder() Create a new builder.
com.google.api.gax.rpc.UnaryCallSettings<ReadModifyWriteRow,Row>	readModifyWriteRowSettings() Returns the object with the settings used for calls to ReadModifyWriteRow.
com.google.api.gax.rpc.ServerStreamingCallSettings<Query,Row>	readRowsSettings() Returns the object with the settings used for calls to ReadRows.
com.google.api.gax.rpc.UnaryCallSettings<String,List<KeyOffset>>	sampleRowKeysSettings() Returns the object with the settings used for calls to sampleRowKeys.
BigtableDataSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static BigtableDataSettings.Builder newBuilder()

Create a new builder.

getInstanceName

public InstanceName getInstanceName()

Returns the target instance

getAppProfileId

public String getAppProfileId()

Returns the configured AppProfile to use

readRowsSettings

public com.google.api.gax.rpc.ServerStreamingCallSettings<Query,Row> readRowsSettings()

Returns the object with the settings used for calls to ReadRows.

sampleRowKeysSettings

public com.google.api.gax.rpc.UnaryCallSettings<String,List<KeyOffset>> sampleRowKeysSettings()

Returns the object with the settings used for calls to sampleRowKeys.

mutateRowSettings

public com.google.api.gax.rpc.UnaryCallSettings<RowMutation,Void> mutateRowSettings()

Returns the object with the settings used for calls to MutateRow.

bulkMutationsSettings

public com.google.api.gax.rpc.BatchingCallSettings<RowMutation,Void> bulkMutationsSettings()

Returns the object with the settings used for BulkMutations.

checkAndMutateRowSettings

public com.google.api.gax.rpc.UnaryCallSettings<ConditionalRowMutation,Boolean> checkAndMutateRowSettings()

Returns the object with the settings used for calls to checkAndMutateRow.

readModifyWriteRowSettings

public com.google.api.gax.rpc.UnaryCallSettings<ReadModifyWriteRow,Row> readModifyWriteRowSettings()

Returns the object with the settings used for calls to ReadModifyWriteRow.

toBuilder

public BigtableDataSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<BigtableDataSettings>