com.google.cloud.bigtable.data.v2

Class BigtableDataSettings.Builder

java.lang.Object

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

Enclosing class:

BigtableDataSettings

public static class BigtableDataSettings.Builder
extends Object

Builder for BigtableDataSettings.

Method Summary

Modifier and Type	Method and Description
BigtableDataSettings	build()
String	getAppProfileId() Gets the app profile id that was previously set on this Builder.
com.google.api.gax.core.CredentialsProvider	getCredentialsProvider() Gets the CredentialsProvider to use for getting the credentials to make calls with.
String	getInstanceId() Gets the instance id that was previously set on this Builder.
List<String>	getPrimingTableIds() Gets the table ids that will be used to send warmup requests when setRefreshingChannel(boolean) is enabled.
String	getProjectId() Gets the project id that was previously set on this Builder.
boolean	isRefreshingChannel() Gets if channels will gracefully refresh connections to Cloud Bigtable service
BigtableDataSettings.Builder	setAppProfileId(String appProfileId) Sets the AppProfile to use.
BigtableDataSettings.Builder	setCredentialsProvider(com.google.api.gax.core.CredentialsProvider credentialsProvider) Sets the CredentialsProvider to use for getting the credentials to make calls with.
BigtableDataSettings.Builder	setDefaultAppProfileId() Resets the AppProfile id to the default for the instance.
BigtableDataSettings.Builder	setInstanceId(String instanceId) Sets the target instance.
BigtableDataSettings.Builder	setPrimingTableIds(String... tableIds) Configure the tables that can be used to prime a channel during a refresh.
BigtableDataSettings.Builder	setProjectId(String projectId) Sets the target project.
BigtableDataSettings.Builder	setRefreshingChannel(boolean isRefreshingChannel) Configure periodic gRPC channel refreshes.
EnhancedBigtableStubSettings.Builder	stubSettings() Returns the underlying settings for making RPC calls.

Methods inherited from class java.lang.Object

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

Method Detail

setProjectId

public BigtableDataSettings.Builder setProjectId(@Nonnull
                                                 String projectId)

Sets the target project. This setting is required. All RPCs will be made in the context of this setting.

getProjectId

public String getProjectId()

Gets the project id that was previously set on this Builder.

setInstanceId

public BigtableDataSettings.Builder setInstanceId(@Nonnull
                                                  String instanceId)

Sets the target instance. This setting is required. All RPCs will be made in the context of this setting.

getInstanceId

public String getInstanceId()

Gets the instance id that was previously set on this Builder.

setAppProfileId

public BigtableDataSettings.Builder setAppProfileId(@Nonnull
                                                    String appProfileId)

Sets the AppProfile to use.

An application profile (sometimes also shortened to "app profile") is a group of configuration parameters for an individual use case. A client will identify itself with an application profile ID at connection time, and the requests will be handled according to that application profile.

setDefaultAppProfileId

public BigtableDataSettings.Builder setDefaultAppProfileId()

Resets the AppProfile id to the default for the instance.

An application profile (sometimes also shortened to "app profile") is a group of configuration parameters for an individual use case. A client will identify itself with an application profile ID at connection time, and the requests will be handled according to that application profile.

Every Bigtable Instance has a default application profile associated with it, this method configures the client to use it.

getAppProfileId

public String getAppProfileId()

Gets the app profile id that was previously set on this Builder.

setCredentialsProvider

public BigtableDataSettings.Builder setCredentialsProvider(com.google.api.gax.core.CredentialsProvider credentialsProvider)

Sets the CredentialsProvider to use for getting the credentials to make calls with.

getCredentialsProvider

public com.google.api.gax.core.CredentialsProvider getCredentialsProvider()

Gets the CredentialsProvider to use for getting the credentials to make calls with.

setRefreshingChannel

@BetaApi(value="Channel priming is not currently stable and may change in the future")
public BigtableDataSettings.Builder setRefreshingChannel(boolean isRefreshingChannel)

Configure periodic gRPC channel refreshes.

This feature will gracefully refresh connections to the Cloud Bigtable service. This is an experimental feature to address tail latency caused by the service dropping long lived gRPC connections, which causes the client to renegotiate the gRPC connection in the request path, which causes periodic spikes in latency

isRefreshingChannel

@BetaApi(value="Channel priming is not currently stable and may change in the future")
public boolean isRefreshingChannel()

Gets if channels will gracefully refresh connections to Cloud Bigtable service

setPrimingTableIds

@BetaApi(value="Channel priming is not currently stable and may change in the future")
public BigtableDataSettings.Builder setPrimingTableIds(String... tableIds)

Configure the tables that can be used to prime a channel during a refresh.

These tables work in conjunction with setRefreshingChannel(boolean). When a channel is refreshed, it will send a request to each table to warm up the serverside caches before admitting the new channel into the channel pool.

getPrimingTableIds

@BetaApi(value="Channel priming is not currently stable and may change in the future")
public List<String> getPrimingTableIds()

Gets the table ids that will be used to send warmup requests when setRefreshingChannel(boolean) is enabled.

stubSettings

public EnhancedBigtableStubSettings.Builder stubSettings()

Returns the underlying settings for making RPC calls. The settings should be changed with care.

build

public BigtableDataSettings build()