OffsetCriteria (Pinot Service Provider Interface 0.12.1 API)

java.lang.Object
- org.apache.pinot.spi.stream.OffsetCriteria

```
public class OffsetCriteria
extends Object
```
Defines and builds the offset criteria for consumption from a stream

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OffsetCriteria.OffsetCriteriaBuilder
Builds an OffsetCriteria

Field Summary

Fields
Modifier and Type Field Description

static OffsetCriteria LARGEST_OFFSET_CRITERIA

static OffsetCriteria SMALLEST_OFFSET_CRITERIA

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`String`	`getOffsetString()`	Getter for offset string
`int`	`hashCode()`
`boolean`	`isCustom()`	True if the offset criteria is defined as a custom format string
`boolean`	`isLargest()`	True if the offset criteria is defined to read from the largest known offset
`boolean`	`isPeriod()`	True if the offset criteria is defined as a period string
`boolean`	`isSmallest()`	True if the offset criteria is defined to read from smallest available offset
`boolean`	`isTimestamp()`	True if the offset criteria is defined as a timestamp string
`String`	`toString()`

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

- Field Detail
  - SMALLEST_OFFSET_CRITERIA
```
public static final OffsetCriteria SMALLEST_OFFSET_CRITERIA
```
  - LARGEST_OFFSET_CRITERIA
```
public static final OffsetCriteria LARGEST_OFFSET_CRITERIA
```
- Method Detail
  - isSmallest
```
public boolean isSmallest()
```
    True if the offset criteria is defined to read from smallest available offset
    
    Returns:
  - isLargest
```
public boolean isLargest()
```
    True if the offset criteria is defined to read from the largest known offset
    
    Returns:
  - isPeriod
```
public boolean isPeriod()
```
    True if the offset criteria is defined as a period string
    
    Returns:
  - isTimestamp
```
public boolean isTimestamp()
```
    True if the offset criteria is defined as a timestamp string
    
    Returns:
  - isCustom
```
public boolean isCustom()
```
    True if the offset criteria is defined as a custom format string
    
    Returns:
  - getOffsetString
```
public String getOffsetString()
```
    Getter for offset string
    
    Returns:
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object