org.apache.beam.runners.fnexecution.control

Class SdkHarnessClient

java.lang.Object

org.apache.beam.runners.fnexecution.control.SdkHarnessClient

public class SdkHarnessClient
extends java.lang.Object

A high-level client for an SDK harness.

This provides a Java-friendly wrapper around FnApiControlClient and CloseableFnDataReceiver, which handle lower-level gRPC message wrangling.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SdkHarnessClient.ActiveBundle<InputT> An active bundle for a particular BeamFnApi.ProcessBundleDescriptor.
class	SdkHarnessClient.BundleProcessor A processor capable of creating bundles for some registered BeamFnApi.ProcessBundleDescriptor.
static interface	SdkHarnessClient.IdGenerator A supply of unique identifiers, used internally.
static class	SdkHarnessClient.RemoteInputDestination<T> A pair of Coder and BeamFnApi.Target which can be handled by the remote SDK harness to receive elements sent from the runner.
static class	SdkHarnessClient.RemoteOutputReceiver<T> A pair of Coder and FnDataReceiver which can be registered to receive elements for a LogicalEndpoint.

Method Summary

Modifier and Type	Method and Description
SdkHarnessClient.BundleProcessor	getProcessor(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor descriptor)
java.util.Map<java.lang.String,SdkHarnessClient.BundleProcessor>	register(java.lang.Iterable<org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor> processBundleDescriptors) Registers a BeamFnApi.ProcessBundleDescriptor for future processing.
static SdkHarnessClient	usingFnApiClient(org.apache.beam.runners.fnexecution.control.FnApiControlClient fnApiControlClient) Creates a client for a particular SDK harness.
SdkHarnessClient	withIdGenerator(SdkHarnessClient.IdGenerator idGenerator)

Methods inherited from class java.lang.Object

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

Method Detail

usingFnApiClient

public static SdkHarnessClient usingFnApiClient(org.apache.beam.runners.fnexecution.control.FnApiControlClient fnApiControlClient)

Creates a client for a particular SDK harness. It is the responsibility of the caller to ensure that these correspond to the same SDK harness, so control plane and data plane messages can be correctly associated.

withIdGenerator

public SdkHarnessClient withIdGenerator(SdkHarnessClient.IdGenerator idGenerator)

getProcessor

public SdkHarnessClient.BundleProcessor getProcessor(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor descriptor)

register

public java.util.Map<java.lang.String,SdkHarnessClient.BundleProcessor> register(java.lang.Iterable<org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor> processBundleDescriptors)

Registers a BeamFnApi.ProcessBundleDescriptor for future processing.

A client may block on the result future, but may also proceed without blocking.