CommonConstants.ConsumerState (Pinot Service Provider Interface 0.12.1 API)

java.lang.Object
- java.lang.Enum<CommonConstants.ConsumerState>
- - org.apache.pinot.spi.utils.CommonConstants.ConsumerState

All Implemented Interfaces:

Serializable, Comparable<CommonConstants.ConsumerState>, java.lang.constant.Constable

Enclosing class:

CommonConstants
```
public static enum CommonConstants.ConsumerState
extends Enum<CommonConstants.ConsumerState>
```
The state of the consumer for a given segment

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Enum
  Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants
Enum Constant Description

CONSUMING

NOT_CONSUMING

Method Summary

Modifier and Type	Method	Description
`static CommonConstants.ConsumerState`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static CommonConstants.ConsumerState[]`	`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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - CONSUMING
```
public static final CommonConstants.ConsumerState CONSUMING
```
  - NOT_CONSUMING
```
public static final CommonConstants.ConsumerState NOT_CONSUMING
```
- Method Detail
  - values
```
public static CommonConstants.ConsumerState[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared.
    
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CommonConstants.ConsumerState 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