Class EnhancedBigtableStubSettings.Builder (2.3.1)

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

Builder for BigtableDataSettings.

Inheritance

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

Inherited Members

StubSettings.Builder.<B>build()

StubSettings.Builder.applyToAllUnaryMethods(Iterable<UnaryCallSettings.Builder<?,?>>,ApiFunction<UnaryCallSettings.Builder<?,?>,Void>)

StubSettings.Builder.getBackgroundExecutorProvider()

StubSettings.Builder.getClock()

StubSettings.Builder.getCredentialsProvider()

StubSettings.Builder.getEndpoint()

StubSettings.Builder.getExecutorProvider()

StubSettings.Builder.getHeaderProvider()

StubSettings.Builder.getInternalHeaderProvider()

StubSettings.Builder.getMtlsEndpoint()

StubSettings.Builder.getQuotaProjectId()

StubSettings.Builder.getStreamWatchdogCheckInterval()

StubSettings.Builder.getStreamWatchdogProvider()

StubSettings.Builder.getTracerFactory()

StubSettings.Builder.getTransportChannelProvider()

StubSettings.Builder.self()

StubSettings.Builder.setBackgroundExecutorProvider(ExecutorProvider)

StubSettings.Builder.setClock(ApiClock)

StubSettings.Builder.setCredentialsProvider(CredentialsProvider)

StubSettings.Builder.setEndpoint(String)

StubSettings.Builder.setExecutorProvider(ExecutorProvider)

StubSettings.Builder.setHeaderProvider(HeaderProvider)

StubSettings.Builder.setInternalHeaderProvider(HeaderProvider)

StubSettings.Builder.setMtlsEndpoint(String)

StubSettings.Builder.setQuotaProjectId(String)

StubSettings.Builder.setStreamWatchdogCheckInterval(Duration)

StubSettings.Builder.setStreamWatchdogProvider(WatchdogProvider)

StubSettings.Builder.setSwitchToMtlsEndpointAllowed(boolean)

StubSettings.Builder.setTracerFactory(ApiTracerFactory)

StubSettings.Builder.setTransportChannelProvider(TransportChannelProvider)

StubSettings.Builder.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build()

public EnhancedBigtableStubSettings build()

Returns

Type	Description
EnhancedBigtableStubSettings

Overrides

StubSettings.Builder<SettingsT,B>.<B>build()

bulkMutateRowsSettings()

public BigtableBatchingCallSettings.Builder bulkMutateRowsSettings()

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

Returns

Type	Description
BigtableBatchingCallSettings.Builder

bulkReadRowsSettings()

public BigtableBulkReadRowsCallSettings.Builder bulkReadRowsSettings()

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

Returns

Type	Description
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>

getAppProfileId()

public String getAppProfileId()

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

Returns

Type	Description
String

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>

getPrimedTableIds()

public List<String> getPrimedTableIds()

Gets the tables that will be primed during a channel refresh.

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()

public boolean isRefreshingChannel()

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>

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

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

setPrimedTableIds(String[] tableIds)

public EnhancedBigtableStubSettings.Builder setPrimedTableIds(String[] tableIds)

Configures which tables will be primed when a connection is created.

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)

public EnhancedBigtableStubSettings.Builder setRefreshingChannel(boolean isRefreshingChannel)

Sets if channels will gracefully refresh connections to Cloud Bigtable service.

When enabled, this will wait for the connection to complete the SSL handshake. The effect can be enhanced by configuring table ids that can be used warm serverside caches using #setPrimedTableIds(String...).

Parameter

Name	Description
isRefreshingChannel	`boolean`

Returns

Type	Description
EnhancedBigtableStubSettings.Builder