FinatraTransformer

A KafkaStreams Transformer offering an upgraded API over the built in Transformer interface.

This Transformer differs from the built in Transformer interface by exposing an [onMessage] interface that is used to process incoming messages. Within [onMessage] you may use the [forward] method to emit 0 or more records.

This transformer also manages watermarks(see [WatermarkManager]), and extends [OnWatermark] which allows you to track the passage of event time.

InputKey: Type of the input keys
InputValue: Type of the input values
OutputKey: Type of the output keys
OutputValue: Type of the output values

Annotations: @Beta()

Linear Supertypes

ProcessorContextLogging, OnFlush, OnClose, OnWatermark, OnInit, Transformer[InputKey, InputValue, (OutputKey, OutputValue)], AnyRef, Any

Known Subclasses

AggregatorTransformer, CachingKeyValueStores, ReservoirSamplingTransformer

Instance Constructors

new FinatraTransformer(statsReceiver: StatsReceiver, watermarkAssignor: WatermarkAssignor[InputKey, InputValue] = ...)

Type Members

implicit class RichLong extends AnyRef

Definition Classes
ProcessorContextLogging

Abstract Value Members

abstract def onMessage(messageTime: Time, key: InputKey, value: InputValue): Unit

Callback method which is called for every message in the stream this Transformer is attached to.
Callback method which is called for every message in the stream this Transformer is attached to. Implementers of this method may emit 0 or more records by using the processorContext.
messageTime
the time of the message
key
the key of the message
value
the value of the message

Attributes
protected[com.twitter.finatra]

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def close(): Unit

Definition Classes
FinatraTransformer → Transformer
final def debug(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
ProcessorContextLogging
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def error(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
ProcessorContextLogging
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val finatraKeyValueStoresMap: Map[StoreName, FinatraKeyValueStore[_, _]]

Attributes
protected[com.twitter.finatra.kafkastreams]
final def forward(key: OutputKey, value: OutputValue, timestamp: Long): Unit

Attributes
protected
final def forward(key: OutputKey, value: OutputValue): Unit

Attributes
protected
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getKeyValueStore[KK, VV](name: String)(implicit arg0: ClassTag[KK]): FinatraKeyValueStore[KK, VV]

Get the state store given the store name.
Get the state store given the store name.
KK
Key type of the state store
VV
Value type of the state store
name
The store name
returns
The state store instance

Attributes
protected
def hashCode(): Int

Definition Classes
AnyRef → Any
final def info(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
ProcessorContextLogging
final def init(processorContext: ProcessorContext): Unit

Definition Classes
FinatraTransformer → Transformer
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def onClose(): Unit

Attributes
protected
Definition Classes
OnClose
def onFlush(): Unit

Callback method for when you should flush any cached data.
Callback method for when you should flush any cached data. This method is typically called prior to a Kafka commit

Definition Classes
FinatraTransformer → OnFlush
def onInit(): Unit

Attributes
protected
Definition Classes
OnInit
def onWatermark(watermark: Watermark): Unit

Definition Classes
FinatraTransformer → OnWatermark
def processorContext: ProcessorContext

Attributes
protected
Definition Classes
FinatraTransformer → ProcessorContextLogging
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def taskIdStr: String

Attributes
protected
Definition Classes
ProcessorContextLogging
final def timeStr: String

Attributes
protected
Definition Classes
ProcessorContextLogging
def toString(): String

Definition Classes
AnyRef → Any
final def trace(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
ProcessorContextLogging
final def transform(k: InputKey, v: InputValue): (OutputKey, OutputValue)

Definition Classes
FinatraTransformer → Transformer
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def warn(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
ProcessorContextLogging
final def watermark: Watermark

Attributes
protected[com.twitter.finatra]

Related Docs: object FinatraTransformer | package transformer

abstract class FinatraTransformer[InputKey, InputValue, OutputKey, OutputValue] extends Transformer[InputKey, InputValue, (OutputKey, OutputValue)] with OnInit with OnWatermark with OnClose with OnFlush with ProcessorContextLogging

Instance Constructors

new FinatraTransformer(statsReceiver: StatsReceiver, watermarkAssignor: WatermarkAssignor[InputKey, InputValue] = ...)

Type Members

implicit class RichLong extends AnyRef

Abstract Value Members

abstract def onMessage(messageTime: Time, key: InputKey, value: InputValue): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def close(): Unit

final def debug(message: ⇒ Any): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def error(message: ⇒ Any): Unit

def finalize(): Unit

val finatraKeyValueStoresMap: Map[StoreName, FinatraKeyValueStore[_, _]]

final def forward(key: OutputKey, value: OutputValue, timestamp: Long): Unit

final def forward(key: OutputKey, value: OutputValue): Unit

final def getClass(): Class[_]

final def getKeyValueStore[KK, VV](name: String)(implicit arg0: ClassTag[KK]): FinatraKeyValueStore[KK, VV]

def hashCode(): Int

final def info(message: ⇒ Any): Unit

final def init(processorContext: ProcessorContext): Unit

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def onClose(): Unit

def onFlush(): Unit

def onInit(): Unit

def onWatermark(watermark: Watermark): Unit

def processorContext: ProcessorContext

final def synchronized[T0](arg0: ⇒ T0): T0

final def taskIdStr: String

final def timeStr: String

def toString(): String

final def trace(message: ⇒ Any): Unit

final def transform(k: InputKey, v: InputValue): (OutputKey, OutputValue)

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def warn(message: ⇒ Any): Unit

final def watermark: Watermark

Inherited from ProcessorContextLogging

Inherited from OnFlush

Inherited from OnClose

Inherited from OnWatermark

Inherited from OnInit

Inherited from Transformer[InputKey, InputValue, (OutputKey, OutputValue)]

Inherited from AnyRef

Inherited from Any

Ungrouped