RateLimitingGranularity (apiman-gateway-engine-policies 3.1.3.Final API)

java.lang.Object
- java.lang.Enum<RateLimitingGranularity>
- - io.apiman.gateway.engine.policies.config.rates.RateLimitingGranularity

All Implemented Interfaces:

Serializable, Comparable<RateLimitingGranularity>
```
public enum RateLimitingGranularity
extends Enum<RateLimitingGranularity>
```
The granularity to use when limiting rates.

Author:

eric.wittmann@redhat.com

Enum Constant Summary

Enum Constants
Enum Constant Description

Api

Client

Ip

User

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static RateLimitingGranularity`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static RateLimitingGranularity[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - User
```
public static final RateLimitingGranularity User
```
  - Api
```
public static final RateLimitingGranularity Api
```
  - Client
```
public static final RateLimitingGranularity Client
```
  - Ip
```
public static final RateLimitingGranularity Ip
```
- Method Detail
  - values
```
public static RateLimitingGranularity[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (RateLimitingGranularity c : RateLimitingGranularity.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RateLimitingGranularity valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null