BufferedMutatorParams (Apache HBase - Client 3.0.0-beta-1 API)

java.lang.Object
- org.apache.hadoop.hbase.client.BufferedMutatorParams

All Implemented Interfaces:: Cloneable

@InterfaceAudience.Public
public class BufferedMutatorParams
extends Object
implements Cloneable

Parameters for instantiating a BufferedMutator.

Constructor Summary

Constructors
Constructor and Description

BufferedMutatorParams(TableName tableName)

Constructors
Constructor and Description
`BufferedMutatorParams(TableName tableName)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BufferedMutatorParams`	`clone()`
`String`	`getImplementationClassName()` Deprecated. Since 3.0.0, will be removed in 4.0.0. You can not set it any more as the implementation has to use too many internal stuffs in HBase.
`BufferedMutator.ExceptionListener`	`getListener()`
`int`	`getMaxKeyValueSize()`
`int`	`getOperationTimeout()`
`ExecutorService`	`getPool()` Deprecated. Since 3.0.0-alpha-2, will be removed in 4.0.0. You can not set it anymore. BufferedMutator will use Connection's ExecutorService.
`int`	`getRpcTimeout()`
`TableName`	`getTableName()`
`long`	`getWriteBufferPeriodicFlushTimeoutMs()`
`long`	`getWriteBufferPeriodicFlushTimerTickMs()` Deprecated. Since 3.0.0, will be removed in 4.0.0. We use a common timer in the whole client implementation so you can not set it any more.
`long`	`getWriteBufferSize()`
`BufferedMutatorParams`	`implementationClassName(String implementationClassName)` Deprecated. Since 3.0.0, will be removed in 4.0.0. You can not set it any more as the implementation has to use too many internal stuffs in HBase.
`BufferedMutatorParams`	`listener(BufferedMutator.ExceptionListener listener)` Override the default error handler.
`BufferedMutatorParams`	`maxKeyValueSize(int maxKeyValueSize)` Override the maximum key-value size specified by the provided `Connection`'s `Configuration` instance, via the configuration key `hbase.client.keyvalue.maxsize`.
`BufferedMutatorParams`	`operationTimeout(int operationTimeout)`
`BufferedMutatorParams`	`opertationTimeout(int operationTimeout)` Deprecated. Since 2.3.0, will be removed in 4.0.0. Use `operationTimeout(int)`
`BufferedMutatorParams`	`pool(ExecutorService pool)` Deprecated. Since 3.0.0-alpha-2, will be removed in 4.0.0. You can not set it anymore. BufferedMutator will use Connection's ExecutorService.
`BufferedMutatorParams`	`rpcTimeout(int rpcTimeout)`
`BufferedMutatorParams`	`setWriteBufferPeriodicFlushTimeoutMs(long timeoutMs)` Set the max timeout before the buffer is automatically flushed.
`BufferedMutatorParams`	`setWriteBufferPeriodicFlushTimerTickMs(long timerTickMs)` Deprecated. Since 3.0.0, will be removed in 4.0.0. We use a common timer in the whole client implementation so you can not set it any more.
`BufferedMutatorParams`	`writeBufferSize(long writeBufferSize)` Override the write buffer size specified by the provided `Connection`'s `Configuration` instance, via the configuration key `hbase.client.write.buffer`.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BufferedMutatorParams
```
public BufferedMutatorParams(TableName tableName)
```
- Method Detail
  - getTableName
```
public TableName getTableName()
```
  - getWriteBufferSize
```
public long getWriteBufferSize()
```
  - rpcTimeout
```
public BufferedMutatorParams rpcTimeout(int rpcTimeout)
```
  - getRpcTimeout
```
public int getRpcTimeout()
```
  - operationTimeout
```
public BufferedMutatorParams operationTimeout(int operationTimeout)
```
  - opertationTimeout
```
@Deprecated
public BufferedMutatorParams opertationTimeout(int operationTimeout)
```
    Deprecated. Since 2.3.0, will be removed in 4.0.0. Use operationTimeout(int)
  - getOperationTimeout
```
public int getOperationTimeout()
```
  - writeBufferSize
```
public BufferedMutatorParams writeBufferSize(long writeBufferSize)
```
    Override the write buffer size specified by the provided Connection's Configuration instance, via the configuration key hbase.client.write.buffer.
  - getWriteBufferPeriodicFlushTimeoutMs
```
public long getWriteBufferPeriodicFlushTimeoutMs()
```
  - setWriteBufferPeriodicFlushTimeoutMs
```
public BufferedMutatorParams setWriteBufferPeriodicFlushTimeoutMs(long timeoutMs)
```
    Set the max timeout before the buffer is automatically flushed.
  - getWriteBufferPeriodicFlushTimerTickMs
```
@Deprecated
public long getWriteBufferPeriodicFlushTimerTickMs()
```
    Deprecated. Since 3.0.0, will be removed in 4.0.0. We use a common timer in the whole client implementation so you can not set it any more.
  - setWriteBufferPeriodicFlushTimerTickMs
```
@Deprecated
public BufferedMutatorParams setWriteBufferPeriodicFlushTimerTickMs(long timerTickMs)
```
    Deprecated. Since 3.0.0, will be removed in 4.0.0. We use a common timer in the whole client implementation so you can not set it any more.
    
    Set the TimerTick how often the buffer timeout if checked.
  - getMaxKeyValueSize
```
public int getMaxKeyValueSize()
```
  - maxKeyValueSize
```
public BufferedMutatorParams maxKeyValueSize(int maxKeyValueSize)
```
    Override the maximum key-value size specified by the provided Connection's Configuration instance, via the configuration key hbase.client.keyvalue.maxsize.
  - getPool
```
@Deprecated
public ExecutorService getPool()
```
    Deprecated. Since 3.0.0-alpha-2, will be removed in 4.0.0. You can not set it anymore. BufferedMutator will use Connection's ExecutorService.
  - pool
```
@Deprecated
public BufferedMutatorParams pool(ExecutorService pool)
```
    Deprecated. Since 3.0.0-alpha-2, will be removed in 4.0.0. You can not set it anymore. BufferedMutator will use Connection's ExecutorService.
    
    Override the default executor pool defined by the hbase.htable.threads.* configuration values.
  - getImplementationClassName
```
@Deprecated
public String getImplementationClassName()
```
    Deprecated. Since 3.0.0, will be removed in 4.0.0. You can not set it any more as the implementation has to use too many internal stuffs in HBase.
    
    Returns:
    
    Name of the class we will use when we construct a BufferedMutator instance or null if default implementation.
  - implementationClassName
```
@Deprecated
public BufferedMutatorParams implementationClassName(String implementationClassName)
```
    Deprecated. Since 3.0.0, will be removed in 4.0.0. You can not set it any more as the implementation has to use too many internal stuffs in HBase.
    
    Specify a BufferedMutator implementation other than the default.
    
    Parameters:
    
    implementationClassName - Name of the BufferedMutator implementation class
  - getListener
```
public BufferedMutator.ExceptionListener getListener()
```
  - listener
```
public BufferedMutatorParams listener(BufferedMutator.ExceptionListener listener)
```
    Override the default error handler. Default handler simply rethrows the exception.
  - clone
```
public BufferedMutatorParams clone()
```
    Overrides:
    
    clone in class Object

Class BufferedMutatorParams

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BufferedMutatorParams

Method Detail

getTableName

getWriteBufferSize

rpcTimeout

getRpcTimeout

operationTimeout

opertationTimeout

getOperationTimeout

writeBufferSize

getWriteBufferPeriodicFlushTimeoutMs

setWriteBufferPeriodicFlushTimeoutMs

getWriteBufferPeriodicFlushTimerTickMs

setWriteBufferPeriodicFlushTimerTickMs

getMaxKeyValueSize

maxKeyValueSize

getPool

pool

getImplementationClassName

implementationClassName

getListener

listener

clone