A case class that contains decoded stream record data and related metadata.
case class PayloadWithMetadata[V]( topicName: String = "", partitionId: Short = -1, createTimeMs: Long = -1, createTimeNano: Long = -1, recordKey: Long = -1, payload: V = null.asInstanceOf[V])
PayloadWithMetadata[V]( topicName: String, partitionId: Short, createTimeMs: Long, createTimeNano: Long, recordKey: Long1, payload: V)
Parameters and Data Members
The name of the stream that contains the record.
- Type: String
The ID of the stream shard that contains the record (see Stream Sharding and Partitioning).
The record's ingestion time (the time at which the record arrived at the platform), as a Unix timestamp in milliseconds. For example,
1511260205000indicates that the record was ingested on 21 Nov 2017 at 10:30:05 AM. The
createTimeNanoparameter holds the nanoseconds unit of the ingestion time.
The nanoseconds unit of the
createTimeMsingestion-time timestamp. For example, if createTimeMsis
500000000, the record was ingested on 21 Nov 2017 at 10:30 AM and 5.5 seconds.
The record's sequence number (see Stream Record Consumption).
Decoded record data, formatted as the value type of the current class instance (
V —the data type into which to convert the record's data payload ("value").