BufferedMutatorParams (Apache HBase 2.5.0 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.

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`implementationClassName`
`private BufferedMutator.ExceptionListener`	`listener`
`private int`	`maxKeyValueSize`
`private int`	`operationTimeout`
`private ExecutorService`	`pool`
`private int`	`rpcTimeout`
`private TableName`	`tableName`
`(package private) static int`	`UNSET`
`private long`	`writeBufferPeriodicFlushTimeoutMs`
`private long`	`writeBufferPeriodicFlushTimerTickMs`
`private long`	`writeBufferSize`

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()` Returns Name of the class we will use when we construct a `BufferedMutator` instance or null if default implementation.
`BufferedMutator.ExceptionListener`	`getListener()`
`int`	`getMaxKeyValueSize()`
`int`	`getOperationTimeout()`
`ExecutorService`	`getPool()`
`int`	`getRpcTimeout()`
`TableName`	`getTableName()`
`long`	`getWriteBufferPeriodicFlushTimeoutMs()`
`long`	`getWriteBufferPeriodicFlushTimerTickMs()`
`long`	`getWriteBufferSize()`
`BufferedMutatorParams`	`implementationClassName(String implementationClassName)` Specify a BufferedMutator implementation other than the default.
`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)` Override the default executor pool defined by the `hbase.htable.threads.*` configuration values.
`BufferedMutatorParams`	`rpcTimeout(int rpcTimeout)`
`BufferedMutatorParams`	`setWriteBufferPeriodicFlushTimeoutMs(long timeoutMs)` Set the max timeout before the buffer is automatically flushed.
`BufferedMutatorParams`	`setWriteBufferPeriodicFlushTimerTickMs(long timerTickMs)` Set the TimerTick how often the buffer timeout if checked.
`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

Field Detail

UNSET
```
static final int UNSET
```
See Also:

Constant Field Values

tableName
```
private final TableName tableName
```

writeBufferSize
```
private long writeBufferSize
```

writeBufferPeriodicFlushTimeoutMs

private long writeBufferPeriodicFlushTimeoutMs

writeBufferPeriodicFlushTimerTickMs

private long writeBufferPeriodicFlushTimerTickMs

maxKeyValueSize
```
private int maxKeyValueSize
```

pool
```
private ExecutorService pool
```

implementationClassName
```
private String implementationClassName
```

rpcTimeout
```
private int rpcTimeout
```

operationTimeout
```
private int operationTimeout
```

listener

private BufferedMutator.ExceptionListener listener

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
```
public long getWriteBufferPeriodicFlushTimerTickMs()
```
- setWriteBufferPeriodicFlushTimerTickMs
```
public BufferedMutatorParams setWriteBufferPeriodicFlushTimerTickMs(long timerTickMs)
```
  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
```
public ExecutorService getPool()
```
- pool
```
public BufferedMutatorParams pool(ExecutorService pool)
```
  Override the default executor pool defined by the hbase.htable.threads.* configuration values.
- getImplementationClassName
```
public String getImplementationClassName()
```
  Returns Name of the class we will use when we construct a BufferedMutator instance or null if default implementation.
- implementationClassName
```
public BufferedMutatorParams implementationClassName(String implementationClassName)
```
  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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNSET

tableName

writeBufferSize

writeBufferPeriodicFlushTimeoutMs

writeBufferPeriodicFlushTimerTickMs

maxKeyValueSize

pool

implementationClassName

rpcTimeout

operationTimeout

listener

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