org.apache.hadoop.hbase.quotas

Class QuotaSettingsFactory

java.lang.Object

org.apache.hadoop.hbase.quotas.QuotaSettingsFactory

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class QuotaSettingsFactory
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static QuotaSettings	bypassGlobals(String userName, boolean bypassGlobals) Set the "bypass global settings" for the specified user
static QuotaSettings	throttleNamespace(String namespace, ThrottleType type, long limit, TimeUnit timeUnit) Throttle the specified namespace.
static QuotaSettings	throttleTable(TableName tableName, ThrottleType type, long limit, TimeUnit timeUnit) Throttle the specified table.
static QuotaSettings	throttleUser(String userName, String namespace, ThrottleType type, long limit, TimeUnit timeUnit) Throttle the specified user on the specified namespace.
static QuotaSettings	throttleUser(String userName, TableName tableName, ThrottleType type, long limit, TimeUnit timeUnit) Throttle the specified user on the specified table.
static QuotaSettings	throttleUser(String userName, ThrottleType type, long limit, TimeUnit timeUnit) Throttle the specified user.
static QuotaSettings	unthrottleNamespace(String namespace) Remove the throttling for the specified namespace.
static QuotaSettings	unthrottleTable(TableName tableName) Remove the throttling for the specified table.
static QuotaSettings	unthrottleUser(String userName) Remove the throttling for the specified user.
static QuotaSettings	unthrottleUser(String userName, String namespace) Remove the throttling for the specified user on the specified namespace.
static QuotaSettings	unthrottleUser(String userName, TableName tableName) Remove the throttling for the specified user on the specified table.

Methods inherited from class java.lang.Object

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

Method Detail

throttleUser

public static QuotaSettings throttleUser(String userName,
                         ThrottleType type,
                         long limit,
                         TimeUnit timeUnit)

Throttle the specified user.

Parameters:

userName - the user to throttle

type - the type of throttling

limit - the allowed number of request/data per timeUnit

timeUnit - the limit time unit

Returns:

the quota settings

throttleUser

public static QuotaSettings throttleUser(String userName,
                         TableName tableName,
                         ThrottleType type,
                         long limit,
                         TimeUnit timeUnit)

Throttle the specified user on the specified table.

Parameters:

userName - the user to throttle

tableName - the table to throttle

type - the type of throttling

limit - the allowed number of request/data per timeUnit

timeUnit - the limit time unit

Returns:

the quota settings

throttleUser

public static QuotaSettings throttleUser(String userName,
                         String namespace,
                         ThrottleType type,
                         long limit,
                         TimeUnit timeUnit)

Throttle the specified user on the specified namespace.

Parameters:

userName - the user to throttle

namespace - the namespace to throttle

type - the type of throttling

limit - the allowed number of request/data per timeUnit

timeUnit - the limit time unit

Returns:

the quota settings

unthrottleUser

public static QuotaSettings unthrottleUser(String userName)

Remove the throttling for the specified user.

Parameters:

userName - the user

Returns:

the quota settings

unthrottleUser

public static QuotaSettings unthrottleUser(String userName,
                           TableName tableName)

Remove the throttling for the specified user on the specified table.

Parameters:

userName - the user

tableName - the table

Returns:

the quota settings

unthrottleUser

public static QuotaSettings unthrottleUser(String userName,
                           String namespace)

Remove the throttling for the specified user on the specified namespace.

Parameters:

userName - the user

namespace - the namespace

Returns:

the quota settings

throttleTable

public static QuotaSettings throttleTable(TableName tableName,
                          ThrottleType type,
                          long limit,
                          TimeUnit timeUnit)

Throttle the specified table.

Parameters:

tableName - the table to throttle

type - the type of throttling

limit - the allowed number of request/data per timeUnit

timeUnit - the limit time unit

Returns:

the quota settings

unthrottleTable

public static QuotaSettings unthrottleTable(TableName tableName)

Remove the throttling for the specified table.

Parameters:

tableName - the table

Returns:

the quota settings

throttleNamespace

public static QuotaSettings throttleNamespace(String namespace,
                              ThrottleType type,
                              long limit,
                              TimeUnit timeUnit)

Throttle the specified namespace.

Parameters:

namespace - the namespace to throttle

type - the type of throttling

limit - the allowed number of request/data per timeUnit

timeUnit - the limit time unit

Returns:

the quota settings

unthrottleNamespace

public static QuotaSettings unthrottleNamespace(String namespace)

Remove the throttling for the specified namespace.

Parameters:

namespace - the namespace

Returns:

the quota settings

bypassGlobals

public static QuotaSettings bypassGlobals(String userName,
                          boolean bypassGlobals)

Set the "bypass global settings" for the specified user

Parameters:

userName - the user to throttle

bypassGlobals - true if the global settings should be bypassed

Returns:

the quota settings