Package org.apache.hadoop.hbase.quotas

Class ThrottleSettings

java.lang.Object

org.apache.hadoop.hbase.quotas.QuotaSettings

org.apache.hadoop.hbase.quotas.ThrottleSettings

@Private
@Evolving
public class ThrottleSettings
extends QuotaSettings

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.ThrottleRequest	proto

Constructor Summary

Constructors

Constructor	Description
ThrottleSettings(String userName, TableName tableName, String namespace, String regionServer, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.ThrottleRequest proto)

Method Summary

Modifier and Type	Method	Description
(package private) static ThrottleSettings	fromTimedQuota(String userName, TableName tableName, String namespace, String regionServer, ThrottleType type, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota timedQuota)
(package private) org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.ThrottleRequest	getProto()	Returns a copy of the internal state of this
QuotaScope	getQuotaScope()
QuotaType	getQuotaType()
long	getSoftLimit()
ThrottleType	getThrottleType()
TimeUnit	getTimeUnit()
protected ThrottleSettings	merge(QuotaSettings other)	Merges the provided settings with this and returns a new settings object to the caller if the merged settings differ from the original.
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.
String	toString()
private void	validateTimedQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota timedQuota)

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

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

Methods inherited from class java.lang.Object

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

Field Details

proto

final org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.ThrottleRequest proto

Constructor Details

ThrottleSettings

ThrottleSettings(String userName,
 TableName tableName,
 String namespace,
 String regionServer,
 org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.ThrottleRequest proto)

Method Details

getThrottleType

public ThrottleType getThrottleType()

getSoftLimit

public long getSoftLimit()

getProto

org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.ThrottleRequest getProto()

Returns a copy of the internal state of this

getTimeUnit

public TimeUnit getTimeUnit()

getQuotaScope

public QuotaScope getQuotaScope()

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

toString

public String toString()

Overrides:

toString in class Object

merge

protected ThrottleSettings merge(QuotaSettings other)
                          throws IOException

Description copied from class: QuotaSettings

Merges the provided settings with this and returns a new settings object to the caller if the merged settings differ from the original.

Specified by:

merge in class QuotaSettings

Parameters:

other - The new settings to merge in.

Returns:

The merged QuotaSettings object or null if the quota should be deleted.

Throws:

IOException

validateTimedQuota

private void validateTimedQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota timedQuota)
                         throws IOException

Throws:

IOException

fromTimedQuota

static ThrottleSettings fromTimedQuota(String userName,
 TableName tableName,
 String namespace,
 String regionServer,
 ThrottleType type,
 org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota timedQuota)