org.apache.beam.sdk.transforms.reflect

Interface DoFnSignature.MethodWithExtraParameters

All Superinterfaces:

DoFnSignature.DoFnMethod

All Known Implementing Classes:

DoFnSignature.BundleMethod, DoFnSignature.GetInitialRestrictionMethod, DoFnSignature.GetInitialWatermarkEstimatorStateMethod, DoFnSignature.GetSizeMethod, DoFnSignature.NewTrackerMethod, DoFnSignature.NewWatermarkEstimatorMethod, DoFnSignature.OnTimerFamilyMethod, DoFnSignature.OnTimerMethod, DoFnSignature.OnWindowExpirationMethod, DoFnSignature.ProcessElementMethod, DoFnSignature.SplitRestrictionMethod, DoFnSignature.TruncateRestrictionMethod

Enclosing class:

DoFnSignature

public static interface DoFnSignature.MethodWithExtraParameters
extends DoFnSignature.DoFnMethod

A method delegated to an annotated method of an underlying DoFn that accepts a dynamic list of parameters.

Method Summary

Modifier and Type	Method and Description
java.util.List<DoFnSignature.Parameter>	extraParameters() Types of optional parameters of the annotated method, in the order they appear.
default boolean	observesWindow() Whether this method observes - directly or indirectly - the window that an element resides in.
@Nullable TypeDescriptor<? extends BoundedWindow>	windowT() The type of window expected by this method, if any.

Methods inherited from interface org.apache.beam.sdk.transforms.reflect.DoFnSignature.DoFnMethod

targetMethod

Method Detail

extraParameters

java.util.List<DoFnSignature.Parameter> extraParameters()

Types of optional parameters of the annotated method, in the order they appear.

Validation that these are allowed is external to this class.

observesWindow

default boolean observesWindow()

Whether this method observes - directly or indirectly - the window that an element resides in.

State and Timer parameters indirectly observe the window, because they are each scoped to a single window.

windowT

@Nullable TypeDescriptor<? extends BoundedWindow> windowT()

The type of window expected by this method, if any.