public static class EnhancedBigtableStubSettings.Builder extends StubSettings.Builder<EnhancedBigtableStubSettings,EnhancedBigtableStubSettings.Builder>Builder for BigtableDataSettings.
Methods
build()
public EnhancedBigtableStubSettings build()| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings |
|
bulkMutateRowsSettings()
public BigtableBatchingCallSettings.Builder bulkMutateRowsSettings()Returns the builder for the settings used for calls to MutateRows.
| Returns | |
|---|---|
| Type | Description |
com.google.cloud.bigtable.data.v2.stub.BigtableBatchingCallSettings.Builder |
|
bulkReadRowsSettings()
public BigtableBulkReadRowsCallSettings.Builder bulkReadRowsSettings()Returns the builder for the settings used for calls to MutateRows.
| Returns | |
|---|---|
| Type | Description |
com.google.cloud.bigtable.data.v2.stub.BigtableBulkReadRowsCallSettings.Builder |
|
checkAndMutateRowSettings()
public UnaryCallSettings.Builder<ConditionalRowMutation,Boolean> checkAndMutateRowSettings()Returns the builder for the settings used for calls to CheckAndMutateRow.
| Returns | |
|---|---|
| Type | Description |
Builder<ConditionalRowMutation,Boolean> |
|
executeQuerySettings()
public ServerStreamingCallSettings.Builder<Statement,SqlRow> executeQuerySettings()Returns the builder for the settings used for calls to ExecuteQuery
Note that this will currently ignore any retry settings other than deadlines. ExecuteQuery requests will not be retried currently.
| Returns | |
|---|---|
| Type | Description |
Builder<Statement,com.google.cloud.bigtable.data.v2.internal.SqlRow> |
|
generateInitialChangeStreamPartitionsSettings()
public ServerStreamingCallSettings.Builder<String,Range.ByteStringRange> generateInitialChangeStreamPartitionsSettings()Returns the builder for the settings used for calls to GenerateInitialChangeStreamPartitions.
| Returns | |
|---|---|
| Type | Description |
Builder<String,ByteStringRange> |
|
getAppProfileId()
public String getAppProfileId()Gets the app profile id that was previously set on this Builder.
| Returns | |
|---|---|
| Type | Description |
String |
|
getEnableRetryInfo()
public boolean getEnableRetryInfo()Gets if RetryInfo is enabled. If true, client bases retry decision and back off time on server returned RetryInfo value. Otherwise, client uses RetrySettings.
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getEnableRoutingCookie()
public boolean getEnableRoutingCookie()Gets if routing cookie is enabled. If true, client will retry a request with extra metadata server sent back.
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getInstanceId()
public String getInstanceId()Gets the target instance id that was previously set on this Builder.
| Returns | |
|---|---|
| Type | Description |
String |
|
getJwtAudienceMapping()
public Map<String,String> getJwtAudienceMapping()| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMetricsEndpoint()
public String getMetricsEndpoint()Get the Google Cloud Monitoring endpoint for publishing client side metrics. If it's null, client will publish metrics to the default monitoring endpoint.
| Returns | |
|---|---|
| Type | Description |
String |
|
getMetricsProvider()
public MetricsProvider getMetricsProvider()Gets the MetricsProvider.
| Returns | |
|---|---|
| Type | Description |
com.google.cloud.bigtable.data.v2.stub.metrics.MetricsProvider |
|
getPrimedTableIds() (deprecated)
public List<String> getPrimedTableIds()Deprecated. This field is ignored. If #isRefreshingChannel() is enabled, warm up requests will be sent to all table ids of the instance.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
getProjectId()
public String getProjectId()Gets the project id of the target instance that was previously set on this Builder.
| Returns | |
|---|---|
| Type | Description |
String |
|
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.
| Returns | |
|---|---|
| Type | Description |
boolean |
|
mutateRowSettings()
public UnaryCallSettings.Builder<RowMutation,Void> mutateRowSettings()Returns the builder for the settings used for calls to MutateRow.
| Returns | |
|---|---|
| Type | Description |
Builder<RowMutation,Void> |
|
pingAndWarmSettings()
public UnaryCallSettings.Builder<PingAndWarmRequest,Void> pingAndWarmSettings()Returns the builder with the settings used for calls to PingAndWarm.
| Returns | |
|---|---|
| Type | Description |
Builder<com.google.bigtable.v2.PingAndWarmRequest,Void> |
|
readChangeStreamSettings()
public ServerStreamingCallSettings.Builder<ReadChangeStreamQuery,ChangeStreamRecord> readChangeStreamSettings()Returns the builder for the settings used for calls to ReadChangeStream.
| Returns | |
|---|---|
| Type | Description |
Builder<ReadChangeStreamQuery,ChangeStreamRecord> |
|
readModifyWriteRowSettings()
public UnaryCallSettings.Builder<ReadModifyWriteRow,Row> readModifyWriteRowSettings()Returns the builder with the settings used for calls to ReadModifyWriteRow.
| Returns | |
|---|---|
| Type | Description |
Builder<ReadModifyWriteRow,Row> |
|
readRowSettings()
public UnaryCallSettings.Builder<Query,Row> readRowSettings()Returns the builder for the settings used for point reads using readRow.
| Returns | |
|---|---|
| Type | Description |
Builder<Query,Row> |
|
readRowsSettings()
public ServerStreamingCallSettings.Builder<Query,Row> readRowsSettings()Returns the builder for the settings used for calls to readRows.
| Returns | |
|---|---|
| Type | Description |
Builder<Query,Row> |
|
sampleRowKeysSettings()
public UnaryCallSettings.Builder<String,List<KeyOffset>> sampleRowKeysSettings()Returns the builder for the settings used for calls to SampleRowKeysSettings.
| Returns | |
|---|---|
| Type | Description |
Builder<String,List<KeyOffset>> |
|
setAppProfileId(String appProfileId)
public EnhancedBigtableStubSettings.Builder setAppProfileId(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.
| Parameter | |
|---|---|
| Name | Description |
appProfileId |
String |
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|
setDefaultAppProfileId()
public EnhancedBigtableStubSettings.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.
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|
setEnableRetryInfo(boolean enableRetryInfo)
public EnhancedBigtableStubSettings.Builder setEnableRetryInfo(boolean enableRetryInfo)Sets if RetryInfo is enabled. If true, client bases retry decision and back off time on server returned RetryInfo value. Otherwise, client uses RetrySettings.
| Parameter | |
|---|---|
| Name | Description |
enableRetryInfo |
boolean |
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|
setEnableRoutingCookie(boolean enableRoutingCookie)
public EnhancedBigtableStubSettings.Builder setEnableRoutingCookie(boolean enableRoutingCookie)Sets if routing cookie is enabled. If true, client will retry a request with extra metadata server sent back.
| Parameter | |
|---|---|
| Name | Description |
enableRoutingCookie |
boolean |
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|
setInstanceId(String instanceId)
public EnhancedBigtableStubSettings.Builder setInstanceId(String instanceId)Sets the target instance id. This setting is required. All RPCs will be made in the context of this setting.
| Parameter | |
|---|---|
| Name | Description |
instanceId |
String |
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|
setJwtAudienceMapping(Map<String,String> jwtAudienceMapping)
public EnhancedBigtableStubSettings.Builder setJwtAudienceMapping(Map<String,String> jwtAudienceMapping)| Parameter | |
|---|---|
| Name | Description |
jwtAudienceMapping |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|
setMetricsEndpoint(String endpoint)
public EnhancedBigtableStubSettings.Builder setMetricsEndpoint(String endpoint)Built-in client side metrics are published through Google Cloud Monitoring endpoint. This setting overrides the default endpoint for publishing the metrics.
| Parameter | |
|---|---|
| Name | Description |
endpoint |
String |
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|
setMetricsProvider(MetricsProvider metricsProvider)
public EnhancedBigtableStubSettings.Builder setMetricsProvider(MetricsProvider metricsProvider)Sets the MetricsProvider.
By default, this is set to com.google.cloud.bigtable.data.v2.stub.metrics.DefaultMetricsProvider#INSTANCE which will collect and export client side metrics.
To disable client side metrics, set it to com.google.cloud.bigtable.data.v2.stub.metrics.NoopMetricsProvider#INSTANCE.
To use a custom OpenTelemetry instance, refer to com.google.cloud.bigtable.data.v2.stub.metrics.CustomOpenTelemetryMetricsProvider on how to set it up.
| Parameter | |
|---|---|
| Name | Description |
metricsProvider |
com.google.cloud.bigtable.data.v2.stub.metrics.MetricsProvider |
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|
setPrimedTableIds(String[] tableIds) (deprecated)
public EnhancedBigtableStubSettings.Builder setPrimedTableIds(String[] tableIds)Deprecated. This field is ignored. If #isRefreshingChannel() is enabled, warm up requests will be sent to all table ids of the instance.
| Parameter | |
|---|---|
| Name | Description |
tableIds |
String[] |
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|
setProjectId(String projectId)
public EnhancedBigtableStubSettings.Builder setProjectId(String projectId)Sets the project id of that target instance. This setting is required. All RPCs will be made in the context of this setting.
| Parameter | |
|---|---|
| Name | Description |
projectId |
String |
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|
setRefreshingChannel(boolean isRefreshingChannel) (deprecated)
public EnhancedBigtableStubSettings.Builder setRefreshingChannel(boolean isRefreshingChannel)Deprecated. Channel refreshing is enabled by default and this method will be deprecated.
Sets if channels will gracefully refresh connections to Cloud Bigtable service.
When enabled, this will wait for the connection to complete the SSL handshake and warm up serverside caches for all the tables of the instance. This feature is enabled by default. See Also: com.google.cloud.bigtable.data.v2.BigtableDataSettings.Builder#setRefreshingChannel
| Parameter | |
|---|---|
| Name | Description |
isRefreshingChannel |
boolean |
| Returns | |
|---|---|
| Type | Description |
EnhancedBigtableStubSettings.Builder |
|