org.apache.hadoop.hbase.quotas

Class GlobalQuotaSettings

java.lang.Object

org.apache.hadoop.hbase.quotas.QuotaSettings

org.apache.hadoop.hbase.quotas.GlobalQuotaSettings

Direct Known Subclasses:

GlobalQuotaSettingsImpl

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
 @InterfaceStability.Evolving
public abstract class GlobalQuotaSettings
extends QuotaSettings

An object which captures all quotas types (throttle or space) for a subject (user, table, or namespace). This is used inside of the HBase RegionServer to act as an analogy to the ProtocolBuffer class QuotaProtos.Quotas.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GlobalQuotaSettings(String userName, TableName tableName, String namespace, String regionServer)

Method Summary

Modifier and Type	Method and Description
abstract List<QuotaSettings>	getQuotaSettings() Computes a list of QuotaSettings that present the complete quota state of the combination of this user, table, and/or namespace.
QuotaType	getQuotaType()
protected void	setupSetQuotaRequest(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.SetQuotaRequest.Builder builder) Called by toSetQuotaRequestProto() the subclass should implement this method to set the specific SetQuotaRequest properties.

Methods inherited from class org.apache.hadoop.hbase.quotas.QuotaSettings

buildFromProto, buildSetQuotaRequestProto, getNamespace, getRegionServer, getTableName, getUserName, merge, ownerToString, sizeToString, timeToString, validateQuotaTarget

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalQuotaSettings

protected GlobalQuotaSettings(String userName,
                              TableName tableName,
                              String namespace,
                              String regionServer)

Method Detail

getQuotaSettings

public abstract List<QuotaSettings> getQuotaSettings()

Computes a list of QuotaSettings that present the complete quota state of the combination of this user, table, and/or namespace. Beware in calling this method repeatedly as the implementation of it may be costly.

getQuotaType

public QuotaType getQuotaType()

Specified by:

getQuotaType in class QuotaSettings

setupSetQuotaRequest

protected void setupSetQuotaRequest(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.SetQuotaRequest.Builder builder)

Description copied from class: QuotaSettings

Called by toSetQuotaRequestProto() the subclass should implement this method to set the specific SetQuotaRequest properties.

Specified by:

setupSetQuotaRequest in class QuotaSettings