Package org.apache.beam.sdk.transforms

Annotation Interface DoFn.OnTimer

Enclosing class:
DoFn<InputT extends @Nullable Object,OutputT extends @Nullable Object>
@Documented @Retention(RUNTIME) @Target(METHOD) public static @interface DoFn.OnTimer
Annotation for registering a callback for a timer.

See the javadoc for DoFn.TimerId for use in a full example.

The method annotated with @OnTimer may have parameters according to the same logic as DoFn.ProcessElement, but limited to the BoundedWindow, State subclasses, and Timer. State and timer parameters must be annotated with their DoFn.StateId and DoFn.TimerId respectively.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    The timer ID.

  • Element Details

    • value

      String value
      The timer ID.