org.apache.beam.runners.fnexecution.data

Class GrpcDataService

java.lang.Object

org.apache.beam.model.fnexecution.v1.BeamFnDataGrpc.BeamFnDataImplBase

org.apache.beam.runners.fnexecution.data.GrpcDataService

All Implemented Interfaces:

java.lang.AutoCloseable, FnDataService, FnService, org.apache.beam.vendor.grpc.v1p21p0.io.grpc.BindableService

public class GrpcDataService
extends org.apache.beam.model.fnexecution.v1.BeamFnDataGrpc.BeamFnDataImplBase
implements FnService, FnDataService

A FnDataService implemented via gRPC.

This service allows for multiple clients to transmit BeamFnApi.Elements messages.

This service transmits all outgoing BeamFnApi.Elements messages to the first client that connects.

Constructor Summary

Constructors

Constructor and Description
GrpcDataService() Deprecated. This constructor is for migrating Dataflow purpose only.

Method Summary

Modifier and Type	Method and Description
void	close() .
static GrpcDataService	create(java.util.concurrent.ExecutorService executor, OutboundObserverFactory outboundObserverFactory)
org.apache.beam.vendor.grpc.v1p21p0.io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements>	data(org.apache.beam.vendor.grpc.v1p21p0.io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> outboundElementObserver)
<T> InboundDataClient	receive(LogicalEndpoint inputLocation, Coder<T> coder, FnDataReceiver<T> listener) Registers a receiver to be notified upon any incoming elements.
<T> CloseableFnDataReceiver<T>	send(LogicalEndpoint outputLocation, Coder<T> coder) Creates a receiver to which you can write data values and have them sent over this data plane service.

Methods inherited from class org.apache.beam.model.fnexecution.v1.BeamFnDataGrpc.BeamFnDataImplBase

bindService

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.beam.vendor.grpc.v1p21p0.io.grpc.BindableService

bindService

Constructor Detail

GrpcDataService

@Deprecated
public GrpcDataService()

Deprecated. This constructor is for migrating Dataflow purpose only.

Method Detail

create

public static GrpcDataService create(java.util.concurrent.ExecutorService executor,
                                     OutboundObserverFactory outboundObserverFactory)

data

public org.apache.beam.vendor.grpc.v1p21p0.io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> data(org.apache.beam.vendor.grpc.v1p21p0.io.grpc.stub.StreamObserver<org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> outboundElementObserver)

Overrides:

data in class org.apache.beam.model.fnexecution.v1.BeamFnDataGrpc.BeamFnDataImplBase

close

public void close()
           throws java.lang.Exception

Description copied from interface: FnService

.

There should be no more calls to any service method by the time a call to FnService.close() begins. Specifically, this means that a Server that this service is bound to should have completed a call to the Server.shutdown() method, and all future incoming calls will be rejected.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface FnService

Throws:

java.lang.Exception

receive

public <T> InboundDataClient receive(LogicalEndpoint inputLocation,
                                     Coder<T> coder,
                                     FnDataReceiver<T> listener)

Description copied from interface: FnDataService

Registers a receiver to be notified upon any incoming elements.

The provided coder is used to decode inbound elements. The decoded elements are passed to the provided receiver.

Any failure during decoding or processing of the element will put the InboundDataClient into an error state such that InboundDataClient.awaitCompletion() will throw an exception.

The provided receiver is not required to be thread safe.

Specified by:

receive in interface FnDataService

send

public <T> CloseableFnDataReceiver<T> send(LogicalEndpoint outputLocation,
                                           Coder<T> coder)

Description copied from interface: FnDataService

Creates a receiver to which you can write data values and have them sent over this data plane service.

The provided coder is used to encode elements on the outbound stream.

Closing the returned receiver signals the end of the stream.

The returned receiver is not thread safe.

Specified by:

send in interface FnDataService