org.apache.beam.sdk.transforms.reflect

Class DoFnSignatures

java.lang.Object

org.apache.beam.sdk.transforms.reflect.DoFnSignatures

@Internal
public class DoFnSignatures
extends java.lang.Object

Utilities for working with DoFnSignature. See getSignature(java.lang.Class<FnT>).

Method Summary

Modifier and Type	Method and Description
static <FnT extends DoFn<?,?>> DoFnSignature	getSignature(java.lang.Class<FnT> fn)
static StateSpec<?>	getStateSpecOrThrow(DoFnSignature.StateDeclaration stateDeclaration, DoFn<?,?> target)
static TimerSpec	getTimerFamilySpecOrThrow(DoFnSignature.TimerFamilyDeclaration timerFamilyDeclaration, DoFn<?,?> target)
static TimerSpec	getTimerSpecOrThrow(DoFnSignature.TimerDeclaration timerDeclaration, DoFn<?,?> target)
static boolean	isSplittable(DoFn<?,?> doFn)
static boolean	isStateful(DoFn<?,?> doFn)
static boolean	requiresTimeSortedInput(DoFn<?,?> doFn)
static <FnT extends DoFn<?,?>> DoFnSignature	signatureForDoFn(FnT fn)
static boolean	usesBagState(DoFn<?,?> doFn)
static boolean	usesMapState(DoFn<?,?> doFn)
static boolean	usesOrderedListState(DoFn<?,?> doFn)
static boolean	usesSetState(DoFn<?,?> doFn)
static boolean	usesState(DoFn<?,?> doFn)
static boolean	usesTimers(DoFn<?,?> doFn)
static boolean	usesValueState(DoFn<?,?> doFn)
static boolean	usesWatermarkHold(DoFn<?,?> doFn)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

signatureForDoFn

public static <FnT extends DoFn<?,?>> DoFnSignature signatureForDoFn(FnT fn)

Returns:

the DoFnSignature for the given DoFn instance.

getSignature

public static <FnT extends DoFn<?,?>> DoFnSignature getSignature(java.lang.Class<FnT> fn)

Returns:

the DoFnSignature for the given DoFn subclass.

getStateSpecOrThrow

public static StateSpec<?> getStateSpecOrThrow(DoFnSignature.StateDeclaration stateDeclaration,
                                               DoFn<?,?> target)

getTimerSpecOrThrow

public static TimerSpec getTimerSpecOrThrow(DoFnSignature.TimerDeclaration timerDeclaration,
                                            DoFn<?,?> target)

getTimerFamilySpecOrThrow

public static TimerSpec getTimerFamilySpecOrThrow(DoFnSignature.TimerFamilyDeclaration timerFamilyDeclaration,
                                                  DoFn<?,?> target)

isSplittable

public static boolean isSplittable(DoFn<?,?> doFn)

isStateful

public static boolean isStateful(DoFn<?,?> doFn)

usesMapState

public static boolean usesMapState(DoFn<?,?> doFn)

usesSetState

public static boolean usesSetState(DoFn<?,?> doFn)

usesOrderedListState

public static boolean usesOrderedListState(DoFn<?,?> doFn)

usesValueState

public static boolean usesValueState(DoFn<?,?> doFn)

usesBagState

public static boolean usesBagState(DoFn<?,?> doFn)

usesWatermarkHold

public static boolean usesWatermarkHold(DoFn<?,?> doFn)

usesTimers

public static boolean usesTimers(DoFn<?,?> doFn)

usesState

public static boolean usesState(DoFn<?,?> doFn)

requiresTimeSortedInput

public static boolean requiresTimeSortedInput(DoFn<?,?> doFn)