Package org.apache.spark.sql.streaming

Interface ListState<S>

All Superinterfaces:
Serializable
public interface ListState<S> extends Serializable
Interface used for arbitrary stateful operations with the v2 API to capture list value state.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    appendList(Object newState)
    Append an entire list to the existing value
    void
    appendValue(S newState)
    Append an entry to the list
    void
    clear()
    Removes this state for the given grouping key.
    boolean
    exists()
    Whether state exists or not.
    scala.collection.Iterator<S>
    get()
    Get the state value.
    void
    put(Object newState)
    Update the value of the list.

  • Method Details

    • appendList

      void appendList(Object newState)
      Append an entire list to the existing value

    • appendValue

      void appendValue(S newState)
      Append an entry to the list

    • clear

      void clear()
      Removes this state for the given grouping key.

    • exists

      boolean exists()
      Whether state exists or not.

    • get

      scala.collection.Iterator<S> get()
      Get the state value. An empty iterator is returned if no value exists.

    • put

      void put(Object newState)
      Update the value of the list.