Package org.apache.beam.runners.fnexecution.control

Utilities for a Beam runner to interact with the Fn API Control Service via java abstractions.

Interface Summary

Interface	Description
BundleCheckpointHandler	A handler which is invoked when the SDK returns BeamFnApi.DelayedBundleApplications as part of the bundle completion.
BundleFinalizationHandler	A handler for the runner when a finalization request has been received.
BundleProgressHandler	A handler for bundle progress messages, both during bundle execution and on its completion.
BundleSplitHandler	A handler which is invoked whenever an active bundle is split.
ControlClientPool	A pool of control clients that brokers incoming SDK harness connections (in the form of InstructionRequestHandlers.
ControlClientPool.Sink	A sink for InstructionRequestHandlers keyed by worker id.
ControlClientPool.Source	A source of InstructionRequestHandlers.
ExecutableStageContext	The context required in order to execute stages.
ExecutableStageContext.Factory	Creates ExecutableStageContext instances.
InstructionRequestHandler	Interface for any function that can handle a Fn API BeamFnApi.InstructionRequest.
JobBundleFactory	A factory that has all job-scoped information, and can be combined with stage-scoped information to create a StageBundleFactory.
OutputReceiverFactory	A factory that can create output receivers during an executable stage.
ReferenceCountingExecutableStageContextFactory.Creator	Interface for creator which extends Serializable.
RemoteBundle	A bundle capable of handling input data elements for a bundle descriptor by forwarding them to a remote environment for processing.
StageBundleFactory	A bundle factory scoped to a particular ExecutableStage, which has all of the resources it needs to provide new RemoteBundles.

Class Summary

Class	Description
BundleCheckpointHandlers	Utility methods for creating BundleCheckpointHandlers.
BundleCheckpointHandlers.StateAndTimerBundleCheckpointHandler<T>	A BundleCheckpointHandler which uses TimerInternals.TimerData and ValueState to reschedule BeamFnApi.DelayedBundleApplication.
BundleFinalizationHandlers	Utility methods for creating BundleFinalizationHandlers.
BundleFinalizationHandlers.InMemoryFinalizer	See BundleFinalizationHandlers.inMemoryFinalizer(InstructionRequestHandler) for details.
DefaultExecutableStageContext	Implementation of a ExecutableStageContext.
DefaultJobBundleFactory	A JobBundleFactory for which the implementation can specify a custom EnvironmentFactory for environment management.
DefaultJobBundleFactory.ServerInfo	A container for EnvironmentFactory and its corresponding Grpc servers.
DefaultJobBundleFactory.WrappedSdkHarnessClient	Holder for an SdkHarnessClient along with its associated state and data servers.
FnApiControlClient	A client for the control plane of an SDK harness, which can issue requests to it over the Fn API.
FnApiControlClientPoolService	A Fn API control service which adds incoming SDK harness connections to a sink.
MapControlClientPool	A ControlClientPool backed by a client map.
ProcessBundleDescriptors	Utility methods for creating BeamFnApi.ProcessBundleDescriptor instances.
ProcessBundleDescriptors.BagUserStateSpec<K,V,W extends org.apache.beam.sdk.transforms.windowing.BoundedWindow>	A container type storing references to the key, value, and window Coder used when handling bag user state requests.
ProcessBundleDescriptors.ExecutableProcessBundleDescriptor
ProcessBundleDescriptors.SideInputSpec<T,W extends org.apache.beam.sdk.transforms.windowing.BoundedWindow>	A container type storing references to the value, and window Coder used when handling side input state requests.
ProcessBundleDescriptors.TimerSpec<K,V,W extends org.apache.beam.sdk.transforms.windowing.BoundedWindow>	A container type storing references to the key, timer and payload coders and the remote input destination used when handling timer requests.
ReferenceCountingExecutableStageContextFactory	ExecutableStageContext.Factory which counts ExecutableStageContext reference for book keeping.
RemoteOutputReceiver<T>	A pair of Coder and FnDataReceiver which can be registered to receive elements for a LogicalEndpoint.
SdkHarnessClient	A high-level client for an SDK harness.
SingleEnvironmentInstanceJobBundleFactory	Deprecated. replace with a DefaultJobBundleFactory when appropriate if the EnvironmentFactory is a DockerEnvironmentFactory, or create an InProcessJobBundleFactory and inline the creation of the environment if appropriate.
TimerReceiverFactory	A factory that passes timers to TimerReceiverFactory.timerDataConsumer.