Packages

object StateSpec extends Serializable

:: Experimental :: Builder object for creating instances of org.apache.spark.streaming.StateSpec that is used for specifying the parameters of the DStream transformation mapWithState that is used for specifying the parameters of the DStream transformation mapWithState operation of a pair DStream (Scala) or a JavaPairDStream (Java).

Example in Scala:

// A mapping function that maintains an integer state and return a String
def mappingFunction(key: String, value: Option[Int], state: State[Int]): Option[String] = {
  // Use state.exists(), state.get(), state.update() and state.remove()
  // to manage state, and return the necessary string
}

val spec = StateSpec.function(mappingFunction).numPartitions(10)

val mapWithStateDStream = keyValueDStream.mapWithState[StateType, MappedType](spec)

Example in Java:

// A mapping function that maintains an integer state and return a string
Function3<String, Optional<Integer>, State<Integer>, String> mappingFunction =
    new Function3<String, Optional<Integer>, State<Integer>, String>() {
        @Override
        public Optional<String> call(Optional<Integer> value, State<Integer> state) {
            // Use state.exists(), state.get(), state.update() and state.remove()
            // to manage state, and return the necessary string
        }
    };

 JavaMapWithStateDStream<String, Integer, Integer, String> mapWithStateDStream =
     keyValueDStream.mapWithState(StateSpec.function(mappingFunc));
Annotations
@Experimental()
Source
StateSpec.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StateSpec
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def function[KeyType, ValueType, StateType, MappedType](mappingFunction: Function3[KeyType, Optional[ValueType], State[StateType], MappedType]): StateSpec[KeyType, ValueType, StateType, MappedType]

    Create a StateSpec for setting all the specifications of the mapWithState operation on a JavaPairDStream.

    Create a StateSpec for setting all the specifications of the mapWithState operation on a JavaPairDStream.

    ValueType

    Class of the values

    StateType

    Class of the states data

    MappedType

    Class of the mapped data

    mappingFunction

    The function applied on every data item to manage the associated state and generate the mapped data

  10. def function[KeyType, ValueType, StateType, MappedType](mappingFunction: Function4[Time, KeyType, Optional[ValueType], State[StateType], Optional[MappedType]]): StateSpec[KeyType, ValueType, StateType, MappedType]

    Create a StateSpec for setting all the specifications of the mapWithState operation on a JavaPairDStream.

    Create a StateSpec for setting all the specifications of the mapWithState operation on a JavaPairDStream.

    KeyType

    Class of the keys

    ValueType

    Class of the values

    StateType

    Class of the states data

    MappedType

    Class of the mapped data

    mappingFunction

    The function applied on every data item to manage the associated state and generate the mapped data

  11. def function[KeyType, ValueType, StateType, MappedType](mappingFunction: (KeyType, Option[ValueType], State[StateType]) ⇒ MappedType): StateSpec[KeyType, ValueType, StateType, MappedType]

    Create a StateSpec for setting all the specifications of the mapWithState operation on a pair DStream.

    Create a StateSpec for setting all the specifications of the mapWithState operation on a pair DStream.

    ValueType

    Class of the values

    StateType

    Class of the states data

    MappedType

    Class of the mapped data

    mappingFunction

    The function applied on every data item to manage the associated state and generate the mapped data

  12. def function[KeyType, ValueType, StateType, MappedType](mappingFunction: (Time, KeyType, Option[ValueType], State[StateType]) ⇒ Option[MappedType]): StateSpec[KeyType, ValueType, StateType, MappedType]

    Create a StateSpec for setting all the specifications of the mapWithState operation on a pair DStream.

    Create a StateSpec for setting all the specifications of the mapWithState operation on a pair DStream.

    KeyType

    Class of the keys

    ValueType

    Class of the values

    StateType

    Class of the states data

    MappedType

    Class of the mapped data

    mappingFunction

    The function applied on every data item to manage the associated state and generate the mapped data

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped