org.apache.beam.runners.fnexecution.splittabledofn

Class SDFFeederViaStateAndTimers<InputT,RestrictionT>

java.lang.Object

org.apache.beam.runners.fnexecution.splittabledofn.SDFFeederViaStateAndTimers<InputT,RestrictionT>

public class SDFFeederViaStateAndTimers<InputT,RestrictionT>
extends java.lang.Object

Helper class for feeding element/restricton pairs into a PTransformTranslation.SPLITTABLE_PROCESS_ELEMENTS_URN transform, implementing checkpointing only, by using state and timers for storing the last element/restriction pair, similarly to SplittableParDoViaKeyedWorkItems.ProcessFn but in a portable fashion.

Constructor Summary

Constructors

Constructor and Description
SDFFeederViaStateAndTimers(org.apache.beam.runners.core.StateInternals stateInternals, org.apache.beam.runners.core.TimerInternals timerInternals, Coder<InputT> elementWireCoder, Coder<RestrictionT> restrictionWireCoder, Coder<BoundedWindow> windowCoder) Initializes the feeder.

Method Summary

Modifier and Type	Method and Description
void	commit() Commits the state and timers: clears both if no checkpoint happened, or adjusts the restriction and sets a wake-up timer if a checkpoint happened.
org.apache.beam.sdk.util.WindowedValue<KV<InputT,RestrictionT>>	resume(org.apache.beam.runners.core.TimerInternals.TimerData timer) Resumes from a timer and returns the current element/restriction pair (with an up-to-date value of the restriction).
void	seed(org.apache.beam.sdk.util.WindowedValue<KV<InputT,RestrictionT>> elementRestriction) Passes the initial element/restriction pair.
void	split(java.util.List<org.apache.beam.model.fnexecution.v1.BeamFnApi.BundleApplication> primaryRoots, java.util.List<org.apache.beam.model.fnexecution.v1.BeamFnApi.DelayedBundleApplication> residualRoots) Signals that a split happened.

Methods inherited from class java.lang.Object

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

Constructor Detail

SDFFeederViaStateAndTimers

public SDFFeederViaStateAndTimers(org.apache.beam.runners.core.StateInternals stateInternals,
                                  org.apache.beam.runners.core.TimerInternals timerInternals,
                                  Coder<InputT> elementWireCoder,
                                  Coder<RestrictionT> restrictionWireCoder,
                                  Coder<BoundedWindow> windowCoder)

Initializes the feeder.

Method Detail

seed

public void seed(org.apache.beam.sdk.util.WindowedValue<KV<InputT,RestrictionT>> elementRestriction)

Passes the initial element/restriction pair.

resume

public org.apache.beam.sdk.util.WindowedValue<KV<InputT,RestrictionT>> resume(org.apache.beam.runners.core.TimerInternals.TimerData timer)

Resumes from a timer and returns the current element/restriction pair (with an up-to-date value of the restriction).

commit

public void commit()
            throws java.io.IOException

Commits the state and timers: clears both if no checkpoint happened, or adjusts the restriction and sets a wake-up timer if a checkpoint happened.

Throws:

java.io.IOException

split

public void split(java.util.List<org.apache.beam.model.fnexecution.v1.BeamFnApi.BundleApplication> primaryRoots,
                  java.util.List<org.apache.beam.model.fnexecution.v1.BeamFnApi.DelayedBundleApplication> residualRoots)

Signals that a split happened.