Class DoFnSignature.OnTimerMethod
- java.lang.Object
-
- org.apache.beam.sdk.transforms.reflect.DoFnSignature.OnTimerMethod
-
- All Implemented Interfaces:
DoFnSignature.DoFnMethod
,DoFnSignature.MethodWithExtraParameters
- Enclosing class:
- DoFnSignature
public abstract static class DoFnSignature.OnTimerMethod extends java.lang.Object implements DoFnSignature.MethodWithExtraParameters
Describes aDoFn.OnTimer
method.
-
-
Constructor Summary
Constructors Constructor Description OnTimerMethod()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract java.util.List<DoFnSignature.Parameter>
extraParameters()
Types of optional parameters of the annotated method, in the order they appear.abstract java.lang.String
id()
The id on the method'sDoFn.TimerId
annotation.abstract boolean
requiresStableInput()
Whether this method requires stable input, expressed viaDoFn.RequiresStableInput
.abstract java.lang.reflect.Method
targetMethod()
The annotated method itself.abstract @Nullable TypeDescriptor<? extends BoundedWindow>
windowT()
The window type used by this method, if any.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.beam.sdk.transforms.reflect.DoFnSignature.MethodWithExtraParameters
observesWindow
-
-
-
-
Method Detail
-
id
public abstract java.lang.String id()
The id on the method'sDoFn.TimerId
annotation.
-
targetMethod
public abstract java.lang.reflect.Method targetMethod()
The annotated method itself.- Specified by:
targetMethod
in interfaceDoFnSignature.DoFnMethod
-
requiresStableInput
public abstract boolean requiresStableInput()
Whether this method requires stable input, expressed viaDoFn.RequiresStableInput
. For timers, this means that any state must be stably persisted prior to calling it.
-
windowT
public abstract @Nullable TypeDescriptor<? extends BoundedWindow> windowT()
The window type used by this method, if any.- Specified by:
windowT
in interfaceDoFnSignature.MethodWithExtraParameters
-
extraParameters
public abstract java.util.List<DoFnSignature.Parameter> extraParameters()
Types of optional parameters of the annotated method, in the order they appear.- Specified by:
extraParameters
in interfaceDoFnSignature.MethodWithExtraParameters
-
-