org.apache.beam.sdk.transforms.reflect

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 a DoFn.OnTimer method.

Constructor Summary

Constructors

Constructor and Description
OnTimerMethod()

Method Summary

Modifier and Type	Method and 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's DoFn.TimerId annotation.
abstract boolean	requiresStableInput() Whether this method requires stable input, expressed via DoFn.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

Constructor Detail

OnTimerMethod

public OnTimerMethod()

Method Detail

id

public abstract java.lang.String id()

The id on the method's DoFn.TimerId annotation.

targetMethod

public abstract java.lang.reflect.Method targetMethod()

The annotated method itself.

Specified by:

targetMethod in interface DoFnSignature.DoFnMethod

requiresStableInput

public abstract boolean requiresStableInput()

Whether this method requires stable input, expressed via DoFn.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 interface DoFnSignature.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 interface DoFnSignature.MethodWithExtraParameters