org.apache.hadoop.hbase.client

Class AsyncAdminBuilderBase

java.lang.Object

org.apache.hadoop.hbase.client.AsyncAdminBuilderBase

All Implemented Interfaces:

AsyncAdminBuilder

@InterfaceAudience.Private
abstract class AsyncAdminBuilderBase
extends Object
implements AsyncAdminBuilder

Base class for all asynchronous admin builders.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxAttempts
protected long	operationTimeoutNs
protected long	pauseNs
protected long	pauseNsForServerOverloaded
protected long	rpcTimeoutNs
protected int	startLogErrorsCnt

Constructor Summary

Constructors

Constructor and Description
AsyncAdminBuilderBase(AsyncConnectionConfiguration connConf)

Method Summary

Modifier and Type	Method and Description
AsyncAdminBuilder	setMaxAttempts(int maxAttempts) Set the max attempt times for an admin operation.
AsyncAdminBuilder	setOperationTimeout(long timeout, TimeUnit unit) Set timeout for a whole admin operation.
AsyncAdminBuilder	setRetryPause(long timeout, TimeUnit unit) Set the base pause time for retrying.
AsyncAdminBuilder	setRetryPauseForServerOverloaded(long timeout, TimeUnit unit) Set the base pause time for retrying when HBaseServerException.isServerOverloaded().
AsyncAdminBuilder	setRpcTimeout(long timeout, TimeUnit unit) Set timeout for each rpc request.
AsyncAdminBuilder	setStartLogErrorsCnt(int startLogErrorsCnt) Set the number of retries that are allowed before we start to log.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.client.AsyncAdminBuilder

build, setMaxRetries, setRetryPauseForCQTBE

Field Detail

rpcTimeoutNs

protected long rpcTimeoutNs

operationTimeoutNs

protected long operationTimeoutNs

pauseNs

protected long pauseNs

pauseNsForServerOverloaded

protected long pauseNsForServerOverloaded

maxAttempts

protected int maxAttempts

startLogErrorsCnt

protected int startLogErrorsCnt

Constructor Detail

AsyncAdminBuilderBase

AsyncAdminBuilderBase(AsyncConnectionConfiguration connConf)

Method Detail

setOperationTimeout

public AsyncAdminBuilder setOperationTimeout(long timeout,
                                             TimeUnit unit)

Description copied from interface: AsyncAdminBuilder

Set timeout for a whole admin operation. Operation timeout and max attempt times(or max retry times) are both limitations for retrying, we will stop retrying when we reach any of the limitations.

Specified by:

setOperationTimeout in interface AsyncAdminBuilder

Returns:

this for invocation chaining

setRpcTimeout

public AsyncAdminBuilder setRpcTimeout(long timeout,
                                       TimeUnit unit)

Description copied from interface: AsyncAdminBuilder

Set timeout for each rpc request.

Specified by:

setRpcTimeout in interface AsyncAdminBuilder

Returns:

this for invocation chaining

setRetryPause

public AsyncAdminBuilder setRetryPause(long timeout,
                                       TimeUnit unit)

Description copied from interface: AsyncAdminBuilder

Set the base pause time for retrying. We use an exponential policy to generate sleep time when retrying.

Specified by:

setRetryPause in interface AsyncAdminBuilder

Returns:

this for invocation chaining

See Also:

AsyncAdminBuilder.setRetryPauseForServerOverloaded(long, TimeUnit)

setRetryPauseForServerOverloaded

public AsyncAdminBuilder setRetryPauseForServerOverloaded(long timeout,
                                                          TimeUnit unit)

Description copied from interface: AsyncAdminBuilder

Set the base pause time for retrying when HBaseServerException.isServerOverloaded(). We use an exponential policy to generate sleep time when retrying.

This value should be greater than the normal pause value which could be set with the above AsyncAdminBuilder.setRetryPause(long, TimeUnit) method, as usually HBaseServerException.isServerOverloaded() means the server is overloaded. We just use the normal pause value for HBaseServerException.isServerOverloaded() if here you specify a smaller value.

Specified by:

setRetryPauseForServerOverloaded in interface AsyncAdminBuilder

See Also:

AsyncAdminBuilder.setRetryPause(long, TimeUnit)

setMaxAttempts

public AsyncAdminBuilder setMaxAttempts(int maxAttempts)

Description copied from interface: AsyncAdminBuilder

Set the max attempt times for an admin operation. Usually it is the max retry times plus 1. Operation timeout and max attempt times(or max retry times) are both limitations for retrying, we will stop retrying when we reach any of the limitations.

Specified by:

setMaxAttempts in interface AsyncAdminBuilder

Returns:

this for invocation chaining

setStartLogErrorsCnt

public AsyncAdminBuilder setStartLogErrorsCnt(int startLogErrorsCnt)

Description copied from interface: AsyncAdminBuilder

Set the number of retries that are allowed before we start to log.

Specified by:

setStartLogErrorsCnt in interface AsyncAdminBuilder

Returns:

this for invocation chaining