PartitionLagState (Pinot Service Provider Interface 0.12.1 API)

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

Direct Known Subclasses:

StreamMetadataProvider.UnknownLagState
```
public class PartitionLagState
extends Object
```
Container that can be used for holding per-partition consumer lag calculated along standard dimensions such as record offset, ingestion time etc.

Field Summary

Fields
Modifier and Type Field Description

static String NOT_CALCULATED

Constructor Summary

Constructors
Constructor Description

PartitionLagState()

Method Summary

Modifier and Type	Method	Description
`String`	`getAvailabilityLagMs()`	Defines how soon after record ingestion was the record consumed by Pinot.
`String`	`getRecordsLag()`	Defines how far behind the current record's offset / pointer is from upstream latest record The distance is based on actual record count.

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

- Field Detail
  - NOT_CALCULATED
```
public static final String NOT_CALCULATED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PartitionLagState
```
public PartitionLagState()
```
- Method Detail
  - getRecordsLag
```
public String getRecordsLag()
```
    Defines how far behind the current record's offset / pointer is from upstream latest record The distance is based on actual record count.
  - getAvailabilityLagMs
```
public String getAvailabilityLagMs()
```
    Defines how soon after record ingestion was the record consumed by Pinot. That is, the difference between the time the record was consumed and the time at which the record was ingested upstream.
    
    Returns:
    
    Lag value in milliseconds