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

Class BigtableBatchingCallSettings

java.lang.Object

com.google.api.gax.rpc.UnaryCallSettings<BulkMutation,Void>

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

@BetaApi("This surface is likely to change as the batching surface evolves.")
public final class BigtableBatchingCallSettings
extends com.google.api.gax.rpc.UnaryCallSettings<BulkMutation,Void>

This settings holds the batching thresholds as well as retry configuration.

Sample configuration:

 BigtableBatchingCallSettings defaultBatchingCallSettings =
     bigtableDataCallSettings.getStubSettings().bulkMutateRowsSettings();

 BigtableBatchingCallSettings customBatchingCallSettings = defaultBatchingCallSettings.toBuilder()
     .setBatchingSettings(
         defaultBatchingCallSettings.getBatchingSettings().toBuilder()
             .setDelayThreshold(Duration.ofSeconds(10))
             .build())
     .setRetryableCodes(Code.DEADLINE_EXCEEDED)
     .setLatencyBasedThrottling(true, 1000L)
     .build();
 

See Also:

• for batching thresholds explantion.
• for retry configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BigtableBatchingCallSettings.Builder	A base builder class for BigtableBatchingCallSettings.

Method Summary

Modifier and Type	Method	Description
com.google.api.gax.batching.BatchingSettings	getBatchingSettings()	Returns batching settings which contains multiple batch threshold levels.
Long	getTargetRpcLatencyMs()	Gets target rpc latency if latency based throttling is enabled.
boolean	isLatencyBasedThrottlingEnabled()	Gets if latency based throttling is enabled.
boolean	isServerInitiatedFlowControlEnabled()	Gets if flow control is enabled.
final BigtableBatchingCallSettings.Builder	toBuilder()	Get a builder with the same values as this object.
String	toString()

Methods inherited from class com.google.api.gax.rpc.UnaryCallSettings

equals, getRetryableCodes, getRetrySettings, hashCode, newUnaryCallSettingsBuilder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getBatchingSettings

public com.google.api.gax.batching.BatchingSettings getBatchingSettings()

Returns batching settings which contains multiple batch threshold levels.

isLatencyBasedThrottlingEnabled

public boolean isLatencyBasedThrottlingEnabled()

Gets if latency based throttling is enabled.

getTargetRpcLatencyMs

@Nullable
public Long getTargetRpcLatencyMs()

Gets target rpc latency if latency based throttling is enabled. Otherwise returns null.

isServerInitiatedFlowControlEnabled

@InternalApi("Intended for use by the Bigtable dataflow connectors only")
public boolean isServerInitiatedFlowControlEnabled()

Gets if flow control is enabled.

toBuilder

public final BigtableBatchingCallSettings.Builder toBuilder()

Get a builder with the same values as this object. See the class documentation of BigtableBatchingCallSettings for a sample settings configuration.

Overrides:

toBuilder in class com.google.api.gax.rpc.UnaryCallSettings<BulkMutation,Void>

toString

public String toString()

Overrides:

toString in class com.google.api.gax.rpc.UnaryCallSettings<BulkMutation,Void>