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

Class SdkHarnessClient

java.lang.Object

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

All Implemented Interfaces:

AutoCloseable

public class SdkHarnessClient
extends Object
implements AutoCloseable

A high-level client for an SDK harness.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SdkHarnessClient.BundleProcessor	A processor capable of creating bundles for some registered BeamFnApi.ProcessBundleDescriptor.

Method Summary

Modifier and Type	Method	Description
void	close()
InstructionRequestHandler	getInstructionRequestHandler()
SdkHarnessClient.BundleProcessor	getProcessor(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor descriptor, List<RemoteInputDestination> remoteInputDesinations)	Provides SdkHarnessClient.BundleProcessor that is capable of processing bundles not containing timers or state accesses such as: Side inputs User state Remote references
SdkHarnessClient.BundleProcessor	getProcessor(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor descriptor, List<RemoteInputDestination> remoteInputDesinations, StateDelegator stateDelegator)	Provides SdkHarnessClient.BundleProcessor that is capable of processing bundles not containing timers.
SdkHarnessClient.BundleProcessor	getProcessor(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor descriptor, List<RemoteInputDestination> remoteInputDestinations, StateDelegator stateDelegator, Map<String,Map<String,ProcessBundleDescriptors.TimerSpec>> timerSpecs)	Provides SdkHarnessClient.BundleProcessor that is capable of processing bundles containing timers and state accesses such as: Side inputs User state Remote references
static SdkHarnessClient	usingFnApiClient(InstructionRequestHandler fnApiControlClient, FnDataService fnApiDataService)	Creates a client for a particular SDK harness.
SdkHarnessClient	withIdGenerator(IdGenerator idGenerator)

Methods inherited from class java.lang.Object

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

Method Details

getInstructionRequestHandler

public InstructionRequestHandler getInstructionRequestHandler()

usingFnApiClient

public static SdkHarnessClient usingFnApiClient(InstructionRequestHandler fnApiControlClient,
 FnDataService fnApiDataService)

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(IdGenerator idGenerator)

getProcessor

public SdkHarnessClient.BundleProcessor getProcessor(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor descriptor,
 List<RemoteInputDestination> remoteInputDesinations)

Provides SdkHarnessClient.BundleProcessor that is capable of processing bundles not containing timers or state accesses such as:

• Side inputs
• User state
• Remote references

Note that bundle processors are cached based upon the process bundle descriptor id. A previously created instance may be returned.

getProcessor

public SdkHarnessClient.BundleProcessor getProcessor(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor descriptor,
 List<RemoteInputDestination> remoteInputDesinations,
 StateDelegator stateDelegator)

Provides SdkHarnessClient.BundleProcessor that is capable of processing bundles not containing timers.

Note that bundle processors are cached based upon the process bundle descriptor id. A previously created instance may be returned.

getProcessor

public SdkHarnessClient.BundleProcessor getProcessor(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor descriptor,
 List<RemoteInputDestination> remoteInputDestinations,
 StateDelegator stateDelegator,
 Map<String,Map<String,ProcessBundleDescriptors.TimerSpec>> timerSpecs)

Provides SdkHarnessClient.BundleProcessor that is capable of processing bundles containing timers and state accesses such as:

• Side inputs
• User state
• Remote references

Note that bundle processors are cached based upon the process bundle descriptor id. A previously created instance may be returned.

close

public void close()

Specified by:

close in interface AutoCloseable