Package org.apache.beam.sdk.transforms.reflect

Class DoFnSignature.Parameter

java.lang.Object

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

Direct Known Subclasses:

DoFnSignature.Parameter.BundleFinalizerParameter, DoFnSignature.Parameter.ElementParameter, DoFnSignature.Parameter.FinishBundleContextParameter, DoFnSignature.Parameter.KeyParameter, DoFnSignature.Parameter.OnTimerContextParameter, DoFnSignature.Parameter.OnWindowExpirationContextParameter, DoFnSignature.Parameter.OutputReceiverParameter, DoFnSignature.Parameter.PaneInfoParameter, DoFnSignature.Parameter.PipelineOptionsParameter, DoFnSignature.Parameter.ProcessContextParameter, DoFnSignature.Parameter.RestrictionParameter, DoFnSignature.Parameter.RestrictionTrackerParameter, DoFnSignature.Parameter.SchemaElementParameter, DoFnSignature.Parameter.SideInputParameter, DoFnSignature.Parameter.StartBundleContextParameter, DoFnSignature.Parameter.StateParameter, DoFnSignature.Parameter.TaggedOutputReceiverParameter, DoFnSignature.Parameter.TimeDomainParameter, DoFnSignature.Parameter.TimerFamilyParameter, DoFnSignature.Parameter.TimerIdParameter, DoFnSignature.Parameter.TimerParameter, DoFnSignature.Parameter.TimestampParameter, DoFnSignature.Parameter.WatermarkEstimatorParameter, DoFnSignature.Parameter.WatermarkEstimatorStateParameter, DoFnSignature.Parameter.WindowParameter

Enclosing class:

DoFnSignature

public abstract static class DoFnSignature.Parameter
extends java.lang.Object

A descriptor for an optional parameter of the DoFn.ProcessElement method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DoFnSignature.Parameter.BundleFinalizerParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.BundleFinalizer.
static interface	DoFnSignature.Parameter.Cases<ResultT>	An interface for destructuring a DoFnSignature.Parameter.
static class	DoFnSignature.Parameter.ElementParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.Element.
static class	DoFnSignature.Parameter.FinishBundleContextParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.FinishBundleContext.
static class	DoFnSignature.Parameter.KeyParameter
static class	DoFnSignature.Parameter.OnTimerContextParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.OnTimerContext.
static class	DoFnSignature.Parameter.OnWindowExpirationContextParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.OnWindowExpirationContext.
static class	DoFnSignature.Parameter.OutputReceiverParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.OutputReceiver.
static class	DoFnSignature.Parameter.PaneInfoParameter	Descriptor for a DoFnSignature.Parameter of type PaneInfo.
static class	DoFnSignature.Parameter.PipelineOptionsParameter	Descriptor for a DoFnSignature.Parameter of a subtype of PipelineOptions.
static class	DoFnSignature.Parameter.ProcessContextParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.ProcessContext.
static class	DoFnSignature.Parameter.RestrictionParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.Restriction.
static class	DoFnSignature.Parameter.RestrictionTrackerParameter	Descriptor for a DoFnSignature.Parameter of a subclass of RestrictionTracker.
static class	DoFnSignature.Parameter.SchemaElementParameter	Descriptor for a (@link Parameter} of type DoFn.Element where the type does not match the DoFn's input type.
static class	DoFnSignature.Parameter.SideInputParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.SideInput.
static class	DoFnSignature.Parameter.StartBundleContextParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.StartBundleContext.
static class	DoFnSignature.Parameter.StateParameter	Descriptor for a DoFnSignature.Parameter of a subclass of State, with an id indicated by its DoFn.StateId annotation.
static class	DoFnSignature.Parameter.TaggedOutputReceiverParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.MultiOutputReceiver.
static class	DoFnSignature.Parameter.TimeDomainParameter	Descriptor for a DoFnSignature.Parameter representing the time domain of a timer.
static class	DoFnSignature.Parameter.TimerFamilyParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.TimerFamily.
static class	DoFnSignature.Parameter.TimerIdParameter
static class	DoFnSignature.Parameter.TimerParameter	Descriptor for a DoFnSignature.Parameter of type Timer, with an id indicated by its DoFn.TimerId annotation.
static class	DoFnSignature.Parameter.TimestampParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.Timestamp.
static class	DoFnSignature.Parameter.WatermarkEstimatorParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.WatermarkEstimatorState.
static class	DoFnSignature.Parameter.WatermarkEstimatorStateParameter	Descriptor for a DoFnSignature.Parameter of type DoFn.WatermarkEstimatorState.
static class	DoFnSignature.Parameter.WindowParameter	Descriptor for a DoFnSignature.Parameter of type BoundedWindow.

Method Summary

Modifier and Type	Method	Description
static DoFnSignature.Parameter.WindowParameter	boundedWindow(TypeDescriptor<? extends BoundedWindow> windowT)	Returns a DoFnSignature.Parameter.WindowParameter.
static DoFnSignature.Parameter.BundleFinalizerParameter	bundleFinalizer()	Returns a DoFnSignature.Parameter.BundleFinalizerParameter.
static DoFnSignature.Parameter.ElementParameter	elementParameter(TypeDescriptor<?> elementT)
static DoFnSignature.Parameter.FinishBundleContextParameter	finishBundleContext()	Returns a DoFnSignature.Parameter.FinishBundleContextParameter.
static DoFnSignature.Parameter.KeyParameter	keyT(TypeDescriptor<?> keyT)	Returns a DoFnSignature.Parameter.KeyParameter.
<ResultT> ResultT	match(DoFnSignature.Parameter.Cases<ResultT> cases)	Performs case analysis on this DoFnSignature.Parameter, processing it with the appropriate DoFnSignature.Parameter.Cases.dispatch(org.apache.beam.sdk.transforms.reflect.DoFnSignature.Parameter.StartBundleContextParameter) case of the provided DoFnSignature.Parameter.Cases object.
static DoFnSignature.Parameter.OnTimerContextParameter	onTimerContext()	Returns a DoFnSignature.Parameter.OnTimerContextParameter.
static DoFnSignature.Parameter.OnWindowExpirationContextParameter	onWindowExpirationContext()	Returns a DoFnSignature.Parameter.OnWindowExpirationContextParameter.
static DoFnSignature.Parameter.OutputReceiverParameter	outputReceiverParameter(boolean rowReceiver)
static DoFnSignature.Parameter.PaneInfoParameter	paneInfoParameter()
static DoFnSignature.Parameter.PipelineOptionsParameter	pipelineOptions()	Returns a DoFnSignature.Parameter.PipelineOptionsParameter.
static DoFnSignature.Parameter.ProcessContextParameter	processContext()	Returns a DoFnSignature.Parameter.ProcessContextParameter.
static DoFnSignature.Parameter.RestrictionParameter	restrictionParameter(TypeDescriptor<?> restrictionT)	Returns a DoFnSignature.Parameter.RestrictionParameter.
static DoFnSignature.Parameter.RestrictionTrackerParameter	restrictionTracker(TypeDescriptor<?> trackerT)	Returns a DoFnSignature.Parameter.RestrictionTrackerParameter.
static DoFnSignature.Parameter.SchemaElementParameter	schemaElementParameter(TypeDescriptor<?> elementT, @Nullable java.lang.String fieldAccessString, int index)
static DoFnSignature.Parameter.SideInputParameter	sideInputParameter(TypeDescriptor<?> elementT, java.lang.String sideInputId)
static DoFnSignature.Parameter.StartBundleContextParameter	startBundleContext()	Returns a DoFnSignature.Parameter.StartBundleContextParameter.
static DoFnSignature.Parameter.StateParameter	stateParameter(DoFnSignature.StateDeclaration decl, boolean alwaysFetched)	Returns a DoFnSignature.Parameter.StateParameter referring to the given DoFnSignature.StateDeclaration.
static DoFnSignature.Parameter.TaggedOutputReceiverParameter	taggedOutputReceiverParameter()
static DoFnSignature.Parameter.TimeDomainParameter	timeDomainParameter()
static DoFnSignature.Parameter.TimerFamilyParameter	timerFamilyParameter(DoFnSignature.TimerFamilyDeclaration decl)
static DoFnSignature.Parameter.TimerIdParameter	timerIdParameter()
static DoFnSignature.Parameter.TimerParameter	timerParameter(DoFnSignature.TimerDeclaration decl)
static DoFnSignature.Parameter.TimestampParameter	timestampParameter()
static DoFnSignature.Parameter.WatermarkEstimatorParameter	watermarkEstimator(TypeDescriptor<?> watermarkEstimatorT)	Returns a DoFnSignature.Parameter.WatermarkEstimatorParameter.
static DoFnSignature.Parameter.WatermarkEstimatorStateParameter	watermarkEstimatorState(TypeDescriptor<?> watermarkEstimatorStateT)	Returns a DoFnSignature.Parameter.WatermarkEstimatorStateParameter.

Methods inherited from class java.lang.Object

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

Method Detail

match

public <ResultT> ResultT match(DoFnSignature.Parameter.Cases<ResultT> cases)

Performs case analysis on this DoFnSignature.Parameter, processing it with the appropriate DoFnSignature.Parameter.Cases.dispatch(org.apache.beam.sdk.transforms.reflect.DoFnSignature.Parameter.StartBundleContextParameter) case of the provided DoFnSignature.Parameter.Cases object.

processContext

public static DoFnSignature.Parameter.ProcessContextParameter processContext()

Returns a DoFnSignature.Parameter.ProcessContextParameter.

startBundleContext

public static DoFnSignature.Parameter.StartBundleContextParameter startBundleContext()

Returns a DoFnSignature.Parameter.StartBundleContextParameter.

finishBundleContext

public static DoFnSignature.Parameter.FinishBundleContextParameter finishBundleContext()

Returns a DoFnSignature.Parameter.FinishBundleContextParameter.

bundleFinalizer

public static DoFnSignature.Parameter.BundleFinalizerParameter bundleFinalizer()

Returns a DoFnSignature.Parameter.BundleFinalizerParameter.

elementParameter

public static DoFnSignature.Parameter.ElementParameter elementParameter(TypeDescriptor<?> elementT)

schemaElementParameter

public static DoFnSignature.Parameter.SchemaElementParameter schemaElementParameter(TypeDescriptor<?> elementT,
                                                                                    @Nullable java.lang.String fieldAccessString,
                                                                                    int index)

timestampParameter

public static DoFnSignature.Parameter.TimestampParameter timestampParameter()

timerIdParameter

public static DoFnSignature.Parameter.TimerIdParameter timerIdParameter()

sideInputParameter

public static DoFnSignature.Parameter.SideInputParameter sideInputParameter(TypeDescriptor<?> elementT,
                                                                            java.lang.String sideInputId)

timeDomainParameter

public static DoFnSignature.Parameter.TimeDomainParameter timeDomainParameter()

outputReceiverParameter

public static DoFnSignature.Parameter.OutputReceiverParameter outputReceiverParameter(boolean rowReceiver)

taggedOutputReceiverParameter

public static DoFnSignature.Parameter.TaggedOutputReceiverParameter taggedOutputReceiverParameter()

onTimerContext

public static DoFnSignature.Parameter.OnTimerContextParameter onTimerContext()

Returns a DoFnSignature.Parameter.OnTimerContextParameter.

onWindowExpirationContext

public static DoFnSignature.Parameter.OnWindowExpirationContextParameter onWindowExpirationContext()

Returns a DoFnSignature.Parameter.OnWindowExpirationContextParameter.

paneInfoParameter

public static DoFnSignature.Parameter.PaneInfoParameter paneInfoParameter()

boundedWindow

public static DoFnSignature.Parameter.WindowParameter boundedWindow(TypeDescriptor<? extends BoundedWindow> windowT)

Returns a DoFnSignature.Parameter.WindowParameter.

keyT

public static DoFnSignature.Parameter.KeyParameter keyT(TypeDescriptor<?> keyT)

Returns a DoFnSignature.Parameter.KeyParameter.

pipelineOptions

public static DoFnSignature.Parameter.PipelineOptionsParameter pipelineOptions()

Returns a DoFnSignature.Parameter.PipelineOptionsParameter.

restrictionParameter

public static DoFnSignature.Parameter.RestrictionParameter restrictionParameter(TypeDescriptor<?> restrictionT)

Returns a DoFnSignature.Parameter.RestrictionParameter.

restrictionTracker

public static DoFnSignature.Parameter.RestrictionTrackerParameter restrictionTracker(TypeDescriptor<?> trackerT)

Returns a DoFnSignature.Parameter.RestrictionTrackerParameter.

watermarkEstimator

public static DoFnSignature.Parameter.WatermarkEstimatorParameter watermarkEstimator(TypeDescriptor<?> watermarkEstimatorT)

Returns a DoFnSignature.Parameter.WatermarkEstimatorParameter.

watermarkEstimatorState

public static DoFnSignature.Parameter.WatermarkEstimatorStateParameter watermarkEstimatorState(TypeDescriptor<?> watermarkEstimatorStateT)

Returns a DoFnSignature.Parameter.WatermarkEstimatorStateParameter.

stateParameter

public static DoFnSignature.Parameter.StateParameter stateParameter(DoFnSignature.StateDeclaration decl,
                                                                    boolean alwaysFetched)

Returns a DoFnSignature.Parameter.StateParameter referring to the given DoFnSignature.StateDeclaration.

timerParameter

public static DoFnSignature.Parameter.TimerParameter timerParameter(DoFnSignature.TimerDeclaration decl)

timerFamilyParameter

public static DoFnSignature.Parameter.TimerFamilyParameter timerFamilyParameter(DoFnSignature.TimerFamilyDeclaration decl)