View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional information regarding
4    * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
5    * "License"); you may not use this file except in compliance with the License. You may obtain a
6    * copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable
7    * law or agreed to in writing, software distributed under the License is distributed on an "AS IS"
8    * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
9    * for the specific language governing permissions and limitations under the License.
10   */
11  package org.apache.hadoop.hbase.quotas;
12  
13  import org.apache.hadoop.hbase.classification.InterfaceAudience;
14  import org.apache.hadoop.hbase.classification.InterfaceStability;
15  
16  /**
17   * Describe the Scope of the quota rules. The quota can be enforced at the cluster level or at
18   * machine level.
19   */
20  @InterfaceAudience.Public
21  @InterfaceStability.Evolving
22  public enum QuotaScope {
23    /**
24     * The specified throttling rules will be applied at the cluster level. A limit of 100req/min
25     * means 100req/min in total. If you execute 50req on a machine and then 50req on another machine
26     * then you have to wait your quota to fill up.
27     */
28    CLUSTER,
29  
30    /**
31     * The specified throttling rules will be applied on the machine level. A limit of 100req/min
32     * means that each machine can execute 100req/min.
33     */
34    MACHINE,
35  }