@Internal public abstract class DoFnSignature extends java.lang.Object
DoFn
, in particular, which features it uses, which extra
context it requires, types of the input and output elements, etc.
See A new DoFn.
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 . |
static class |
DoFnSignature.TruncateRestrictionMethod
Describes a
DoFn.TruncateRestriction method. |
Constructor and Description |
---|
DoFnSignature() |
Modifier and Type | Method and Description |
---|---|
abstract @Nullable java.util.Map<java.lang.String,DoFnSignature.FieldAccessDeclaration> |
fieldAccessDeclarations()
Field access declaration.
|
abstract @Nullable 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 @Nullable DoFnSignature.GetInitialRestrictionMethod |
getInitialRestriction()
Details about this
DoFn 's DoFn.GetInitialRestriction method. |
abstract @Nullable DoFnSignature.GetInitialWatermarkEstimatorStateMethod |
getInitialWatermarkEstimatorState()
Details about this
DoFn 's DoFn.GetInitialWatermarkEstimatorState method. |
abstract @Nullable DoFnSignature.GetRestrictionCoderMethod |
getRestrictionCoder()
Details about this
DoFn 's DoFn.GetRestrictionCoder method. |
abstract @Nullable DoFnSignature.GetSizeMethod |
getSize()
Details about this
DoFn 's DoFn.GetSize method. |
abstract @Nullable 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 @Nullable DoFnSignature.NewTrackerMethod |
newTracker()
Details about this
DoFn 's DoFn.NewTracker method. |
abstract @Nullable DoFnSignature.NewWatermarkEstimatorMethod |
newWatermarkEstimator()
Details about this
DoFn 's DoFn.NewWatermarkEstimator method. |
abstract @Nullable java.util.Map<java.lang.String,DoFnSignature.OnTimerFamilyMethod> |
onTimerFamilyMethods()
Details about this
DoFn 's DoFn.OnTimerFamily methods. |
abstract @Nullable java.util.Map<java.lang.String,DoFnSignature.OnTimerMethod> |
onTimerMethods()
Details about this
DoFn 's DoFn.OnTimer methods. |
abstract @Nullable DoFnSignature.OnWindowExpirationMethod |
onWindowExpiration()
Details about this
DoFn 's DoFn.OnWindowExpiration method. |
abstract DoFnSignature.ProcessElementMethod |
processElement()
Details about this
DoFn 's DoFn.ProcessElement method. |
abstract @Nullable DoFnSignature.LifecycleMethod |
setup()
Details about this
DoFn 's DoFn.Setup method. |
abstract @Nullable DoFnSignature.SplitRestrictionMethod |
splitRestriction()
Details about this
DoFn 's DoFn.SplitRestriction method. |
abstract @Nullable 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 @Nullable 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. |
abstract @Nullable DoFnSignature.TruncateRestrictionMethod |
truncateRestriction()
Details about this
DoFn 's DoFn.TruncateRestriction method. |
boolean |
usesState()
Whether the
DoFn described by this signature uses state. |
boolean |
usesTimers()
Whether the
DoFn described by this signature uses timers. |
public abstract java.lang.Class<? extends DoFn<?,?>> fnClass()
DoFn
from which this signature was produced.public abstract PCollection.IsBounded isBoundedPerElement()
DoFn
does a bounded amount of work per element.public abstract DoFnSignature.ProcessElementMethod processElement()
DoFn
's DoFn.ProcessElement
method.public abstract java.util.Map<java.lang.String,DoFnSignature.StateDeclaration> stateDeclarations()
DoFn
declares. Immutable.public abstract @Nullable DoFnSignature.BundleMethod startBundle()
DoFn
's DoFn.StartBundle
method.public abstract @Nullable DoFnSignature.BundleMethod finishBundle()
DoFn
's DoFn.FinishBundle
method.public abstract @Nullable DoFnSignature.LifecycleMethod setup()
DoFn
's DoFn.Setup
method.public abstract @Nullable DoFnSignature.LifecycleMethod teardown()
DoFn
's DoFn.Teardown
method.public abstract @Nullable DoFnSignature.OnWindowExpirationMethod onWindowExpiration()
DoFn
's DoFn.OnWindowExpiration
method.public abstract java.util.Map<java.lang.String,DoFnSignature.TimerDeclaration> timerDeclarations()
DoFn
class. Immutable.public abstract java.util.Map<java.lang.String,DoFnSignature.TimerFamilyDeclaration> timerFamilyDeclarations()
DoFn
class. Immutable.public abstract @Nullable java.util.Map<java.lang.String,DoFnSignature.FieldAccessDeclaration> fieldAccessDeclarations()
public abstract @Nullable DoFnSignature.GetInitialRestrictionMethod getInitialRestriction()
DoFn
's DoFn.GetInitialRestriction
method.public abstract @Nullable DoFnSignature.SplitRestrictionMethod splitRestriction()
DoFn
's DoFn.SplitRestriction
method.public abstract @Nullable DoFnSignature.TruncateRestrictionMethod truncateRestriction()
DoFn
's DoFn.TruncateRestriction
method.public abstract @Nullable DoFnSignature.GetRestrictionCoderMethod getRestrictionCoder()
DoFn
's DoFn.GetRestrictionCoder
method.public abstract @Nullable DoFnSignature.GetWatermarkEstimatorStateCoderMethod getWatermarkEstimatorStateCoder()
DoFn
's DoFn.GetWatermarkEstimatorStateCoder
method.public abstract @Nullable DoFnSignature.GetInitialWatermarkEstimatorStateMethod getInitialWatermarkEstimatorState()
DoFn
's DoFn.GetInitialWatermarkEstimatorState
method.public abstract @Nullable DoFnSignature.NewWatermarkEstimatorMethod newWatermarkEstimator()
DoFn
's DoFn.NewWatermarkEstimator
method.public abstract @Nullable DoFnSignature.NewTrackerMethod newTracker()
DoFn
's DoFn.NewTracker
method.public abstract @Nullable DoFnSignature.GetSizeMethod getSize()
DoFn
's DoFn.GetSize
method.public abstract @Nullable java.util.Map<java.lang.String,DoFnSignature.OnTimerMethod> onTimerMethods()
DoFn
's DoFn.OnTimer
methods.public abstract @Nullable java.util.Map<java.lang.String,DoFnSignature.OnTimerFamilyMethod> onTimerFamilyMethods()
DoFn
's DoFn.OnTimerFamily
methods.@Deprecated public boolean isStateful()
usesState()
, it's cleanerpublic boolean usesState()
DoFn
described by this signature uses state.public boolean usesTimers()
DoFn
described by this signature uses timers.