SdkHarnessClient

java.lang.Object
- org.apache.beam.runners.fnexecution.control.SdkHarnessClient

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class SdkHarnessClient
extends java.lang.Object
implements java.lang.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 and Description
`static class`	`SdkHarnessClient.ActiveBundle<InputT>` An active bundle for a particular `BeamFnApi.ProcessBundleDescriptor`.
`class`	`SdkHarnessClient.BundleProcessor<T>` 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`<T> SdkHarnessClient.BundleProcessor<T>`	`getProcessor(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor descriptor, SdkHarnessClient.RemoteInputDestination<org.apache.beam.sdk.util.WindowedValue<T>> remoteInputDesination)`
`java.util.Map<java.lang.String,SdkHarnessClient.BundleProcessor>`	`register(java.util.Map<org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor,SdkHarnessClient.RemoteInputDestination<org.apache.beam.sdk.util.WindowedValue<?>>> processBundleDescriptors)` Registers a `BeamFnApi.ProcessBundleDescriptor` for future processing.
`static SdkHarnessClient`	`usingFnApiClient(InstructionRequestHandler fnApiControlClient, FnDataService fnApiDataService)` 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(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(SdkHarnessClient.IdGenerator idGenerator)

getProcessor

public <T> SdkHarnessClient.BundleProcessor<T> getProcessor(org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor descriptor,
                                                            SdkHarnessClient.RemoteInputDestination<org.apache.beam.sdk.util.WindowedValue<T>> remoteInputDesination)

register

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

Registers a BeamFnApi.ProcessBundleDescriptor for future processing.

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

close
```
public void close()
           throws java.lang.Exception
```
Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

Class SdkHarnessClient