Package org.apache.beam.fn.harness

Top level package for Beam Java Fn Harness.

Interface Summary

Interface	Description
Cache<K,V>	A cache allows for the storage and retrieval of values which are associated with keys.
Cache.Shrinkable<V>	An interface that marks an object that can be reduced in size instead of being evicted completely.
HandlesSplits	An interface that may be used to extend a FnDataReceiver signalling that the downstream runner is capable of performing splitting and providing progress reporting.
MapFnRunners.ValueMapFnFactory<InputT,OutputT>	A function factory which given a PTransform returns a map function.
MapFnRunners.WindowedValueMapFnFactory<InputT,OutputT>	A function factory which given a PTransform returns a map function over the entire WindowedValue of input and output elements.
PrecombineGroupingTable.SizeEstimator	Provides client-specific operations for size estimates.
PTransformRunnerFactory	A factory able to instantiate an appropriate handler for a given PTransform.
PTransformRunnerFactory.Context	A context used to instantiate and support the handler necessary to execute the PTransform.
PTransformRunnerFactory.Registrar	A registrar which can return a mapping from RunnerApi.FunctionSpec.getUrn() to a factory capable of instantiating an appropriate handler.

Class Summary

Class	Description
BeamFnDataReadRunner<OutputT>	Registers as a consumer for data over the Beam Fn API.
BeamFnDataReadRunner.Registrar	A registrar which provides a factory to handle reading from the Fn Api Data Plane.
BeamFnDataWriteRunner	Registers as a consumer with the Beam Fn Data Api.
BeamFnDataWriteRunner.Registrar	A registrar which provides a factory to handle writing to the Fn Api Data Plane.
Caches	Utility methods used to instantiate and operate over cache instances.
Caches.ClearableCache<K,V>	A cache that tracks keys that have been inserted into the cache and supports clearing them.
CombineRunners	Executes different components of Combine PTransforms.
CombineRunners.PrecombineFactory	A factory for CombineRunners.PrecombineRunners.
CombineRunners.Registrar	A registrar which provides a factory to handle combine component PTransforms.
ExternalWorkerService	Implements the BeamFnExternalWorkerPool service by starting a fresh SDK harness for each request.
FlattenRunner<InputT>	Executes flatten PTransforms.
FlattenRunner.Registrar	A registrar which provides a factory to handle flatten PTransforms.
FnApiDoFnRunner<InputT,RestrictionT,PositionT,WatermarkEstimatorStateT,OutputT>	A DoFnRunner specific to integrating with the Fn Api.
FnApiDoFnRunner.Registrar	A registrar which provides a factory to handle Java DoFns.
FnHarness	Main entry point into the Beam SDK Fn Harness for Java.
HandlesSplits.SplitResult
MapFnRunners	Utilities to create PTransformRunners which execute simple map functions.
PrecombineGroupingTable<K,InputT,AccumT>	Static utility methods that provide a grouping table implementation.
ProgressUtils	Miscellaneous methods for working with progress.
SplittablePairWithRestrictionDoFnRunner<InputT,RestrictionT,WatermarkEstimatorStateT,OutputT>	A runner for the PTransform step that invokes GetInitialRestriction and pairs it with the incoming element.
SplittablePairWithRestrictionDoFnRunner.Registrar	A registrar which provides a factory to handle Java DoFns.
SplittableSplitAndSizeRestrictionsDoFnRunner<InputT,RestrictionT extends @NonNull java.lang.Object,PositionT,WatermarkEstimatorStateT,OutputT>	A runner for the PTransform that takes restrictions and splits them, outputting
SplittableSplitAndSizeRestrictionsDoFnRunner.Registrar	A registrar which provides a factory to handle Java DoFns.
SplittableTruncateSizedRestrictionsDoFnRunner<InputT,RestrictionT extends @NonNull java.lang.Object,PositionT,WatermarkEstimatorStateT,OutputT>	A runner for the PTransform that truncates sized restrictions, for the case of draining a pipeline.
SplittableTruncateSizedRestrictionsDoFnRunner.Registrar	A registrar which provides a factory to handle Java DoFns.
ToStringFnRunner	Translates from elements to human-readable string.
ToStringFnRunner.Registrar	A registrar which provides a factory to handle translating elements to a human readable string.
WindowMappingFnRunner	Represents mapping of main input window onto side input window.
WindowMappingFnRunner.Registrar	A registrar which provides a factory to handle mapping main input windows onto side input windows.
WindowMergingFnRunner<T,W extends org.apache.beam.sdk.transforms.windowing.BoundedWindow>	Merges windows using a WindowFn.
WindowMergingFnRunner.Registrar	A registrar which provides a factory to handle merging windows based upon the WindowFn.