FieldSpec.FieldType (Pinot Service Provider Interface 0.12.1 API)

java.lang.Object
- java.lang.Enum<FieldSpec.FieldType>
- - org.apache.pinot.spi.data.FieldSpec.FieldType

All Implemented Interfaces:

Serializable, Comparable<FieldSpec.FieldType>, java.lang.constant.Constable

Enclosing class:

FieldSpec
```
public static enum FieldSpec.FieldType
extends Enum<FieldSpec.FieldType>
```
The FieldType enum is used to demonstrate the real world business logic for a column.
DIMENSION: columns used to filter records.
METRIC: columns used to apply aggregation on. METRIC field only contains numeric data.
TIME: time column (at most one per Schema). TIME field can be used to prune
DATE_TIME: time column (at most one per Schema). TIME field can be used to prune segments, otherwise treated the same as DIMENSION field.

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

COMPLEX

DATE_TIME

DIMENSION

METRIC

TIME

Method Summary

Modifier and Type	Method	Description
`static FieldSpec.FieldType`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static FieldSpec.FieldType[]`	`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
  - DIMENSION
```
public static final FieldSpec.FieldType DIMENSION
```
  - METRIC
```
public static final FieldSpec.FieldType METRIC
```
  - TIME
```
public static final FieldSpec.FieldType TIME
```
  - DATE_TIME
```
public static final FieldSpec.FieldType DATE_TIME
```
  - COMPLEX
```
public static final FieldSpec.FieldType COMPLEX
```
- Method Detail
  - values
```
public static FieldSpec.FieldType[] 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 FieldSpec.FieldType 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