BigtableDataSettings (Google Cloud Bigtable 2.78.1 API)

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.
- The transport provider is configured with a channel pool that contains twice as many connections as CPUs.
- 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.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BigtableDataSettings.Builder` Builder for BigtableDataSettings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`areInternalMetricsEnabled()` Checks if internal metrics are enabled
`static void`	`enableBuiltinMetrics()` Deprecated. This is a no-op that doesn't do anything. Builtin metrics are enabled by default now. Please refer to `BigtableDataSettings.Builder.setMetricsProvider(MetricsProvider)` on how to enable or disable built-in metrics.
`static void`	`enableBuiltinMetrics(com.google.auth.Credentials credentials)` Deprecated. This is a no-op that doesn't do anything. Builtin metrics are enabled by default now. Please refer `BigtableDataSettings.Builder.setMetricsProvider(MetricsProvider)` on how to enable or disable built-in metrics.
`static void`	`enableGfeOpenCensusStats()` Deprecated. OpenCensus support is deprecated and will be removed in a future version Enables OpenCensus GFE metric aggregations. This will register views for gfe_latency and gfe_header_missing_count metrics. gfe_latency measures the latency between Google's network receives an RPC and reads back the first byte of the response. gfe_header_missing_count is a counter of the number of RPC responses received without the server-timing header.
`static void`	`enableOpenCensusStats()` Deprecated. OpenCensus support is deprecated and will be removed in a future version Enables OpenCensus metric aggregations. This will register Bigtable client relevant `View`s. When coupled with an exporter, it allows users to monitor client behavior. Please note that in addition to calling this method, the application must: Include openensus-impl dependency on the classpath Configure an exporter like opencensus-exporter-stats-stackdriver Example usage for maven: `<dependency> <groupId>io.opencensus</groupId> <artifactId>opencensus-impl</artifactId> <version>${opencensus.version}</version> <scope>runtime</scope> </dependency> <dependency> <groupId>io.opencensus</groupId> <artifactId>opencensus-exporter-stats-stackdriver</artifactId> <version>${opencensus.version}</version> </dependency>` Java: `StackdriverStatsExporter.createAndRegister(); BigtableDataSettings.enableOpenCensusStats();`
`String`	`getAppProfileId()` Returns the configured AppProfile id to use.
`Long`	`getBatchMutationsTargetRpcLatencyMs()` Gets target bulk mutation rpc latency if latency based throttling is enabled for `BigtableDataClient.newBulkMutationBatcher(String)`.
`String`	`getInstanceId()` Returns the target instance id.
`static com.google.auth.Credentials`	`getMetricsCredentials()` Get the metrics credentials if it's set by `enableBuiltinMetrics(Credentials)`.
`com.google.cloud.bigtable.data.v2.stub.metrics.MetricsProvider`	`getMetricsProvider()` Gets the `MetricsProvider`
`List<String>`	`getPrimingTableIds()` Deprecated. This field is ignored. If `isRefreshingChannel()` is enabled, warm up requests will be sent to all table ids of the instance.
`String`	`getProjectId()` Returns the target project id.
`EnhancedBigtableStubSettings`	`getStubSettings()` Returns the underlying RPC settings.
`boolean`	`isBulkMutationFlowControlEnabled()` Gets if flow control is enabled for `BigtableDataClient.newBulkMutationBatcher(String)` based on the load of the Bigtable server.
`boolean`	`isLatencyBasedThrottlingForBatchMutationsEnabled()` Gets if latency based throttling is enabled for `BigtableDataClient.newBulkMutationBatcher(String)`
`boolean`	`isRefreshingChannel()` Deprecated. Channel refreshing is enabled by default and this method will be deprecated.
`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 with port number.
`static BigtableDataSettings.Builder`	`newBuilderForEmulator(String hostname, int port)` Creates a new builder preconfigured to connect to the Bigtable emulator with a host name and port number.
`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.
`String`	`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.
    If emulator configuration provided in BIGTABLE_EMULATOR_HOST environment variable then it creates a builder preconfigured to connect to Bigtable using emulator hostname and port number.
  - newBuilderForEmulator
```
public static BigtableDataSettings.Builder newBuilderForEmulator(int port)
```
    Create a new builder preconfigured to connect to the Bigtable emulator with port number.
  - newBuilderForEmulator
```
public static BigtableDataSettings.Builder newBuilderForEmulator(String hostname,
                                                                 int port)
```
    Creates a new builder preconfigured to connect to the Bigtable emulator with a host name and port number.
  - enableOpenCensusStats
```
@Deprecated
public static void enableOpenCensusStats()
```
    Deprecated.
    OpenCensus support is deprecated and will be removed in a future version Enables OpenCensus metric aggregations.
    This will register Bigtable client relevant Views. When coupled with an exporter, it allows users to monitor client behavior.
    Please note that in addition to calling this method, the application must:
    
    Include openensus-impl dependency on the classpath
    Configure an exporter like opencensus-exporter-stats-stackdriver
    
    Example usage for maven:
    <dependency> <groupId>io.opencensus</groupId> <artifactId>opencensus-impl</artifactId> <version>${opencensus.version}</version> <scope>runtime</scope> </dependency> <dependency> <groupId>io.opencensus</groupId> <artifactId>opencensus-exporter-stats-stackdriver</artifactId> <version>${opencensus.version}</version> </dependency>
    Java:
    StackdriverStatsExporter.createAndRegister(); BigtableDataSettings.enableOpenCensusStats();
  - enableGfeOpenCensusStats
```
@Deprecated
public static void enableGfeOpenCensusStats()
```
    Deprecated. OpenCensus support is deprecated and will be removed in a future version Enables OpenCensus GFE metric aggregations.
    This will register views for gfe_latency and gfe_header_missing_count metrics.
    gfe_latency measures the latency between Google's network receives an RPC and reads back the first byte of the response. gfe_header_missing_count is a counter of the number of RPC responses received without the server-timing header.
  - enableBuiltinMetrics
```
@Deprecated
public static void enableBuiltinMetrics()
                                             throws IOException
```
    Deprecated. This is a no-op that doesn't do anything. Builtin metrics are enabled by default now. Please refer to BigtableDataSettings.Builder.setMetricsProvider(MetricsProvider) on how to enable or disable built-in metrics.
    
    Register built in metrics.
    
    Throws:
    
    IOException
  - enableBuiltinMetrics
```
@Deprecated
public static void enableBuiltinMetrics(com.google.auth.Credentials credentials)
                                             throws IOException
```
    Deprecated. This is a no-op that doesn't do anything. Builtin metrics are enabled by default now. Please refer BigtableDataSettings.Builder.setMetricsProvider(MetricsProvider) on how to enable or disable built-in metrics.
    
    Register built in metrics with credentials. The credentials need to have metric write access for all the projects you're publishing to.
    
    Throws:
    
    IOException
  - getMetricsCredentials
```
@InternalApi
public static com.google.auth.Credentials getMetricsCredentials()
```
    Get the metrics credentials if it's set by enableBuiltinMetrics(Credentials).
  - 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.
  - isRefreshingChannel
```
@Deprecated
public boolean isRefreshingChannel()
```
    Deprecated. Channel refreshing is enabled by default and this method will be deprecated.
    
    Gets if channels will gracefully refresh connections to Cloud Bigtable service
  - getPrimingTableIds
```
@Deprecated
public List<String> getPrimingTableIds()
```
    Deprecated. This field is ignored. If isRefreshingChannel() is enabled, warm up requests will be sent to all table ids of the instance.
  - isLatencyBasedThrottlingForBatchMutationsEnabled
```
@BetaApi(value="Latency based throttling is not currently stable and may change in the future")
public boolean isLatencyBasedThrottlingForBatchMutationsEnabled()
```
    Gets if latency based throttling is enabled for BigtableDataClient.newBulkMutationBatcher(String)
  - getBatchMutationsTargetRpcLatencyMs
```
@BetaApi(value="Latency based throttling is not currently stable and may change in the future")
 @Nullable
public Long getBatchMutationsTargetRpcLatencyMs()
```
    Gets target bulk mutation rpc latency if latency based throttling is enabled for BigtableDataClient.newBulkMutationBatcher(String). Otherwise returns null.
  - isBulkMutationFlowControlEnabled
```
@InternalApi(value="Intended for use by the Bigtable dataflow connectors only")
public boolean isBulkMutationFlowControlEnabled()
```
    Gets if flow control is enabled for BigtableDataClient.newBulkMutationBatcher(String) based on the load of the Bigtable server.
  - getMetricsProvider
```
public com.google.cloud.bigtable.data.v2.stub.metrics.MetricsProvider getMetricsProvider()
```
    Gets the MetricsProvider. *
  - areInternalMetricsEnabled
```
public boolean areInternalMetricsEnabled()
```
    Checks if internal metrics are enabled
  - 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.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toBuilder
```
public BigtableDataSettings.Builder toBuilder()
```
    Returns a builder containing all the values of this settings class.

Class BigtableDataSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newBuilder

newBuilderForEmulator

newBuilderForEmulator

enableOpenCensusStats

enableGfeOpenCensusStats

enableBuiltinMetrics

enableBuiltinMetrics

getMetricsCredentials

getProjectId

getInstanceId

getAppProfileId

isRefreshingChannel

getPrimingTableIds

isLatencyBasedThrottlingForBatchMutationsEnabled

getBatchMutationsTargetRpcLatencyMs

isBulkMutationFlowControlEnabled

getMetricsProvider

areInternalMetricsEnabled

getStubSettings

readRowSettings

toString

toBuilder