com.google.cloud.bigtable.config

Class CallOptionsConfig.Builder

java.lang.Object

com.google.cloud.bigtable.config.CallOptionsConfig.Builder

Enclosing class:

CallOptionsConfig

public static class CallOptionsConfig.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder() Deprecated. Please use CallOptionsConfig.builder()

Method Summary

Modifier and Type	Method and Description
CallOptionsConfig	build()
CallOptionsConfig.Builder	setLongRpcTimeoutMs(int longRpcTimeoutMs) Deprecated. Please use setMutateRpcTimeoutMs(int) or setReadRowsRpcTimeoutMs(int).
CallOptionsConfig.Builder	setMutateRpcAttemptTimeoutMs(int mutateRpcAttemptTimeoutMs) The amount of time in milliseconds to wait before issuing a client side timeout for bulk row mutation RPCs (i.e.
CallOptionsConfig.Builder	setMutateRpcTimeoutMs(int mutateRpcTimeoutMs) The amount of time in milliseconds to wait before issuing a client side timeout for bulk row mutation RPCs (i.e.
CallOptionsConfig.Builder	setReadRowsRpcAttemptTimeoutMs(int readRowsRpcAttemptTimeoutMs) The amount of time in milliseconds to wait before issuing a client side timeout for readRows streaming RPCs.
CallOptionsConfig.Builder	setReadRowsRpcTimeoutMs(int readStreamRpcTimeoutMs) The amount of time in millisecond to wait before issuing a client side timeout for readRows streaming RPCs.
CallOptionsConfig.Builder	setShortRpcAttemptTimeoutMs(int shortRpcAttemptTimeoutMs) The amount of milliseconds to wait before issuing a client side timeout for a short RPC attempt.
CallOptionsConfig.Builder	setShortRpcTimeoutMs(int shortRpcTimeoutMs) The amount of milliseconds to wait before issuing a client side timeout for a short RPC operation.
CallOptionsConfig.Builder	setTimeoutMs(int timeoutMs) Deprecated. Use setShortRpcAttemptTimeoutMs(int) instead
CallOptionsConfig.Builder	setUseTimeout(boolean useTimeout) If true, turn on timeouts for unary RPCS like mutations, and single row readRows.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

@Deprecated
public Builder()

Deprecated. Please use CallOptionsConfig.builder()

Method Detail

setUseTimeout

public CallOptionsConfig.Builder setUseTimeout(boolean useTimeout)

If true, turn on timeouts for unary RPCS like mutations, and single row readRows.

Parameters:

useTimeout - flag to enable use of timeout.

Returns:

a CallOptionsConfig.Builder object, for chaining

setTimeoutMs

@Deprecated
public CallOptionsConfig.Builder setTimeoutMs(int timeoutMs)

Deprecated. Use setShortRpcAttemptTimeoutMs(int) instead

The amount of milliseconds to wait before issuing a client side timeout for short RPCs.

Parameters:

timeoutMs - timeout value in milliseconds.

Returns:

a CallOptionsConfig.Builder object, for chaining

setShortRpcTimeoutMs

public CallOptionsConfig.Builder setShortRpcTimeoutMs(int shortRpcTimeoutMs)

The amount of milliseconds to wait before issuing a client side timeout for a short RPC operation.

By short RPC, we mean single-row operations like CheckAndMutateRow, MutateRow, and ReadRows on a single key.

The timeout spans the full end-to-end operation from the user perspective, i.e. covering multiple retry attempts.

Parameters:

shortRpcTimeoutMs - timeout value in milliseconds.

Returns:

a CallOptionsConfig.Builder object, for chaining

setShortRpcAttemptTimeoutMs

@BetaApi(value="The API for setting attempt timeouts is not yet stable and may change in the future")
public CallOptionsConfig.Builder setShortRpcAttemptTimeoutMs(int shortRpcAttemptTimeoutMs)

The amount of milliseconds to wait before issuing a client side timeout for a short RPC attempt.

See setShortRpcTimeoutMs(int) for the definition of short RPC.

This timeout covers a single RPC call attempt to the server, whereas setShortRpcTimeoutMs(int) covers the total time across all attempts.

Parameters:

shortRpcAttemptTimeoutMs - timeout value in milliseconds.

Returns:

a CallOptionsConfig.Builder object, for chaining

setLongRpcTimeoutMs

@Deprecated
public CallOptionsConfig.Builder setLongRpcTimeoutMs(int longRpcTimeoutMs)

Deprecated. Please use setMutateRpcTimeoutMs(int) or setReadRowsRpcTimeoutMs(int).

The amount of milliseconds to wait before issuing a client side timeout for long running RPCs.

Parameters:

longRpcTimeoutMs - timeout value in milliseconds.

Returns:

a CallOptionsConfig.Builder object, for chaining

setMutateRpcTimeoutMs

public CallOptionsConfig.Builder setMutateRpcTimeoutMs(int mutateRpcTimeoutMs)

The amount of time in milliseconds to wait before issuing a client side timeout for bulk row mutation RPCs (i.e. multiple rows). Single-row mutations are governed by shortRpcTimeoutMs;

The timeout spans the full end-to-end operation from the user perspective, i.e. covering multiple retry attempts.

Parameters:

mutateRpcTimeoutMs - timeout value in milliseconds.

Returns:

a CallOptionsConfig.Builder object, for chaining

setMutateRpcAttemptTimeoutMs

@BetaApi(value="The API for setting attempt timeouts is not yet stable and may change in the future")
public CallOptionsConfig.Builder setMutateRpcAttemptTimeoutMs(int mutateRpcAttemptTimeoutMs)

The amount of time in milliseconds to wait before issuing a client side timeout for bulk row mutation RPCs (i.e. multiple rows). Single-row mutations are governed by shortRpcAttemptTimeoutMs;

This timeout covers a single RPC call attempt to the server, whereas setShortRpcTimeoutMs(int) covers the total time across all attempts.

Parameters:

mutateRpcAttemptTimeoutMs - timeout value in milliseconds.

Returns:

a CallOptionsConfig.Builder object, for chaining

setReadRowsRpcTimeoutMs

public CallOptionsConfig.Builder setReadRowsRpcTimeoutMs(int readStreamRpcTimeoutMs)

The amount of time in millisecond to wait before issuing a client side timeout for readRows streaming RPCs.

The timeout spans the full end-to-end operation from the user perspective, i.e. covering multiple retry attempts.

Parameters:

readStreamRpcTimeoutMs - timeout value in milliseconds.

Returns:

a CallOptionsConfig.Builder object, for chaining

setReadRowsRpcAttemptTimeoutMs

@BetaApi(value="The API for setting attempt timeouts is not yet stable and may change in the future")
public CallOptionsConfig.Builder setReadRowsRpcAttemptTimeoutMs(int readRowsRpcAttemptTimeoutMs)

The amount of time in milliseconds to wait before issuing a client side timeout for readRows streaming RPCs.

This timeout covers a single RPC call attempt to the server, whereas setShortRpcTimeoutMs(int) covers the total time across all attempts.

Parameters:

readRowsRpcAttemptTimeoutMs - timeout value in milliseconds.

Returns:

a CallOptionsConfig.Builder object, for chaining

build

public CallOptionsConfig build()