Class EnhancedBigtableStubSettings.Builder (2.31.0)

public static class EnhancedBigtableStubSettings.Builder extends StubSettings.Builder<EnhancedBigtableStubSettings,EnhancedBigtableStubSettings.Builder>

Builder for BigtableDataSettings.

Inheritance

java.lang.Object > StubSettings.Builder > EnhancedBigtableStubSettings.Builder

Methods

build()

public EnhancedBigtableStubSettings build()
Returns
TypeDescription
EnhancedBigtableStubSettings
Overrides

bulkMutateRowsSettings()

public BigtableBatchingCallSettings.Builder bulkMutateRowsSettings()

Returns the builder for the settings used for calls to MutateRows.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Builder<ConditionalRowMutation,Boolean>

generateInitialChangeStreamPartitionsSettings()

public ServerStreamingCallSettings.Builder<String,Range.ByteStringRange> generateInitialChangeStreamPartitionsSettings()

Returns the builder for the settings used for calls to GenerateInitialChangeStreamPartitions.

Returns
TypeDescription
Builder<String,ByteStringRange>

getAppProfileId()

public String getAppProfileId()

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

getInstanceId()

public String getInstanceId()

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

Returns
TypeDescription
String

getJwtAudienceMapping()

public Map<String,String> getJwtAudienceMapping()
Returns
TypeDescription
Map<String,String>

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
TypeDescription
List<String>

getProjectId()

public String getProjectId()

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

Returns
TypeDescription
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
TypeDescription
boolean

mutateRowSettings()

public UnaryCallSettings.Builder<RowMutation,Void> mutateRowSettings()

Returns the builder for the settings used for calls to MutateRow.

Returns
TypeDescription
Builder<RowMutation,Void>

pingAndWarmSettings()

public UnaryCallSettings.Builder<PingAndWarmRequest,Void> pingAndWarmSettings()

Returns the builder with the settings used for calls to PingAndWarm.

Returns
TypeDescription
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
TypeDescription
Builder<ReadChangeStreamQuery,ChangeStreamRecord>

readModifyWriteRowSettings()

public UnaryCallSettings.Builder<ReadModifyWriteRow,Row> readModifyWriteRowSettings()

Returns the builder with the settings used for calls to ReadModifyWriteRow.

Returns
TypeDescription
Builder<ReadModifyWriteRow,Row>

readRowSettings()

public UnaryCallSettings.Builder<Query,Row> readRowSettings()

Returns the builder for the settings used for point reads using readRow.

Returns
TypeDescription
Builder<Query,Row>

readRowsSettings()

public ServerStreamingCallSettings.Builder<Query,Row> readRowsSettings()

Returns the builder for the settings used for calls to readRows.

Returns
TypeDescription
Builder<Query,Row>

sampleRowKeysSettings()

public UnaryCallSettings.Builder<String,List<KeyOffset>> sampleRowKeysSettings()

Returns the builder for the settings used for calls to SampleRowKeysSettings.

Returns
TypeDescription
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
NameDescription
appProfileIdString
Returns
TypeDescription
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
TypeDescription
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
NameDescription
enableRetryInfoboolean
Returns
TypeDescription
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
NameDescription
enableRoutingCookieboolean
Returns
TypeDescription
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
NameDescription
instanceIdString
Returns
TypeDescription
EnhancedBigtableStubSettings.Builder

setJwtAudienceMapping(Map<String,String> jwtAudienceMapping)

public EnhancedBigtableStubSettings.Builder setJwtAudienceMapping(Map<String,String> jwtAudienceMapping)
Parameter
NameDescription
jwtAudienceMappingMap<String,String>
Returns
TypeDescription
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
NameDescription
tableIdsString[]
Returns
TypeDescription
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
NameDescription
projectIdString
Returns
TypeDescription
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
NameDescription
isRefreshingChannelboolean
Returns
TypeDescription
EnhancedBigtableStubSettings.Builder