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 returnsBeamFnApi.DelayedBundleApplication
s 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 ofInstructionRequestHandlers
.ControlClientPool.Sink A sink forInstructionRequestHandlers
keyed by worker id.ControlClientPool.Source A source ofInstructionRequestHandlers
.ExecutableStageContext The context required in order to executestages
.ExecutableStageContext.Factory CreatesExecutableStageContext
instances.InstructionRequestHandler Interface for any function that can handle a Fn APIBeamFnApi.InstructionRequest
.JobBundleFactory A factory that has all job-scoped information, and can be combined with stage-scoped information to create aStageBundleFactory
.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 abundle descriptor
by forwarding them to a remote environment for processing.StageBundleFactory A bundle factory scoped to a particularExecutableStage
, which has all of the resources it needs to provide newRemoteBundles
. -
Class Summary Class Description BundleCheckpointHandlers Utility methods for creatingBundleCheckpointHandler
s.BundleCheckpointHandlers.StateAndTimerBundleCheckpointHandler<T> ABundleCheckpointHandler
which usesTimerInternals.TimerData
andValueState
to rescheduleBeamFnApi.DelayedBundleApplication
.BundleFinalizationHandlers Utility methods for creatingBundleFinalizationHandler
s.BundleFinalizationHandlers.InMemoryFinalizer DefaultExecutableStageContext Implementation of aExecutableStageContext
.DefaultJobBundleFactory AJobBundleFactory
for which the implementation can specify a customEnvironmentFactory
for environment management.DefaultJobBundleFactory.ServerInfo A container for EnvironmentFactory and its corresponding Grpc servers.DefaultJobBundleFactory.WrappedSdkHarnessClient Holder for anSdkHarnessClient
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 AControlClientPool
backed by a client map.ProcessBundleDescriptors Utility methods for creatingBeamFnApi.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 windowCoder
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 windowCoder
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 ofCoder
andFnDataReceiver
which can be registered to receive elements for aLogicalEndpoint
.SdkHarnessClient A high-level client for an SDK harness.SingleEnvironmentInstanceJobBundleFactory Deprecated. replace with aDefaultJobBundleFactory
when appropriate if theEnvironmentFactory
is aDockerEnvironmentFactory
, or create anInProcessJobBundleFactory
and inline the creation of the environment if appropriate.TimerReceiverFactory A factory that passes timers toTimerReceiverFactory.timerDataConsumer
.