Package org.apache.spark.sql.streaming

Interface MapState<K,V>

All Superinterfaces:
Serializable
public interface MapState<K,V> extends Serializable
Interface used for arbitrary stateful operations with the v2 API to capture map value state.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Remove this state.
    boolean
    containsKey(K key)
    Check if the user key is contained in the map
    boolean
    exists()
    Whether state exists or not.
    V
    getValue(K key)
    Get the state value if it exists
    scala.collection.Iterator<scala.Tuple2<K,V>>
    iterator()
    Get the map associated with grouping key
    scala.collection.Iterator<K>
    keys()
    Get the list of keys present in map associated with grouping key
    void
    removeKey(K key)
    Remove user key from map state
    void
    updateValue(K key, V value)
    Update value for given user key
    scala.collection.Iterator<V>
    values()
    Get the list of values present in map associated with grouping key

  • Method Details

    • clear

      void clear()
      Remove this state.

    • containsKey

      boolean containsKey(K key)
      Check if the user key is contained in the map

    • exists

      boolean exists()
      Whether state exists or not.

    • getValue

      V getValue(K key)
      Get the state value if it exists

    • iterator

      scala.collection.Iterator<scala.Tuple2<K,V>> iterator()
      Get the map associated with grouping key

    • keys

      scala.collection.Iterator<K> keys()
      Get the list of keys present in map associated with grouping key

    • removeKey

      void removeKey(K key)
      Remove user key from map state

    • updateValue

      void updateValue(K key, V value)
      Update value for given user key

    • values

      scala.collection.Iterator<V> values()
      Get the list of values present in map associated with grouping key