DefaultOperationQuota (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.quotas.DefaultOperationQuota

All Implemented Interfaces:: OperationQuota

@InterfaceAudience.Private
@InterfaceStability.Evolving
public class DefaultOperationQuota
extends Object
implements OperationQuota

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.quotas.OperationQuota
  OperationQuota.OperationType

Field Summary

Fields
Modifier and Type	Field and Description
`private List<QuotaLimiter>`	`limiters`
`private static org.apache.commons.logging.Log`	`LOG`
`private long[]`	`operationSize`
`private long`	`readAvailable`
`private long`	`readConsumed`
`private long`	`writeAvailable`
`private long`	`writeConsumed`

Constructor Summary

Constructors
Constructor and Description

DefaultOperationQuota(List<QuotaLimiter> limiters)
NOTE: The order matters.

DefaultOperationQuota(QuotaLimiter... limiters)

Constructors
Constructor and Description
`DefaultOperationQuota(List<QuotaLimiter> limiters)` NOTE: The order matters.
`DefaultOperationQuota(QuotaLimiter... limiters)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addGetResult(Result result)` Add a get result.
`void`	`addMutation(Mutation mutation)` Add a mutation result.
`void`	`addScanResult(List<Result> results)` Add a scan result.
`void`	`checkQuota(int numWrites, int numReads, int numScans)` Checks if it is possible to execute the specified operation.
`void`	`close()` Cleanup method on operation completion
`private long`	`estimateConsume(OperationQuota.OperationType type, int numReqs, long avgSize)`
`long`	`getReadAvailable()`
`long`	`getWriteAvailable()`

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

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - limiters
```
private final List<QuotaLimiter> limiters
```
  - writeAvailable
```
private long writeAvailable
```
  - readAvailable
```
private long readAvailable
```
  - writeConsumed
```
private long writeConsumed
```
  - readConsumed
```
private long readConsumed
```
  - operationSize
```
private final long[] operationSize
```
- Constructor Detail
  - DefaultOperationQuota
```
public DefaultOperationQuota(QuotaLimiter... limiters)
```
  - DefaultOperationQuota
```
public DefaultOperationQuota(List<QuotaLimiter> limiters)
```
    NOTE: The order matters. It should be something like [user, table, namespace, global]
- Method Detail
  - checkQuota
```
public void checkQuota(int numWrites,
              int numReads,
              int numScans)
                throws ThrottlingException
```
    Description copied from interface: OperationQuota
    
    Checks if it is possible to execute the specified operation. The quota will be estimated based on the number of operations to perform and the average size accumulated during time.
    
    Specified by:
    
    checkQuota in interface OperationQuota
    
    Parameters:
    numWrites - number of write operation that will be performed
    numReads - number of small-read operation that will be performed
    numScans - number of long-read operation that will be performed
    
    Throws:
    
    ThrottlingException - if the operation cannot be performed
  - close
```
public void close()
```
    Description copied from interface: OperationQuota
    
    Cleanup method on operation completion
    
    Specified by:
    
    close in interface OperationQuota
  - getReadAvailable
```
public long getReadAvailable()
```
    Specified by:
    
    getReadAvailable in interface OperationQuota
    
    Returns:
    the number of bytes available to read to avoid exceeding the quota
  - getWriteAvailable
```
public long getWriteAvailable()
```
    Specified by:
    
    getWriteAvailable in interface OperationQuota
    
    Returns:
    the number of bytes available to write to avoid exceeding the quota
  - addGetResult
```
public void addGetResult(Result result)
```
    Description copied from interface: OperationQuota
    
    Add a get result. This will be used to calculate the exact quota and have a better short-read average size for the next time.
    
    Specified by:
    
    addGetResult in interface OperationQuota
  - addScanResult
```
public void addScanResult(List<Result> results)
```
    Description copied from interface: OperationQuota
    
    Add a scan result. This will be used to calculate the exact quota and have a better long-read average size for the next time.
    
    Specified by:
    
    addScanResult in interface OperationQuota
  - addMutation
```
public void addMutation(Mutation mutation)
```
    Description copied from interface: OperationQuota
    
    Add a mutation result. This will be used to calculate the exact quota and have a better mutation average size for the next time.
    
    Specified by:
    
    addMutation in interface OperationQuota
  - estimateConsume
```
private long estimateConsume(OperationQuota.OperationType type,
                   int numReqs,
                   long avgSize)
```

Class DefaultOperationQuota

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.quotas.OperationQuota

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

limiters

writeAvailable

readAvailable

writeConsumed

readConsumed

operationSize

Constructor Detail

DefaultOperationQuota

DefaultOperationQuota

Method Detail

checkQuota

close

getReadAvailable

getWriteAvailable

addGetResult

addScanResult

addMutation

estimateConsume