EnhancedBigtableStubSettings.Builder (Google Cloud Bigtable 2.78.1 API)

java.lang.Object
- com.google.api.gax.rpc.StubSettings.Builder<EnhancedBigtableStubSettings,EnhancedBigtableStubSettings.Builder>
- - com.google.cloud.bigtable.data.v2.stub.EnhancedBigtableStubSettings.Builder

Enclosing class:: EnhancedBigtableStubSettings

public static class EnhancedBigtableStubSettings.Builder
extends com.google.api.gax.rpc.StubSettings.Builder<EnhancedBigtableStubSettings,EnhancedBigtableStubSettings.Builder>

Builder for BigtableDataSettings.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`areInternalMetricsEnabled()` Checks if internal metrics are disabled
`EnhancedBigtableStubSettings`	`build()`
`BigtableBatchingCallSettings.Builder`	`bulkMutateRowsSettings()` Returns the builder for the settings used for calls to MutateRows.
`BigtableBulkReadRowsCallSettings.Builder`	`bulkReadRowsSettings()` Returns the builder for the settings used for calls to MutateRows.
`com.google.api.gax.rpc.UnaryCallSettings.Builder<ConditionalRowMutation,Boolean>`	`checkAndMutateRowSettings()` Returns the builder for the settings used for calls to CheckAndMutateRow.
`EnhancedBigtableStubSettings.Builder`	`disableInternalMetrics()` Disable collection of internal metrics that help google detect issues accessing Bigtable.
`com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<BoundStatement,com.google.cloud.bigtable.data.v2.internal.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.
`com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<String,Range.ByteStringRange>`	`generateInitialChangeStreamPartitionsSettings()` Returns the builder for the settings used for calls to GenerateInitialChangeStreamPartitions.
`String`	`getAppProfileId()` Gets the app profile id that was previously set on this Builder.
`boolean`	`getEnableRetryInfo()` Deprecated. RetryInfo is always on.
`boolean`	`getEnableRoutingCookie()` Deprecated. routing cookies are always on.
`String`	`getInstanceId()` Gets the target instance id that was previously set on this Builder.
`Map<String,String>`	`getJwtAudienceMapping()` Deprecated. This is a no op and will always return an empty map. Audience is always set to bigtable service name.
`String`	`getMetricsEndpoint()` Get the Google Cloud Monitoring endpoint for publishing client side metrics.
`com.google.cloud.bigtable.data.v2.stub.metrics.MetricsProvider`	`getMetricsProvider()` Gets the `MetricsProvider`.
`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.
`String`	`getProjectId()` Gets the project id of the target instance that was previously set on this Builder.
`boolean`	`isRefreshingChannel()` Deprecated. Channel refreshing is enabled by default and this method will be deprecated.
`com.google.api.gax.rpc.UnaryCallSettings.Builder<RowMutation,Void>`	`mutateRowSettings()` Returns the builder for the settings used for calls to MutateRow.
`com.google.api.gax.rpc.UnaryCallSettings.Builder<PingAndWarmRequest,Void>`	`pingAndWarmSettings()` Returns the builder with the settings used for calls to PingAndWarm.
`com.google.api.gax.rpc.UnaryCallSettings.Builder<com.google.cloud.bigtable.data.v2.internal.PrepareQueryRequest,com.google.cloud.bigtable.data.v2.internal.PrepareResponse>`	`prepareQuerySettings()` Returns the builder with the settings used for calls to PrepareQuery
`com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<ReadChangeStreamQuery,ChangeStreamRecord>`	`readChangeStreamSettings()` Returns the builder for the settings used for calls to ReadChangeStream.
`com.google.api.gax.rpc.UnaryCallSettings.Builder<ReadModifyWriteRow,Row>`	`readModifyWriteRowSettings()` Returns the builder with the settings used for calls to ReadModifyWriteRow.
`com.google.api.gax.rpc.UnaryCallSettings.Builder<Query,Row>`	`readRowSettings()` Returns the builder for the settings used for point reads using readRow.
`com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<Query,Row>`	`readRowsSettings()` Returns the builder for the settings used for calls to readRows.
`com.google.api.gax.rpc.UnaryCallSettings.Builder<String,List<KeyOffset>>`	`sampleRowKeysSettings()` Returns the builder for the settings used for calls to SampleRowKeysSettings.
`EnhancedBigtableStubSettings.Builder`	`setAppProfileId(String appProfileId)` Sets the AppProfile to use.
`EnhancedBigtableStubSettings.Builder`	`setDefaultAppProfileId()` Resets the AppProfile id to the default for the instance.
`EnhancedBigtableStubSettings.Builder`	`setDirectPathConfig(EnhancedBigtableStubSettings.DirectPathConfig directPathConfig)`
`EnhancedBigtableStubSettings.Builder`	`setEnableRetryInfo(boolean enableRetryInfo)` Deprecated. This is a no-op, RetryInfo is always used now.
`EnhancedBigtableStubSettings.Builder`	`setEnableRoutingCookie(boolean enableRoutingCookie)` Deprecated. this now a no-op as routing cookies are always on.
`EnhancedBigtableStubSettings.Builder`	`setInstanceId(String instanceId)` Sets the target instance id.
`EnhancedBigtableStubSettings.Builder`	`setJwtAudience(String audience)` Set the jwt audience override.
`EnhancedBigtableStubSettings.Builder`	`setJwtAudienceMapping(Map<String,String> jwtAudienceMapping)` Deprecated. This is a no op. Audience is always set to bigtable service name.
`EnhancedBigtableStubSettings.Builder`	`setMetricsEndpoint(String endpoint)` Built-in client side metrics are published through Google Cloud Monitoring endpoint.
`EnhancedBigtableStubSettings.Builder`	`setMetricsProvider(com.google.cloud.bigtable.data.v2.stub.metrics.MetricsProvider metricsProvider)` Sets the `MetricsProvider`.
`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.
`EnhancedBigtableStubSettings.Builder`	`setProjectId(String projectId)` Sets the project id of that target instance.
`EnhancedBigtableStubSettings.Builder`	`setRefreshingChannel(boolean isRefreshingChannel)` Deprecated. Channel refreshing is enabled by default and this method will be deprecated.
`EnhancedBigtableStubSettings.Builder`	`setSessionsEnabled(boolean enabled)`

Methods inherited from class com.google.api.gax.rpc.StubSettings.Builder
applyToAllUnaryMethods, getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, self, setApiKey, setBackgroundExecutorProvider, setClock, setCredentialsProvider, setEndpoint, setExecutorProvider, setGdchApiAudience, setHeaderProvider, setInternalHeaderProvider, setMtlsEndpoint, setQuotaProjectId, setStreamWatchdogCheckInterval, setStreamWatchdogCheckIntervalDuration, setStreamWatchdogProvider, setSwitchToMtlsEndpointAllowed, setTracerFactory, setTransportChannelProvider, setUniverseDomain, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - setProjectId
```
public EnhancedBigtableStubSettings.Builder setProjectId(@Nonnull
                                                         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.
  - getProjectId
```
public String getProjectId()
```
    Gets the project id of the target instance that was previously set on this Builder.
  - setInstanceId
```
public EnhancedBigtableStubSettings.Builder setInstanceId(@Nonnull
                                                          String instanceId)
```
    Sets the target instance id. This setting is required. All RPCs will be made in the context of this setting.
  - getInstanceId
```
public String getInstanceId()
```
    Gets the target instance id that was previously set on this Builder.
  - setAppProfileId
```
public EnhancedBigtableStubSettings.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 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.
  - getAppProfileId
```
public String getAppProfileId()
```
    Gets the app profile id that was previously set on this Builder.
  - setRefreshingChannel
```
@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:
    
    BigtableDataSettings.Builder.setRefreshingChannel(boolean)
  - setDirectPathConfig
```
@InternalApi(value="For internal use only.")
public EnhancedBigtableStubSettings.Builder setDirectPathConfig(EnhancedBigtableStubSettings.DirectPathConfig directPathConfig)
```
  - setPrimedTableIds
```
@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.
  - 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.
  - 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.
  - setJwtAudienceMapping
```
@InternalApi(value="Used for internal testing")
 @Deprecated
public EnhancedBigtableStubSettings.Builder setJwtAudienceMapping(Map<String,String> jwtAudienceMapping)
```
    Deprecated. This is a no op. Audience is always set to bigtable service name.
    
    See Also:
    
    to override the audience.
  - setJwtAudience
```
@InternalApi(value="Used for internal testing")
public EnhancedBigtableStubSettings.Builder setJwtAudience(String audience)
```
    Set the jwt audience override.
  - setSessionsEnabled
```
@InternalApi
public EnhancedBigtableStubSettings.Builder setSessionsEnabled(boolean enabled)
```
  - setMetricsProvider
```
public EnhancedBigtableStubSettings.Builder setMetricsProvider(com.google.cloud.bigtable.data.v2.stub.metrics.MetricsProvider metricsProvider)
```
    Sets the MetricsProvider.
    By default, this is set to DefaultMetricsProvider.INSTANCE which will collect and export client side metrics.
    To disable client side metrics, set it to NoopMetricsProvider.INSTANCE.
    To use a custom OpenTelemetry instance, refer to CustomOpenTelemetryMetricsProvider on how to set it up.
  - getMetricsProvider
```
public com.google.cloud.bigtable.data.v2.stub.metrics.MetricsProvider getMetricsProvider()
```
    Gets the MetricsProvider.
  - setMetricsEndpoint
```
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.
  - getMetricsEndpoint
```
@Nullable
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.
  - disableInternalMetrics
```
public EnhancedBigtableStubSettings.Builder disableInternalMetrics()
```
    Disable collection of internal metrics that help google detect issues accessing Bigtable.
  - areInternalMetricsEnabled
```
public boolean areInternalMetricsEnabled()
```
    Checks if internal metrics are disabled
  - getJwtAudienceMapping
```
@InternalApi(value="Used for internal testing")
 @Deprecated
public Map<String,String> getJwtAudienceMapping()
```
    Deprecated. This is a no op and will always return an empty map. Audience is always set to bigtable service name.
    
    See Also:
    
    to get the audience.
  - setEnableRoutingCookie
```
@Deprecated
public EnhancedBigtableStubSettings.Builder setEnableRoutingCookie(boolean enableRoutingCookie)
```
    Deprecated. this now a no-op as routing cookies are always on.
  - getEnableRoutingCookie
```
@Deprecated
public boolean getEnableRoutingCookie()
```
    Deprecated. routing cookies are always on.
  - setEnableRetryInfo
```
@Deprecated
public EnhancedBigtableStubSettings.Builder setEnableRetryInfo(boolean enableRetryInfo)
```
    Deprecated. This is a no-op, RetryInfo is always used now.
  - getEnableRetryInfo
```
@Deprecated
public boolean getEnableRetryInfo()
```
    Deprecated. RetryInfo is always on.
  - readRowsSettings
```
public com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<Query,Row> readRowsSettings()
```
    Returns the builder for the settings used for calls to readRows.
  - readRowSettings
```
public com.google.api.gax.rpc.UnaryCallSettings.Builder<Query,Row> readRowSettings()
```
    Returns the builder for the settings used for point reads using readRow.
  - sampleRowKeysSettings
```
public com.google.api.gax.rpc.UnaryCallSettings.Builder<String,List<KeyOffset>> sampleRowKeysSettings()
```
    Returns the builder for the settings used for calls to SampleRowKeysSettings.
  - mutateRowSettings
```
public com.google.api.gax.rpc.UnaryCallSettings.Builder<RowMutation,Void> mutateRowSettings()
```
    Returns the builder for the settings used for calls to MutateRow.
  - bulkMutateRowsSettings
```
public BigtableBatchingCallSettings.Builder bulkMutateRowsSettings()
```
    Returns the builder for the settings used for calls to MutateRows.
  - bulkReadRowsSettings
```
public BigtableBulkReadRowsCallSettings.Builder bulkReadRowsSettings()
```
    Returns the builder for the settings used for calls to MutateRows.
  - checkAndMutateRowSettings
```
public com.google.api.gax.rpc.UnaryCallSettings.Builder<ConditionalRowMutation,Boolean> checkAndMutateRowSettings()
```
    Returns the builder for the settings used for calls to CheckAndMutateRow.
  - readModifyWriteRowSettings
```
public com.google.api.gax.rpc.UnaryCallSettings.Builder<ReadModifyWriteRow,Row> readModifyWriteRowSettings()
```
    Returns the builder with the settings used for calls to ReadModifyWriteRow.
  - readChangeStreamSettings
```
public com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<ReadChangeStreamQuery,ChangeStreamRecord> readChangeStreamSettings()
```
    Returns the builder for the settings used for calls to ReadChangeStream.
  - generateInitialChangeStreamPartitionsSettings
```
public com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<String,Range.ByteStringRange> generateInitialChangeStreamPartitionsSettings()
```
    Returns the builder for the settings used for calls to GenerateInitialChangeStreamPartitions.
  - pingAndWarmSettings
```
public com.google.api.gax.rpc.UnaryCallSettings.Builder<PingAndWarmRequest,Void> pingAndWarmSettings()
```
    Returns the builder with the settings used for calls to PingAndWarm.
  - executeQuerySettings
```
@BetaApi
public com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<BoundStatement,com.google.cloud.bigtable.data.v2.internal.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.
  - prepareQuerySettings
```
@BetaApi
public com.google.api.gax.rpc.UnaryCallSettings.Builder<com.google.cloud.bigtable.data.v2.internal.PrepareQueryRequest,com.google.cloud.bigtable.data.v2.internal.PrepareResponse> prepareQuerySettings()
```
    Returns the builder with the settings used for calls to PrepareQuery
  - build
```
public EnhancedBigtableStubSettings build()
```
    Specified by:
    
    build in class com.google.api.gax.rpc.StubSettings.Builder<EnhancedBigtableStubSettings,EnhancedBigtableStubSettings.Builder>

Class EnhancedBigtableStubSettings.Builder

Method Summary

Methods inherited from class com.google.api.gax.rpc.StubSettings.Builder

Methods inherited from class java.lang.Object

Method Detail

setProjectId

getProjectId

setInstanceId

getInstanceId

setAppProfileId

setDefaultAppProfileId

getAppProfileId

setRefreshingChannel

setDirectPathConfig

setPrimedTableIds

isRefreshingChannel

getPrimedTableIds

setJwtAudienceMapping

setJwtAudience

setSessionsEnabled

setMetricsProvider

getMetricsProvider

setMetricsEndpoint

getMetricsEndpoint

disableInternalMetrics

areInternalMetricsEnabled

getJwtAudienceMapping

setEnableRoutingCookie

getEnableRoutingCookie

setEnableRetryInfo

getEnableRetryInfo

readRowsSettings

readRowSettings

sampleRowKeysSettings

mutateRowSettings

bulkMutateRowsSettings

bulkReadRowsSettings

checkAndMutateRowSettings

readModifyWriteRowSettings

readChangeStreamSettings

generateInitialChangeStreamPartitionsSettings

pingAndWarmSettings

executeQuerySettings

prepareQuerySettings

build