com.google.cloud.bigtable.config

Class CallOptionsConfig

java.lang.Object

com.google.cloud.bigtable.config.CallOptionsConfig

All Implemented Interfaces:

Serializable

@InternalExtensionOnly
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.

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 idempotent RPCs operation.
static int	SHORT_TIMEOUT_MS_DEFAULT The default duration to wait before timing out RPCs (default value: 20 seconds).
static boolean	USE_TIMEOUT_DEFAULT Constant USE_TIMEOUT_DEFAULT=false

Constructor Summary

Constructors

Constructor and Description
CallOptionsConfig(boolean useTimeout, int unaryRpcTimeoutMs, int longRpcTimeoutMs) Deprecated. Please use builder()

Method Summary

Modifier and Type	Method and Description
static CallOptionsConfig.Builder	builder()
boolean	equals(Object obj)
int	getLongRpcTimeoutMs() Deprecated. Please use getMutateRpcTimeoutMs() or getReadStreamRpcTimeoutMs().
com.google.common.base.Optional<Integer>	getMutateRpcAttemptTimeoutMs() Getter for the field mutateRpcAttemptTimeoutMs.
int	getMutateRpcTimeoutMs() Getter for the field mutateRpcTimeoutMs.
com.google.common.base.Optional<Integer>	getReadStreamRpcAttemptTimeoutMs() Getter for the field readStreamRpcAttemptTimeoutMs.
int	getReadStreamRpcTimeoutMs() Getter for the field readStreamRpcTimeoutMs.
com.google.common.base.Optional<Integer>	getShortRpcAttemptTimeoutMs() Getter for the field shortRpcAttemptTimeoutMs.
int	getShortRpcTimeoutMs() Getter for the field shortRpcTimeoutMs.
int	getTimeoutMs() Deprecated.
int	hashCode()
boolean	isUseTimeout() isUseTimeout.
CallOptionsConfig.Builder	toBuilder() toBuilder.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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 (default value: 20 seconds).

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 idempotent RPCs operation. 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

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

Deprecated. Please use builder()

Constructor for CallOptionsConfig.

Parameters:

useTimeout - a boolean.

unaryRpcTimeoutMs - an int.

longRpcTimeoutMs - an int.

Method Detail

builder

public static CallOptionsConfig.Builder builder()

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.

getShortRpcAttemptTimeoutMs

@BetaApi(value="The API for getting attempt timeouts is not yet stable and may change in the future")
public com.google.common.base.Optional<Integer> getShortRpcAttemptTimeoutMs()

Getter for the field shortRpcAttemptTimeoutMs.

If the Optional value is not present, the attempt timeout will leverage shortRpcTimeoutMs.

Returns:

an Optional int, populated if the property was present.

getLongRpcTimeoutMs

@Deprecated
public int getLongRpcTimeoutMs()

Deprecated. Please use getMutateRpcTimeoutMs() or getReadStreamRpcTimeoutMs().

Getter for the field longRpcTimeoutMs.

Returns:

an int.

getMutateRpcTimeoutMs

public int getMutateRpcTimeoutMs()

Getter for the field mutateRpcTimeoutMs.

Returns:

an int.

getMutateRpcAttemptTimeoutMs

@BetaApi(value="The API for getting attempt timeouts is not yet stable and may change in the future")
public com.google.common.base.Optional<Integer> getMutateRpcAttemptTimeoutMs()

Getter for the field mutateRpcAttemptTimeoutMs.

If the Optional value is not present, the attempt timeout will leverage mutateRpcTimeoutMs.

Returns:

an Optional int, populated if the property was present.

getReadStreamRpcTimeoutMs

public int getReadStreamRpcTimeoutMs()

Getter for the field readStreamRpcTimeoutMs.

Returns:

an int.

getReadStreamRpcAttemptTimeoutMs

@BetaApi(value="The API for getting attempt timeouts is not yet stable and may change in the future")
public com.google.common.base.Optional<Integer> getReadStreamRpcAttemptTimeoutMs()

Getter for the field readStreamRpcAttemptTimeoutMs.

If the Optional value is not present, the attempt timeout will leverage readStreamRpcTimeoutMs.

Returns:

an Optional int, populated if the property was present.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public CallOptionsConfig.Builder toBuilder()

toBuilder.

Returns:

a CallOptionsConfig.Builder object.