Package com.google.cloud.bigtable.data.v2.stub

Class EnhancedBigtableStubSettings.Builder

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 Details

    • 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:

    • 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("Used for internal testing") public EnhancedBigtableStubSettings.Builder setJwtAudienceMapping(Map<String,String> jwtAudienceMapping)

    • 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.

    • getJwtAudienceMapping

      @InternalApi("Used for internal testing") public Map<String,String> getJwtAudienceMapping()

    • setEnableRoutingCookie

      @BetaApi("Routing cookie is not currently stable and may change in the future") 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.

    • getEnableRoutingCookie

      @BetaApi("Routing cookie is not currently stable and may change in the future") public boolean getEnableRoutingCookie()
      Gets if routing cookie is enabled. If true, client will retry a request with extra metadata server sent back.

    • setEnableRetryInfo

      @BetaApi("RetryInfo is not currently stable and may change in the future") 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.

    • getEnableRetryInfo

      @BetaApi("RetryInfo is not currently stable and may change in the future") 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.

    • 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<Statement,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.

    • build

      public EnhancedBigtableStubSettings build()
      Specified by:
      build in class com.google.api.gax.rpc.StubSettings.Builder<EnhancedBigtableStubSettings,EnhancedBigtableStubSettings.Builder>