Package org.apache.spark.sql.connector.read.streaming

Class SupportsRealTimeRead.RecordStatus

Object

org.apache.spark.sql.connector.read.streaming.SupportsRealTimeRead.RecordStatus

Enclosing interface:

SupportsRealTimeRead<T>

public static class SupportsRealTimeRead.RecordStatus
extends Object

A class to represent the status of a record to be read as the return type of nextWithTimeout. It contains whether the next record is available and the ingestion time of the record if the source connector provided relevant info. A list of source connector that has ingestion time is listed below: - Kafka when the record timestamp type is LogAppendTime - Kinesis has ApproximateArrivalTimestamp

Method Summary

Modifier and Type	Method	Description
boolean	hasRecord()
static SupportsRealTimeRead.RecordStatus	newStatusWithArrivalTimeMs(Long recArrivalTime)
static SupportsRealTimeRead.RecordStatus	newStatusWithoutArrivalTime(boolean hasRecord)
Optional<Long>	recArrivalTime()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

newStatusWithoutArrivalTime

public static SupportsRealTimeRead.RecordStatus newStatusWithoutArrivalTime(boolean hasRecord)

newStatusWithArrivalTimeMs

public static SupportsRealTimeRead.RecordStatus newStatusWithArrivalTimeMs(Long recArrivalTime)

hasRecord

public boolean hasRecord()

recArrivalTime

public Optional<Long> recArrivalTime()