Package org.apache.spark.sql.streaming

Interface ValueState<S>

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Remove this state.
    boolean
    exists()
    Whether state exists or not.
    S
    get()
    Get the state value if it exists
    scala.Option<S>
    getOption()
    Get the state if it exists as an option and None otherwise
    void
    update(S newState)
    Update the value of the state.

  • Method Details

    • clear

      void clear()
      Remove this state.

    • exists

      boolean exists()
      Whether state exists or not.

    • get

      S get() throws NoSuchElementException
      Get the state value if it exists
      Returns:
      (undocumented)
      Throws:
      NoSuchElementException - if the state does not exist

    • getOption

      scala.Option<S> getOption()
      Get the state if it exists as an option and None otherwise

    • update

      void update(S newState)
      Update the value of the state.

      Parameters:
      newState - the new value