org.apache.beam.sdk.transforms.reflect

Class DoFnInvoker.DelegatingArgumentProvider<InputT,OutputT>

java.lang.Object

org.apache.beam.sdk.transforms.reflect.DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

org.apache.beam.sdk.transforms.reflect.DoFnInvoker.DelegatingArgumentProvider<InputT,OutputT>

All Implemented Interfaces:

DoFnInvoker.ArgumentProvider<InputT,OutputT>

Enclosing interface:

DoFnInvoker<InputT,OutputT>

@Internal
public static class DoFnInvoker.DelegatingArgumentProvider<InputT,OutputT>
extends DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

An DoFnInvoker.ArgumentProvider that forwards all calls to the supplied delegate.

Constructor Summary

Constructors

Constructor and Description
DelegatingArgumentProvider(DoFnInvoker.ArgumentProvider<InputT,OutputT> delegate, java.lang.String errorContext)

Method Summary

Modifier and Type	Method and Description
DoFn.BundleFinalizer	bundleFinalizer() Provide a DoFn.BundleFinalizer for being able to register a callback after the bundle has been successfully persisted by the runner.
InputT	element(DoFn<InputT,OutputT> doFn) Provide a reference to the input element.
DoFn.FinishBundleContext	finishBundleContext(DoFn<InputT,OutputT> doFn) Provide a DoFn.FinishBundleContext to use with the given DoFn.
java.lang.String	getErrorContext() Return a human readable representation of the current call context to be used during error reporting.
java.lang.Object	key() Provide a reference to the input element key in KV pair.
DoFn.OnTimerContext	onTimerContext(DoFn<InputT,OutputT> doFn) Provide a DoFn.OnTimerContext to use with the given DoFn.
DoFn.OutputReceiver<OutputT>	outputReceiver(DoFn<InputT,OutputT> doFn) Provide a DoFn.OutputReceiver for outputting to the default output.
DoFn.OutputReceiver<Row>	outputRowReceiver(DoFn<InputT,OutputT> doFn) Provide a DoFn.OutputReceiver for outputting rows to the default output.
PaneInfo	paneInfo(DoFn<InputT,OutputT> doFn) Provides a PaneInfo.
PipelineOptions	pipelineOptions() Provide PipelineOptions.
DoFn.ProcessContext	processContext(DoFn<InputT,OutputT> doFn) Provide a DoFn.ProcessContext to use with the given DoFn.
java.lang.Object	restriction() If this is a splittable DoFn, returns the associated restriction with the current call.
RestrictionTracker<?,?>	restrictionTracker() If this is a splittable DoFn, returns the associated RestrictionTracker with the current call.
java.lang.Object	schemaElement(int index) Provide a reference to the selected schema field corresponding to the input argument specified by index.
java.lang.Object	sideInput(java.lang.String tagId) Provide a reference to the input sideInput with the specified tag.
DoFn.StartBundleContext	startBundleContext(DoFn<InputT,OutputT> doFn) Provide a DoFn.StartBundleContext to use with the given DoFn.
State	state(java.lang.String stateId, boolean alwaysFetch) Returns the state cell for the given DoFn.StateId.
DoFn.MultiOutputReceiver	taggedOutputReceiver(DoFn<InputT,OutputT> doFn) Provide a DoFn.MultiOutputReceiver for outputting to the default output.
TimeDomain	timeDomain(DoFn<InputT,OutputT> doFn) Provide a reference to the time domain for a timer firing.
Timer	timer(java.lang.String timerId) Returns the timer for the given DoFn.TimerId.
TimerMap	timerFamily(java.lang.String timerFamilyId) Returns the timerMap for the given DoFn.TimerFamily.
java.lang.String	timerId(DoFn<InputT,OutputT> doFn) Returns the timer id for the current timer of a DoFn.TimerFamily.
org.joda.time.Instant	timestamp(DoFn<InputT,OutputT> doFn) Provide a reference to the input element timestamp.
WatermarkEstimator<?>	watermarkEstimator() If this is a splittable DoFn, returns the associated WatermarkEstimator with the current call.
java.lang.Object	watermarkEstimatorState() If this is a splittable DoFn, returns the associated watermark estimator state with the current call.
BoundedWindow	window() Construct the BoundedWindow to use within a DoFn that needs it.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingArgumentProvider

public DelegatingArgumentProvider(DoFnInvoker.ArgumentProvider<InputT,OutputT> delegate,
                                  java.lang.String errorContext)

Method Detail

window

public BoundedWindow window()

Description copied from interface: DoFnInvoker.ArgumentProvider

Construct the BoundedWindow to use within a DoFn that needs it. This is called if the DoFn.ProcessElement method has a parameter of type BoundedWindow.

Specified by:

window in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

window in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

Returns:

BoundedWindow of the element currently being processed.

paneInfo

public PaneInfo paneInfo(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provides a PaneInfo.

Specified by:

paneInfo in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

paneInfo in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

pipelineOptions

public PipelineOptions pipelineOptions()

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide PipelineOptions.

Specified by:

pipelineOptions in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

pipelineOptions in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

startBundleContext

public DoFn.StartBundleContext startBundleContext(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a DoFn.StartBundleContext to use with the given DoFn.

Specified by:

startBundleContext in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

startBundleContext in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

finishBundleContext

public DoFn.FinishBundleContext finishBundleContext(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a DoFn.FinishBundleContext to use with the given DoFn.

Specified by:

finishBundleContext in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

finishBundleContext in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

processContext

public DoFn.ProcessContext processContext(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a DoFn.ProcessContext to use with the given DoFn.

Specified by:

processContext in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

processContext in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

onTimerContext

public DoFn.OnTimerContext onTimerContext(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a DoFn.OnTimerContext to use with the given DoFn.

Specified by:

onTimerContext in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

onTimerContext in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

element

public InputT element(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a reference to the input element.

Specified by:

element in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

element in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

key

public java.lang.Object key()

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a reference to the input element key in KV pair.

Specified by:

key in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

key in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

sideInput

public java.lang.Object sideInput(java.lang.String tagId)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a reference to the input sideInput with the specified tag.

Specified by:

sideInput in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

sideInput in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

schemaElement

public java.lang.Object schemaElement(int index)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a reference to the selected schema field corresponding to the input argument specified by index.

Specified by:

schemaElement in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

schemaElement in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

timestamp

public org.joda.time.Instant timestamp(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a reference to the input element timestamp.

Specified by:

timestamp in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

timestamp in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

timeDomain

public TimeDomain timeDomain(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a reference to the time domain for a timer firing.

Specified by:

timeDomain in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

timeDomain in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

outputReceiver

public DoFn.OutputReceiver<OutputT> outputReceiver(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a DoFn.OutputReceiver for outputting to the default output.

Specified by:

outputReceiver in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

outputReceiver in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

outputRowReceiver

public DoFn.OutputReceiver<Row> outputRowReceiver(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a DoFn.OutputReceiver for outputting rows to the default output.

Specified by:

outputRowReceiver in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

outputRowReceiver in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

taggedOutputReceiver

public DoFn.MultiOutputReceiver taggedOutputReceiver(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a DoFn.MultiOutputReceiver for outputting to the default output.

Specified by:

taggedOutputReceiver in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

taggedOutputReceiver in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

restriction

public java.lang.Object restriction()

Description copied from interface: DoFnInvoker.ArgumentProvider

If this is a splittable DoFn, returns the associated restriction with the current call.

Specified by:

restriction in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

restriction in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

restrictionTracker

public RestrictionTracker<?,?> restrictionTracker()

Description copied from interface: DoFnInvoker.ArgumentProvider

If this is a splittable DoFn, returns the associated RestrictionTracker with the current call.

Specified by:

restrictionTracker in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

restrictionTracker in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

watermarkEstimatorState

public java.lang.Object watermarkEstimatorState()

Description copied from interface: DoFnInvoker.ArgumentProvider

If this is a splittable DoFn, returns the associated watermark estimator state with the current call.

Specified by:

watermarkEstimatorState in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

watermarkEstimatorState in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

watermarkEstimator

public WatermarkEstimator<?> watermarkEstimator()

Description copied from interface: DoFnInvoker.ArgumentProvider

If this is a splittable DoFn, returns the associated WatermarkEstimator with the current call.

Specified by:

watermarkEstimator in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

watermarkEstimator in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

state

public State state(java.lang.String stateId,
                   boolean alwaysFetch)

Description copied from interface: DoFnInvoker.ArgumentProvider

Returns the state cell for the given DoFn.StateId.

Specified by:

state in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

state in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

timer

public Timer timer(java.lang.String timerId)

Description copied from interface: DoFnInvoker.ArgumentProvider

Returns the timer for the given DoFn.TimerId.

Specified by:

timer in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

timer in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

timerFamily

public TimerMap timerFamily(java.lang.String timerFamilyId)

Description copied from interface: DoFnInvoker.ArgumentProvider

Returns the timerMap for the given DoFn.TimerFamily.

Specified by:

timerFamily in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

timerFamily in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

timerId

public java.lang.String timerId(DoFn<InputT,OutputT> doFn)

Description copied from interface: DoFnInvoker.ArgumentProvider

Returns the timer id for the current timer of a DoFn.TimerFamily.

Specified by:

timerId in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

timerId in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

bundleFinalizer

public DoFn.BundleFinalizer bundleFinalizer()

Description copied from interface: DoFnInvoker.ArgumentProvider

Provide a DoFn.BundleFinalizer for being able to register a callback after the bundle has been successfully persisted by the runner.

Specified by:

bundleFinalizer in interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Overrides:

bundleFinalizer in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>

getErrorContext

public java.lang.String getErrorContext()

Description copied from class: DoFnInvoker.BaseArgumentProvider

Return a human readable representation of the current call context to be used during error reporting.

Specified by:

getErrorContext in class DoFnInvoker.BaseArgumentProvider<InputT,OutputT>