org.apache.beam.fn.harness.control

Class BeamFnControlClient

java.lang.Object

org.apache.beam.fn.harness.control.BeamFnControlClient

public class BeamFnControlClient
extends java.lang.Object

A client for the Beam Fn Control API. Uses an unbounded internal queue to pull down an unbounded number of requests.

Also can delegate to a set of handlers based upon the request type.

When the inbound instruction stream finishes successfully, the onFinish is completed successfully signaling to the caller that this client will not produce any more BeamFnApi.InstructionRequests. If the inbound instruction stream errors, the onFinish is completed exceptionally propagating the failure reason to the caller and signaling that this client will not produce any more BeamFnApi.InstructionRequests.

Constructor Summary

Constructors

Constructor and Description

BeamFnControlClient(java.lang.String id, org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor apiServiceDescriptor, org.apache.beam.sdk.fn.channel.ManagedChannelFactory channelFactory, org.apache.beam.sdk.fn.stream.OutboundObserverFactory outboundObserverFactory, java.util.EnumMap<org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionRequest.RequestCase,org.apache.beam.sdk.fn.function.ThrowingFunction<org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionRequest,org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionResponse.Builder>> handlers)

Method Summary

Modifier and Type	Method and Description
org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionResponse	delegateOnInstructionRequestType(org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionRequest value)
void	processInstructionRequests(java.util.concurrent.Executor executor) Note that this method continuously submits work to the supplied executor until the Beam Fn Control server hangs up or fails exceptionally.
void	sendInstructionResponse(org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionResponse value)

Methods inherited from class java.lang.Object

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

Constructor Detail

BeamFnControlClient

public BeamFnControlClient(java.lang.String id,
                           org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor apiServiceDescriptor,
                           org.apache.beam.sdk.fn.channel.ManagedChannelFactory channelFactory,
                           org.apache.beam.sdk.fn.stream.OutboundObserverFactory outboundObserverFactory,
                           java.util.EnumMap<org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionRequest.RequestCase,org.apache.beam.sdk.fn.function.ThrowingFunction<org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionRequest,org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionResponse.Builder>> handlers)

Method Detail

processInstructionRequests

public void processInstructionRequests(java.util.concurrent.Executor executor)
                                throws java.lang.InterruptedException,
                                       java.util.concurrent.ExecutionException

Note that this method continuously submits work to the supplied executor until the Beam Fn Control server hangs up or fails exceptionally.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

delegateOnInstructionRequestType

public org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionResponse delegateOnInstructionRequestType(org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionRequest value)

sendInstructionResponse

public void sendInstructionResponse(org.apache.beam.model.fnexecution.v1.BeamFnApi.InstructionResponse value)