Package org.apache.beam.sdk.transforms

Annotation Type DoFn.OnTimer

  • @Documented
@Retention(RUNTIME)
@Target(METHOD)
@Experimental(TIMERS)
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
      java.lang.String value
      The timer ID.

    • Element Detail

      • value

        java.lang.String value
        The timer ID.