com.google.cloud.bigtable.config

Class CallOptionsConfig

java.lang.Object

com.google.cloud.bigtable.config.CallOptionsConfig

All Implemented Interfaces:

Serializable

public class CallOptionsConfig
extends Object
implements Serializable

Experimental options to turn on timeout options. CallOptions supports other settings as well, which this configuration object could help set.

Version:

$Id: $Id

Author:

sduskis

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CallOptionsConfig.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	LONG_TIMEOUT_MS_DEFAULT The default duration to wait before timing out RPCs.
static int	SHORT_TIMEOUT_MS_DEFAULT The default duration to wait before timing out RPCs.
static boolean	USE_TIMEOUT_DEFAULT Constant USE_TIMEOUT_DEFAULT=false

Constructor Summary

Constructors

Constructor and Description
CallOptionsConfig(boolean useTimeout, int unaryRpcTimeoutMs, int longRpcTimeoutMs) Constructor for CallOptionsConfig.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getLongRpcTimeoutMs() Getter for the field longRpcTimeoutMs.
int	getShortRpcTimeoutMs() Getter for the field shortRpcTimeoutMs.
int	getTimeoutMs() Deprecated.
boolean	isUseTimeout() isUseTimeout.
CallOptionsConfig.Builder	toBuilder() toBuilder.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

USE_TIMEOUT_DEFAULT

public static final boolean USE_TIMEOUT_DEFAULT

Constant USE_TIMEOUT_DEFAULT=false

See Also:

Constant Field Values

SHORT_TIMEOUT_MS_DEFAULT

public static final int SHORT_TIMEOUT_MS_DEFAULT

The default duration to wait before timing out RPCs. 1 minute is probably too long for most RPCs, but the intent is to have a conservative timeout by default and aim for user overrides.

See Also:

Constant Field Values

LONG_TIMEOUT_MS_DEFAULT

public static final int LONG_TIMEOUT_MS_DEFAULT

The default duration to wait before timing out RPCs. 10 minute is probably too long for most RPCs, but the intent is to have a conservative timeout by default and aim for user overrides. There could very well be 10 minute scans, so keep the value conservative for most cases and allow user overrides as needed.

See Also:

Constant Field Values

Constructor Detail

CallOptionsConfig

public CallOptionsConfig(boolean useTimeout,
                         int unaryRpcTimeoutMs,
                         int longRpcTimeoutMs)

Constructor for CallOptionsConfig.

Parameters:

useTimeout - a boolean.

unaryRpcTimeoutMs - an int.

longRpcTimeoutMs - an int.

Method Detail

isUseTimeout

public boolean isUseTimeout()

isUseTimeout.

Returns:

a boolean.

getTimeoutMs

@Deprecated
public int getTimeoutMs()

Deprecated.

Getter for the field shortRpcTimeoutMs. Use getShortRpcTimeoutMs() instead.

Returns:

an int.

getShortRpcTimeoutMs

public int getShortRpcTimeoutMs()

Getter for the field shortRpcTimeoutMs.

Returns:

an int.

getLongRpcTimeoutMs

public int getLongRpcTimeoutMs()

Getter for the field longRpcTimeoutMs.

Returns:

an int.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public CallOptionsConfig.Builder toBuilder()

toBuilder.

Returns:

a CallOptionsConfig.Builder object.