Packages

c

org.apache.spark.sql.execution.streaming

ValueStateImplWithTTL

class ValueStateImplWithTTL[S] extends OneToOneTTLState with ValueState[S]

Class that provides a concrete implementation for a single value state associated with state variables (with ttl expiration support) used in the streaming transformWithState operator.

S

- data type of object that will be stored

Linear Supertypes
ValueState[S], Serializable, OneToOneTTLState, TTLState, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValueStateImplWithTTL
  2. ValueState
  3. Serializable
  4. OneToOneTTLState
  5. TTLState
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ValueStateImplWithTTL(store: StateStore, stateName: String, keyExprEnc: ExpressionEncoder[Any], valEncoder: ExpressionEncoder[Any], ttlConfig: TTLConfig, batchTimestampMs: Long, metrics: Map[String, SQLMetric] = Map.empty)

    store

    - reference to the StateStore instance to be used for storing state

    stateName

    - name of logical state partition

    keyExprEnc

    - Spark SQL encoder for key

    valEncoder

    - Spark SQL encoder for value

    ttlConfig

    - TTL configuration for values stored in this state

    batchTimestampMs

    - current batch processing timestamp.

    metrics

    - metrics to be updated as part of stateful processing

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 clear(): Unit

    Function to remove state for given key

    Function to remove state for given key

    Definition Classes
    ValueStateImplWithTTL → ValueState
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def exists(): Boolean

    Function to check if state exists.

    Function to check if state exists. Returns true if present and false otherwise

    Definition Classes
    ValueStateImplWithTTL → ValueState
  10. def get(): S

    Function to return associated value with key if exists and null otherwise

    Function to return associated value with key if exists and null otherwise

    Definition Classes
    ValueStateImplWithTTL → ValueState
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. def update(newState: S): Unit

    Function to update and overwrite state associated with given key

    Function to update and overwrite state associated with given key

    Definition Classes
    ValueStateImplWithTTL → ValueState
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from ValueState[S]

Inherited from Serializable

Inherited from OneToOneTTLState

Inherited from TTLState

Inherited from AnyRef

Inherited from Any

Ungrouped