t

org. apache. spark. sql. streaming

StatefulProcessor

abstract class StatefulProcessor extends Serializable

Represents the arbitrary stateful logic that needs to be provided by the user to perform stateful manipulations on keyed streams.

Annotations
@Experimental () @Evolving ()
Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StatefulProcessor
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def init ( outputMode: OutputMode, timeMode: TimeMode ) : Unit

    Function that will be invoked as the first method that allows for users to initialize all their state variables and perform other init actions before handling data.

    Function that will be invoked as the first method that allows for users to initialize all their state variables and perform other init actions before handling data.

    outputMode

    - output mode for the stateful processor

    timeMode

    - itime mode for the stateful processor

  2. abstract def handleInputRows ( key: K, inputRows: Iterator[I], timerValues: TimerValues ) : Iterator[0]

    Function that will allow users to interact with input data rows along with the grouping key and current timer values and optionally provide output rows.

    Function that will allow users to interact with input data rows along with the grouping key and current timer values and optionally provide output rows.

    key

    - grouping key

    inputRows

    - iterator of input rows associated with grouping key

    timerValues

    - instance of TimerValues that provides access to current processing/event time if available

    returns

    Zero or more output rows

  3. abstract def handleExpiredTimer ( key: K, timerValues: TimerValues, expiredTimerInfo: ExpiredTimerInfo ) : Iterator[0] = 0

    Function that will be invoked when a timer is fired for a given key. Users can choose to evict state, register new timers and optionally provide output rows.

    Function that will be invoked when a timer is fired for a given key. Users can choose to evict state, register new timers and optionally provide output rows.

    key

    - grouping key

    timerValues

    - instance of TimerValues that provides access to current processing/event

    expiredTimerInfo

    - instance of ExpiredTimerInfo that provides access to expired timer

    returns

    Zero or more output rows. Set to 0 by default

  4. abstract def close ( ) : Unit = { }

    Function called as the last method that allows for users to perform any cleanup or teardown operations.

    Function called as the last method that allows for users to perform any cleanup or teardown operations.

    returns

    Empty set

  5. abstract final def setHandle ( handle: StatefulProcessorHandle ) : Unit = { statefulProcessorHandle = handle }

    Function to set the stateful processor handle that will be used to interact with the state store and other stateful processor related operations.

    Function to set the stateful processor handle that will be used to interact with the state store and other stateful processor related operations.

    handle

    - instance of StatefulProcessorHandle

    returns

    Reference to the set instance of StateProcesssorHandle

  6. abstract final def getHandle : StatefulProcessorHandle

    Function to get the stateful processor handle that will be used to interact with the state.

    Function to get the stateful processor handle that will be used to interact with the state.

    returns

    The current instance of StatefulProcessorHandle

Concrete Value Members

  1. final def != ( arg0: Any ) : Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def == ( arg0: Any ) : Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf [ T0] : T0
    Definition Classes
    Any
  5. def clone () : AnyRef
    Attributes
    protected[ lang]
    Definition Classes
    AnyRef
    Annotations
    @throws ( ... ) @native () @IntrinsicCandidate ()
  6. final def eq ( arg0: AnyRef ) : Boolean
    Definition Classes
    AnyRef
  7. def equals ( arg0: Any ) : Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass () : Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native () @IntrinsicCandidate ()
  9. def hashCode () : Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native () @IntrinsicCandidate ()
  10. final def isInstanceOf [ T0] : Boolean
    Definition Classes
    Any
  11. final def ne ( arg0: AnyRef ) : Boolean
    Definition Classes
    AnyRef
  12. final def notify () : Unit
    Definition Classes
    AnyRef
    Annotations
    @native () @IntrinsicCandidate ()
  13. final def notifyAll () : Unit
    Definition Classes
    AnyRef
    Annotations
    @native () @IntrinsicCandidate ()
  14. final def synchronized [ T0] ( arg0: ⇒ T0 ) : T0
    Definition Classes
    AnyRef
  15. def toString () : String
    Definition Classes
    AnyRef → Any
  16. final def wait ( arg0: Long , arg1: Int ) : Unit
    Definition Classes
    AnyRef
    Annotations
    @throws ( ... )
  17. final def wait ( arg0: Long ) : Unit
    Definition Classes
    AnyRef
    Annotations
    @throws ( ... ) @native ()
  18. final def wait () : Unit
    Definition Classes
    AnyRef
    Annotations
    @throws ( ... )

Deprecated Value Members

  1. def finalize () : Unit
    Attributes
    protected[ lang]
    Definition Classes
    AnyRef
    Annotations
    @throws ( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped