org.apache.hadoop.hbase.quotas

Class QuotaRetriever

java.lang.Object

org.apache.hadoop.hbase.quotas.QuotaRetriever

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<QuotaSettings>

@InterfaceAudience.Public
public class QuotaRetriever
extends Object
implements Closeable, Iterable<QuotaSettings>

Scanner to iterate over the quota settings.

Constructor Summary

Constructors

Constructor and Description
QuotaRetriever(Connection conn)
QuotaRetriever(Connection conn, QuotaFilter filter)
QuotaRetriever(Connection conn, Scan scan)

Method Summary

Modifier and Type	Method and Description
void	close()
Iterator<QuotaSettings>	iterator()
QuotaSettings	next()
static QuotaRetriever	open(org.apache.hadoop.conf.Configuration conf) Deprecated. Since 3.0.0, will be removed in 4.0.0. Use QuotaRetriever(Configuration, Scan) instead.
static QuotaRetriever	open(org.apache.hadoop.conf.Configuration conf, QuotaFilter filter) Deprecated. Since 3.0.0, will be removed in 4.0.0. Use QuotaRetriever(Configuration, Scan) instead.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

QuotaRetriever

public QuotaRetriever(Connection conn)
               throws IOException

Throws:

IOException

QuotaRetriever

public QuotaRetriever(Connection conn,
                      QuotaFilter filter)
               throws IOException

Throws:

IOException

QuotaRetriever

public QuotaRetriever(Connection conn,
                      Scan scan)
               throws IOException

Throws:

IOException

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

next

public QuotaSettings next()
                   throws IOException

Throws:

IOException

iterator

public Iterator<QuotaSettings> iterator()

Specified by:

iterator in interface Iterable<QuotaSettings>

open

@Deprecated
public static QuotaRetriever open(org.apache.hadoop.conf.Configuration conf)
                                       throws IOException

Deprecated. Since 3.0.0, will be removed in 4.0.0. Use QuotaRetriever(Configuration, Scan) instead.

Open a QuotaRetriever with no filter, all the quota settings will be returned.

Parameters:

conf - Configuration object to use.

Returns:

the QuotaRetriever

Throws:

IOException - if a remote or network exception occurs

open

@Deprecated
public static QuotaRetriever open(org.apache.hadoop.conf.Configuration conf,
                                              QuotaFilter filter)
                                       throws IOException

Deprecated. Since 3.0.0, will be removed in 4.0.0. Use QuotaRetriever(Configuration, Scan) instead.

Open a QuotaRetriever with the specified filter.

Parameters:

conf - Configuration object to use.

filter - the QuotaFilter

Returns:

the QuotaRetriever

Throws:

IOException - if a remote or network exception occurs