org.apache.beam.sdk.transforms.reflect

Class DoFnSignature

java.lang.Object

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

@Internal
public abstract class DoFnSignature
extends java.lang.Object

Describes the signature of a DoFn, in particular, which features it uses, which extra context it requires, types of the input and output elements, etc.

See A new DoFn.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DoFnSignature.BundleMethod Describes a DoFn.StartBundle or DoFn.FinishBundle method.
static interface	DoFnSignature.DoFnMethod A method delegated to an annotated method of an underlying DoFn.
static class	DoFnSignature.FieldAccessDeclaration Decscribes a field access declaration.
static class	DoFnSignature.GetInitialRestrictionMethod Describes a DoFn.GetInitialRestriction method.
static class	DoFnSignature.GetInitialWatermarkEstimatorStateMethod Describes a DoFn.GetInitialWatermarkEstimatorState method.
static class	DoFnSignature.GetRestrictionCoderMethod Describes a DoFn.GetRestrictionCoder method.
static class	DoFnSignature.GetSizeMethod Describes a DoFn.GetSize method.
static class	DoFnSignature.GetWatermarkEstimatorStateCoderMethod Describes a DoFn.GetRestrictionCoder method.
static class	DoFnSignature.LifecycleMethod Describes a DoFn.Setup or DoFn.Teardown method.
static interface	DoFnSignature.MethodWithExtraParameters A method delegated to an annotated method of an underlying DoFn that accepts a dynamic list of parameters.
static class	DoFnSignature.NewTrackerMethod Describes a DoFn.NewTracker method.
static class	DoFnSignature.NewWatermarkEstimatorMethod Describes a DoFn.NewWatermarkEstimator method.
static class	DoFnSignature.OnTimerFamilyMethod Describes a DoFn.OnTimerFamily method.
static class	DoFnSignature.OnTimerMethod Describes a DoFn.OnTimer method.
static class	DoFnSignature.OnWindowExpirationMethod Describes a DoFn.OnWindowExpiration method.
static class	DoFnSignature.Parameter A descriptor for an optional parameter of the DoFn.ProcessElement method.
static class	DoFnSignature.ProcessElementMethod Describes a DoFn.ProcessElement method.
static class	DoFnSignature.SplitRestrictionMethod Describes a DoFn.SplitRestriction method.
static class	DoFnSignature.StateDeclaration Describes a state declaration; a field of type StateSpec annotated with DoFn.StateId.
static class	DoFnSignature.TimerDeclaration Describes a timer declaration; a field of type TimerSpec annotated with DoFn.TimerId.
static class	DoFnSignature.TimerFamilyDeclaration Describes a timer family declaration; a field of type TimerSpec annotated with DoFn.TimerFamily.

Constructor Summary

Constructors

Constructor and Description
DoFnSignature()

Method Summary

Modifier and Type	Method and Description
abstract java.util.Map<java.lang.String,DoFnSignature.FieldAccessDeclaration>	fieldAccessDeclarations() Field access declaration.
abstract DoFnSignature.BundleMethod	finishBundle() Details about this DoFn's DoFn.FinishBundle method.
abstract java.lang.Class<? extends DoFn<?,?>>	fnClass() Class of the original DoFn from which this signature was produced.
abstract DoFnSignature.GetInitialRestrictionMethod	getInitialRestriction() Details about this DoFn's DoFn.GetInitialRestriction method.
abstract DoFnSignature.GetInitialWatermarkEstimatorStateMethod	getInitialWatermarkEstimatorState() Details about this DoFn's DoFn.GetInitialWatermarkEstimatorState method.
abstract DoFnSignature.GetRestrictionCoderMethod	getRestrictionCoder() Details about this DoFn's DoFn.GetRestrictionCoder method.
abstract DoFnSignature.GetSizeMethod	getSize() Details about this DoFn's DoFn.GetSize method.
abstract DoFnSignature.GetWatermarkEstimatorStateCoderMethod	getWatermarkEstimatorStateCoder() Details about this DoFn's DoFn.GetWatermarkEstimatorStateCoder method.
abstract PCollection.IsBounded	isBoundedPerElement() Whether this DoFn does a bounded amount of work per element.
boolean	isStateful() Deprecated. use usesState(), it's cleaner
abstract DoFnSignature.NewTrackerMethod	newTracker() Details about this DoFn's DoFn.NewTracker method.
abstract DoFnSignature.NewWatermarkEstimatorMethod	newWatermarkEstimator() Details about this DoFn's DoFn.NewWatermarkEstimator method.
abstract java.util.Map<java.lang.String,DoFnSignature.OnTimerFamilyMethod>	onTimerFamilyMethods() Details about this DoFn's DoFn.OnTimerFamily methods.
abstract java.util.Map<java.lang.String,DoFnSignature.OnTimerMethod>	onTimerMethods() Details about this DoFn's DoFn.OnTimer methods.
abstract DoFnSignature.OnWindowExpirationMethod	onWindowExpiration() Details about this DoFn's DoFn.OnWindowExpiration method.
abstract DoFnSignature.ProcessElementMethod	processElement() Details about this DoFn's DoFn.ProcessElement method.
abstract DoFnSignature.LifecycleMethod	setup() Details about this DoFn's DoFn.Setup method.
abstract DoFnSignature.SplitRestrictionMethod	splitRestriction() Details about this DoFn's DoFn.SplitRestriction method.
abstract DoFnSignature.BundleMethod	startBundle() Details about this DoFn's DoFn.StartBundle method.
abstract java.util.Map<java.lang.String,DoFnSignature.StateDeclaration>	stateDeclarations() Details about the state cells that this DoFn declares.
abstract DoFnSignature.LifecycleMethod	teardown() Details about this DoFn's DoFn.Teardown method.
abstract java.util.Map<java.lang.String,DoFnSignature.TimerDeclaration>	timerDeclarations() Timer declarations present on the DoFn class.
abstract java.util.Map<java.lang.String,DoFnSignature.TimerFamilyDeclaration>	timerFamilyDeclarations() TimerMap declarations present on the DoFn class.
boolean	usesState() Whether the DoFn described by this signature uses state.
boolean	usesTimers() Whether the DoFn described by this signature uses timers.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoFnSignature

public DoFnSignature()

Method Detail

fnClass

public abstract java.lang.Class<? extends DoFn<?,?>> fnClass()

Class of the original DoFn from which this signature was produced.

isBoundedPerElement

public abstract PCollection.IsBounded isBoundedPerElement()

Whether this DoFn does a bounded amount of work per element.

processElement

public abstract DoFnSignature.ProcessElementMethod processElement()

Details about this DoFn's DoFn.ProcessElement method.

stateDeclarations

public abstract java.util.Map<java.lang.String,DoFnSignature.StateDeclaration> stateDeclarations()

Details about the state cells that this DoFn declares. Immutable.

startBundle

@Nullable
public abstract DoFnSignature.BundleMethod startBundle()

Details about this DoFn's DoFn.StartBundle method.

finishBundle

@Nullable
public abstract DoFnSignature.BundleMethod finishBundle()

Details about this DoFn's DoFn.FinishBundle method.

setup

@Nullable
public abstract DoFnSignature.LifecycleMethod setup()

Details about this DoFn's DoFn.Setup method.

teardown

@Nullable
public abstract DoFnSignature.LifecycleMethod teardown()

Details about this DoFn's DoFn.Teardown method.

onWindowExpiration

@Nullable
public abstract DoFnSignature.OnWindowExpirationMethod onWindowExpiration()

Details about this DoFn's DoFn.OnWindowExpiration method.

timerDeclarations

public abstract java.util.Map<java.lang.String,DoFnSignature.TimerDeclaration> timerDeclarations()

Timer declarations present on the DoFn class. Immutable.

timerFamilyDeclarations

public abstract java.util.Map<java.lang.String,DoFnSignature.TimerFamilyDeclaration> timerFamilyDeclarations()

TimerMap declarations present on the DoFn class. Immutable.

fieldAccessDeclarations

@Nullable
public abstract java.util.Map<java.lang.String,DoFnSignature.FieldAccessDeclaration> fieldAccessDeclarations()

Field access declaration.

getInitialRestriction

@Nullable
public abstract DoFnSignature.GetInitialRestrictionMethod getInitialRestriction()

Details about this DoFn's DoFn.GetInitialRestriction method.

splitRestriction

@Nullable
public abstract DoFnSignature.SplitRestrictionMethod splitRestriction()

Details about this DoFn's DoFn.SplitRestriction method.

getRestrictionCoder

@Nullable
public abstract DoFnSignature.GetRestrictionCoderMethod getRestrictionCoder()

Details about this DoFn's DoFn.GetRestrictionCoder method.

getWatermarkEstimatorStateCoder

@Nullable
public abstract DoFnSignature.GetWatermarkEstimatorStateCoderMethod getWatermarkEstimatorStateCoder()

Details about this DoFn's DoFn.GetWatermarkEstimatorStateCoder method.

getInitialWatermarkEstimatorState

@Nullable
public abstract DoFnSignature.GetInitialWatermarkEstimatorStateMethod getInitialWatermarkEstimatorState()

Details about this DoFn's DoFn.GetInitialWatermarkEstimatorState method.

newWatermarkEstimator

@Nullable
public abstract DoFnSignature.NewWatermarkEstimatorMethod newWatermarkEstimator()

Details about this DoFn's DoFn.NewWatermarkEstimator method.

newTracker

@Nullable
public abstract DoFnSignature.NewTrackerMethod newTracker()

Details about this DoFn's DoFn.NewTracker method.

getSize

@Nullable
public abstract DoFnSignature.GetSizeMethod getSize()

Details about this DoFn's DoFn.GetSize method.

onTimerMethods

@Nullable
public abstract java.util.Map<java.lang.String,DoFnSignature.OnTimerMethod> onTimerMethods()

Details about this DoFn's DoFn.OnTimer methods.

onTimerFamilyMethods

@Nullable
public abstract java.util.Map<java.lang.String,DoFnSignature.OnTimerFamilyMethod> onTimerFamilyMethods()

Details about this DoFn's DoFn.OnTimerFamily methods.

isStateful

@Deprecated
public boolean isStateful()

Deprecated. use usesState(), it's cleaner

usesState

public boolean usesState()

Whether the DoFn described by this signature uses state.

usesTimers

public boolean usesTimers()

Whether the DoFn described by this signature uses timers.