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

Class BigtableBatchingCallSettings.Builder

java.lang.Object

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

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

Enclosing class:

BigtableBatchingCallSettings

public static class BigtableBatchingCallSettings.Builder
extends com.google.api.gax.rpc.UnaryCallSettings.Builder<BulkMutation,Void>

A base builder class for BigtableBatchingCallSettings. See the class documentation of BigtableBatchingCallSettings for a description of the different values that can be set.

Method Summary

Modifier and Type	Method	Description
BigtableBatchingCallSettings	build()	Builds the BigtableBatchingCallSettings object with provided configuration.
BigtableBatchingCallSettings.Builder	disableLatencyBasedThrottling()	Disable latency based throttling.
BigtableBatchingCallSettings.Builder	enableLatencyBasedThrottling(long targetRpcLatency)	Enable latency based throttling.
com.google.api.gax.batching.BatchingSettings	getBatchingSettings()	Returns the BatchingSettings.
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 based on the load of the Bigtable server.
BigtableBatchingCallSettings.Builder	setBatchingSettings(com.google.api.gax.batching.BatchingSettings batchingSettings)	Sets the batching settings with various thresholds.
BigtableBatchingCallSettings.Builder	setRetryableCodes(com.google.api.gax.rpc.StatusCode.Code... codes)	Sets the rpc failure code, for which retries should be performed.
BigtableBatchingCallSettings.Builder	setRetryableCodes(Set<com.google.api.gax.rpc.StatusCode.Code> retryableCodes)	Sets the rpc failure code, for which retries should be performed.
BigtableBatchingCallSettings.Builder	setRetrySettings(com.google.api.gax.retrying.RetrySettings retrySettings)	Sets the RetrySettings values for each retry attempts.
BigtableBatchingCallSettings.Builder	setServerInitiatedFlowControl(boolean isEnable)	Configure flow control based on the current load of the Bigtable server.

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

getRetryableCodes, getRetrySettings, retrySettings, setSimpleTimeoutNoRetries

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setBatchingSettings

public BigtableBatchingCallSettings.Builder setBatchingSettings(@Nonnull
                                                                com.google.api.gax.batching.BatchingSettings batchingSettings)

Sets the batching settings with various thresholds.

getBatchingSettings

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

Returns the BatchingSettings.

setRetryableCodes

public BigtableBatchingCallSettings.Builder setRetryableCodes(com.google.api.gax.rpc.StatusCode.Code... codes)

Sets the rpc failure code, for which retries should be performed.

Overrides:

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

setRetryableCodes

public BigtableBatchingCallSettings.Builder setRetryableCodes(Set<com.google.api.gax.rpc.StatusCode.Code> retryableCodes)

Sets the rpc failure code, for which retries should be performed.

Overrides:

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

setRetrySettings

public BigtableBatchingCallSettings.Builder setRetrySettings(@Nonnull
                                                             com.google.api.gax.retrying.RetrySettings retrySettings)

Sets the RetrySettings values for each retry attempts.

Overrides:

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

enableLatencyBasedThrottling

public BigtableBatchingCallSettings.Builder enableLatencyBasedThrottling(long targetRpcLatency)

Enable latency based throttling. The number of allowed in-flight requests will be adjusted to reach the target rpc latency.

disableLatencyBasedThrottling

public BigtableBatchingCallSettings.Builder disableLatencyBasedThrottling()

Disable latency based throttling.

getTargetRpcLatencyMs

@Nullable
public Long getTargetRpcLatencyMs()

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

isLatencyBasedThrottlingEnabled

public boolean isLatencyBasedThrottlingEnabled()

Gets if latency based throttling is enabled.

setServerInitiatedFlowControl

@InternalApi("Intended for use by the Bigtable dataflow connectors only")
public BigtableBatchingCallSettings.Builder setServerInitiatedFlowControl(boolean isEnable)

Configure flow control based on the current load of the Bigtable server.

isServerInitiatedFlowControlEnabled

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

Gets if flow control is enabled based on the load of the Bigtable server.

build

public BigtableBatchingCallSettings build()

Builds the BigtableBatchingCallSettings object with provided configuration.

Overrides:

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