org.apache.beam.sdk.transforms.reflect

Class DoFnSignature.ProcessElementMethod

java.lang.Object

org.apache.beam.sdk.transforms.reflect.DoFnSignature.ProcessElementMethod

All Implemented Interfaces:

DoFnSignature.DoFnMethod, DoFnSignature.MethodWithExtraParameters

Enclosing class:

DoFnSignature

public abstract static class DoFnSignature.ProcessElementMethod
extends java.lang.Object
implements DoFnSignature.MethodWithExtraParameters

Describes a DoFn.ProcessElement method.

Constructor Summary

Constructors

Constructor and Description
ProcessElementMethod()

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.
@Nullable DoFnSignature.Parameter.OutputReceiverParameter	getMainOutputReceiver() The DoFnSignature.Parameter.OutputReceiverParameter for a main output, or null if there is none.
@Nullable java.util.List<DoFnSignature.Parameter.SchemaElementParameter>	getSchemaElementParameters()
@Nullable java.util.List<DoFnSignature.Parameter.SideInputParameter>	getSideInputParameters()
abstract boolean	hasReturnValue() Whether this DoFn returns a DoFn.ProcessContinuation or void.
boolean	isSplittable() Whether this DoFn is splittable.
abstract boolean	requiresStableInput() Whether this method requires stable input, expressed via DoFn.RequiresStableInput.
abstract boolean	requiresTimeSortedInput() Whether this method requires time sorted input, expressed via DoFn.RequiresTimeSortedInput.
abstract java.lang.reflect.Method	targetMethod() The annotated method itself.
abstract @Nullable TypeDescriptor<?>	trackerT() Concrete type of the RestrictionTracker parameter, if present.
abstract @Nullable TypeDescriptor<?>	watermarkEstimatorT() Concrete type of the WatermarkEstimator parameter, if present.
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

ProcessElementMethod

public ProcessElementMethod()

Method Detail

targetMethod

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

The annotated method itself.

Specified by:

targetMethod in interface DoFnSignature.DoFnMethod

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

requiresStableInput

public abstract boolean requiresStableInput()

Whether this method requires stable input, expressed via DoFn.RequiresStableInput.

requiresTimeSortedInput

public abstract boolean requiresTimeSortedInput()

Whether this method requires time sorted input, expressed via DoFn.RequiresTimeSortedInput.

trackerT

public abstract @Nullable TypeDescriptor<?> trackerT()

Concrete type of the RestrictionTracker parameter, if present.

watermarkEstimatorT

public abstract @Nullable TypeDescriptor<?> watermarkEstimatorT()

Concrete type of the WatermarkEstimator parameter, if present.

windowT

public abstract @Nullable TypeDescriptor<? extends BoundedWindow> windowT()

The window type used by this method, if any.

Specified by:

windowT in interface DoFnSignature.MethodWithExtraParameters

hasReturnValue

public abstract boolean hasReturnValue()

Whether this DoFn returns a DoFn.ProcessContinuation or void.

getSchemaElementParameters

public @Nullable java.util.List<DoFnSignature.Parameter.SchemaElementParameter> getSchemaElementParameters()

getSideInputParameters

public @Nullable java.util.List<DoFnSignature.Parameter.SideInputParameter> getSideInputParameters()

getMainOutputReceiver

public @Nullable DoFnSignature.Parameter.OutputReceiverParameter getMainOutputReceiver()

The DoFnSignature.Parameter.OutputReceiverParameter for a main output, or null if there is none.

isSplittable

public boolean isSplittable()

Whether this DoFn is splittable.