DoFnInvoker.ArgumentProvider (core 2.23.0 API)

All Known Implementing Classes:

DoFnInvoker.BaseArgumentProvider, DoFnInvoker.DelegatingArgumentProvider, DoFnInvoker.FakeArgumentProvider

Enclosing interface:

DoFnInvoker<InputT,OutputT>
```
@Internal
public static interface DoFnInvoker.ArgumentProvider<InputT,OutputT>
```
Interface for runner implementors to provide implementations of extra context information.
The methods on this interface are called by DoFnInvoker before invoking an annotated DoFn.StartBundle, DoFn.ProcessElement or DoFn.FinishBundle method that has indicated it needs the given extra context.
In the case of DoFn.ProcessElement it is called once per invocation of DoFn.ProcessElement.

Method Summary

All Methods Instance Methods Abstract Methods
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.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 alwaysFetched)` 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 tagId)` 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.

- Method Detail
  - window
```
BoundedWindow window()
```
    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.
    
    Returns:
    
    BoundedWindow of the element currently being processed.
  - paneInfo
```
PaneInfo paneInfo(DoFn<InputT,OutputT> doFn)
```
    Provides a PaneInfo.
  - pipelineOptions
```
PipelineOptions pipelineOptions()
```
    Provide PipelineOptions.
  - startBundleContext
```
DoFn.StartBundleContext startBundleContext(DoFn<InputT,OutputT> doFn)
```
    Provide a DoFn.StartBundleContext to use with the given DoFn.
  - finishBundleContext
```
DoFn.FinishBundleContext finishBundleContext(DoFn<InputT,OutputT> doFn)
```
    Provide a DoFn.FinishBundleContext to use with the given DoFn.
  - processContext
```
DoFn.ProcessContext processContext(DoFn<InputT,OutputT> doFn)
```
    Provide a DoFn.ProcessContext to use with the given DoFn.
  - onTimerContext
```
DoFn.OnTimerContext onTimerContext(DoFn<InputT,OutputT> doFn)
```
    Provide a DoFn.OnTimerContext to use with the given DoFn.
  - element
```
InputT element(DoFn<InputT,OutputT> doFn)
```
    Provide a reference to the input element.
  - key
```
java.lang.Object key()
```
    Provide a reference to the input element key in KV pair.
  - sideInput
```
java.lang.Object sideInput(java.lang.String tagId)
```
    Provide a reference to the input sideInput with the specified tag.
  - schemaElement
```
java.lang.Object schemaElement(int index)
```
    Provide a reference to the selected schema field corresponding to the input argument specified by index.
  - timestamp
```
org.joda.time.Instant timestamp(DoFn<InputT,OutputT> doFn)
```
    Provide a reference to the input element timestamp.
  - timeDomain
```
TimeDomain timeDomain(DoFn<InputT,OutputT> doFn)
```
    Provide a reference to the time domain for a timer firing.
  - outputReceiver
```
DoFn.OutputReceiver<OutputT> outputReceiver(DoFn<InputT,OutputT> doFn)
```
    Provide a DoFn.OutputReceiver for outputting to the default output.
  - outputRowReceiver
```
DoFn.OutputReceiver<Row> outputRowReceiver(DoFn<InputT,OutputT> doFn)
```
    Provide a DoFn.OutputReceiver for outputting rows to the default output.
  - taggedOutputReceiver
```
DoFn.MultiOutputReceiver taggedOutputReceiver(DoFn<InputT,OutputT> doFn)
```
    Provide a DoFn.MultiOutputReceiver for outputting to the default output.
  - bundleFinalizer
```
DoFn.BundleFinalizer bundleFinalizer()
```
    Provide a DoFn.BundleFinalizer for being able to register a callback after the bundle has been successfully persisted by the runner.
  - restriction
```
java.lang.Object restriction()
```
    If this is a splittable DoFn, returns the associated restriction with the current call.
  - restrictionTracker
```
RestrictionTracker<?,?> restrictionTracker()
```
    If this is a splittable DoFn, returns the associated RestrictionTracker with the current call.
  - watermarkEstimatorState
```
java.lang.Object watermarkEstimatorState()
```
    If this is a splittable DoFn, returns the associated watermark estimator state with the current call.
  - watermarkEstimator
```
WatermarkEstimator<?> watermarkEstimator()
```
    If this is a splittable DoFn, returns the associated WatermarkEstimator with the current call.
  - state
```
State state(java.lang.String stateId,
            boolean alwaysFetched)
```
    Returns the state cell for the given DoFn.StateId.
  - timer
```
Timer timer(java.lang.String timerId)
```
    Returns the timer for the given DoFn.TimerId.
  - timerFamily
```
TimerMap timerFamily(java.lang.String tagId)
```
    Returns the timerMap for the given DoFn.TimerFamily.
  - timerId
```
java.lang.String timerId(DoFn<InputT,OutputT> doFn)
```
    Returns the timer id for the current timer of a DoFn.TimerFamily.

Interface DoFnInvoker.ArgumentProvider<InputT,OutputT>

Method Summary

Method Detail

window

paneInfo

pipelineOptions

startBundleContext

finishBundleContext

processContext

onTimerContext

element

key

sideInput

schemaElement

timestamp

timeDomain

outputReceiver

outputRowReceiver

taggedOutputReceiver

bundleFinalizer

restriction

restrictionTracker

watermarkEstimatorState

watermarkEstimator

state

timer

timerFamily

timerId