AsyncAdminBuilder (Apache HBase 2.5.0 API)

All Known Implementing Classes:

AsyncAdminBuilderBase
```
@InterfaceAudience.Public
public interface AsyncAdminBuilder
```
For creating AsyncAdmin. The implementation should have default configurations set before returning the builder to user. So users are free to only set the configs they care about to create a new AsyncAdmin instance.

Since:

2.0.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`AsyncAdmin`	`build()` Create a `AsyncAdmin` instance.
`AsyncAdminBuilder`	`setMaxAttempts(int maxAttempts)` Set the max attempt times for an admin operation.
`default AsyncAdminBuilder`	`setMaxRetries(int maxRetries)` Set the max retry 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.
`default AsyncAdminBuilder`	`setRetryPauseForCQTBE(long pause, TimeUnit unit)` Deprecated. Since 2.5.0, will be removed in 4.0.0. Please use `setRetryPauseForServerOverloaded(long, TimeUnit)` instead.
`AsyncAdminBuilder`	`setRetryPauseForServerOverloaded(long pause, 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.

- Method Detail
  - setOperationTimeout
```
AsyncAdminBuilder setOperationTimeout(long timeout,
                                      TimeUnit unit)
```
    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.
    
    Returns:
    
    this for invocation chaining
  - setRpcTimeout
```
AsyncAdminBuilder setRpcTimeout(long timeout,
                                TimeUnit unit)
```
    Set timeout for each rpc request.
    
    Returns:
    
    this for invocation chaining
  - setRetryPause
```
AsyncAdminBuilder setRetryPause(long timeout,
                                TimeUnit unit)
```
    Set the base pause time for retrying. We use an exponential policy to generate sleep time when retrying.
    
    Returns:
    
    this for invocation chaining
    
    See Also:
    
    setRetryPauseForServerOverloaded(long, TimeUnit)
  - setRetryPauseForCQTBE
```
@Deprecated
default AsyncAdminBuilder setRetryPauseForCQTBE(long pause,
                                                            TimeUnit unit)
```
    Deprecated. Since 2.5.0, will be removed in 4.0.0. Please use setRetryPauseForServerOverloaded(long, TimeUnit) instead.
    
    Set the base pause time for retrying when HBaseServerException.isServerOverloaded(). We use an exponential policy to generate sleep time from this base when retrying.
    This value should be greater than the normal pause value which could be set with the above 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.
    
    See Also:
    
    setRetryPause(long, TimeUnit)
  - setRetryPauseForServerOverloaded
```
AsyncAdminBuilder setRetryPauseForServerOverloaded(long pause,
                                                   TimeUnit unit)
```
    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 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.
    
    See Also:
    
    setRetryPause(long, TimeUnit)
  - setMaxRetries
```
default AsyncAdminBuilder setMaxRetries(int maxRetries)
```
    Set the max retry times for an admin operation. Usually it is the max attempt times minus 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.
    
    Returns:
    
    this for invocation chaining
  - setMaxAttempts
```
AsyncAdminBuilder setMaxAttempts(int maxAttempts)
```
    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.
    
    Returns:
    
    this for invocation chaining
  - setStartLogErrorsCnt
```
AsyncAdminBuilder setStartLogErrorsCnt(int startLogErrorsCnt)
```
    Set the number of retries that are allowed before we start to log.
    
    Returns:
    
    this for invocation chaining
  - build
```
AsyncAdmin build()
```
    Create a AsyncAdmin instance.
    
    Returns:
    
    a AsyncAdmin instance

Interface AsyncAdminBuilder

Method Summary

Method Detail

setOperationTimeout

setRpcTimeout

setRetryPause

setRetryPauseForCQTBE

setRetryPauseForServerOverloaded

setMaxRetries

setMaxAttempts

setStartLogErrorsCnt

build