Packages

c

org.apache.flinkx.api.function

ProcessWindowFunction

abstract class ProcessWindowFunction[IN, OUT, KEY, W <: Window] extends AbstractRichFunction

Base abstract class for functions that are evaluated over keyed (grouped) windows using a context for retrieving extra information.

IN

The type of the input value.

OUT

The type of the output value.

KEY

The type of the key.

W

The type of the window.

Annotations
@PublicEvolving()
Linear Supertypes
AbstractRichFunction, RichFunction, Function, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessWindowFunction
  2. AbstractRichFunction
  3. RichFunction
  4. Function
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ProcessWindowFunction()

Type Members

  1. abstract class Context extends AnyRef

    The context holding window metadata

Abstract Value Members

  1. abstract def process(key: KEY, context: Context, elements: Iterable[IN], out: Collector[OUT]): Unit

    Evaluates the window and outputs none or several elements.

    Evaluates the window and outputs none or several elements.

    key

    The key for which this window is evaluated.

    context

    The context in which the window is being evaluated.

    elements

    The elements in the window being evaluated.

    out

    A collector for emitting elements.

    Annotations
    @throws( ... )
    Exceptions thrown

    Exception The function may throw exceptions to fail the program and trigger recovery.

Concrete 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(context: Context): Unit

    Deletes any state in the Context when the Window expires (the watermark passes its maxTimestamp + allowedLateness).

    Deletes any state in the Context when the Window expires (the watermark passes its maxTimestamp + allowedLateness).

    context

    The context to which the window is being evaluated

    Annotations
    @throws( ... )
    Exceptions thrown

    Exception The function may throw exceptions to fail the program and trigger recovery.

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def close(): Unit
    Definition Classes
    AbstractRichFunction → RichFunction
    Annotations
    @throws( classOf[java.lang.Exception] )
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def getIterationRuntimeContext(): IterationRuntimeContext
    Definition Classes
    AbstractRichFunction → RichFunction
  12. def getRuntimeContext(): RuntimeContext
    Definition Classes
    AbstractRichFunction → RichFunction
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def open(arg0: Configuration): Unit
    Definition Classes
    AbstractRichFunction → RichFunction
    Annotations
    @throws( classOf[java.lang.Exception] )
  19. def setRuntimeContext(arg0: RuntimeContext): Unit
    Definition Classes
    AbstractRichFunction → RichFunction
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  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()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from AbstractRichFunction

Inherited from RichFunction

Inherited from Function

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped