Trait

com.twitter.finatra.kafkastreams.transformer.stores

CachingKeyValueStores

Related Doc: package stores

Permalink

trait CachingKeyValueStores[K, V, K1, V1] extends FinatraTransformer[K, V, K1, V1] with FlushingTransformer[K, V, K1, V1]

Trait to mix into a FinatraTransformer which is used to access a caching enabled Finatra Store

K

Transformer key input type

V

Transformer value input type

K1

Transformer key return type

V1

Transformer value return type

Linear Supertypes
FlushingTransformer[K, V, K1, V1], Flushing, FinatraTransformer[K, V, K1, V1], ProcessorContextLogging, OnFlush, OnClose, OnWatermark, OnInit, Transformer[K, V, (K1, V1)], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CachingKeyValueStores
  2. FlushingTransformer
  3. Flushing
  4. FinatraTransformer
  5. ProcessorContextLogging
  6. OnFlush
  7. OnClose
  8. OnWatermark
  9. OnInit
  10. Transformer
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class RichLong extends AnyRef

    Permalink
    Definition Classes
    ProcessorContextLogging

Abstract Value Members

  1. abstract def commitInterval: Duration

    Permalink
    Attributes
    protected
    Definition Classes
    Flushing
  2. abstract def onMessage(messageTime: Time, key: K, value: V): Unit

    Permalink

    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]
    Definition Classes
    FinatraTransformer

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

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

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

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

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

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

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

    Permalink
    Attributes
    protected[com.twitter.finatra.kafkastreams]
    Definition Classes
    FinatraTransformer
  13. final def forward(key: K1, value: V1, timestamp: Long): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    FinatraTransformer
  14. final def forward(key: K1, value: V1): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    FinatraTransformer
  15. def getCachingKeyValueStore[KK, VV](name: String, flushListener: (String, KK, VV) ⇒ Unit)(implicit arg0: ClassTag[KK]): FinatraKeyValueStore[KK, VV]

    Permalink

    Lookup a caching key value store by name

    Lookup a caching key value store by name

    KK

    Type of keys in the store

    VV

    Type of values in the store

    name

    The name of the store

    flushListener

    Callback that will be called every time a cached store entry is flushed into the underlying RocksDB store

    returns

    A caching key value store

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

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

    Permalink

    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
    Definition Classes
    FinatraTransformer
  18. def hashCode(): Int

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. def onClose(): Unit

    Permalink
    Definition Classes
    FlushingOnClose
  26. def onFlush(): Unit

    Permalink

    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
    CachingKeyValueStoresFinatraTransformerOnFlush
  27. def onInit(): Unit

    Permalink
    Definition Classes
    FlushingOnInit
  28. def onWatermark(watermark: Watermark): Unit

    Permalink
    Definition Classes
    FinatraTransformerOnWatermark
  29. def processorContext: ProcessorContext

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

    Permalink
    Definition Classes
    AnyRef
  31. final def taskIdStr: String

    Permalink
    Attributes
    protected
    Definition Classes
    ProcessorContextLogging
  32. final def timeStr: String

    Permalink
    Attributes
    protected
    Definition Classes
    ProcessorContextLogging
  33. def toString(): String

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    ProcessorContextLogging
  35. final def transform(k: K, v: V): (K1, V1)

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

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

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

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

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

    Permalink
    Attributes
    protected[com.twitter.finatra]
    Definition Classes
    FinatraTransformer

Inherited from FlushingTransformer[K, V, K1, V1]

Inherited from Flushing

Inherited from FinatraTransformer[K, V, K1, V1]

Inherited from ProcessorContextLogging

Inherited from OnFlush

Inherited from OnClose

Inherited from OnWatermark

Inherited from OnInit

Inherited from Transformer[K, V, (K1, V1)]

Inherited from AnyRef

Inherited from Any

Ungrouped