BeamFnDataGrpcClient (beam-sdks-java-harness 2.10.0 API)

java.lang.Object
- org.apache.beam.fn.harness.data.BeamFnDataGrpcClient

All Implemented Interfaces:

BeamFnDataClient
```
public class BeamFnDataGrpcClient
extends java.lang.Object
implements BeamFnDataClient
```
A BeamFnDataClient that uses gRPC for sending and receiving data.
TODO: Handle closing clients that are currently not a consumer nor are being consumed.

Constructor Summary

Constructors
Constructor and Description
`BeamFnDataGrpcClient(org.apache.beam.sdk.options.PipelineOptions options, java.util.function.Function<org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor,org.apache.beam.vendor.grpc.v1p13p1.io.grpc.ManagedChannel> channelFactory, org.apache.beam.sdk.fn.stream.OutboundObserverFactory outboundObserverFactory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> org.apache.beam.sdk.fn.data.InboundDataClient`	`receive(org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor apiServiceDescriptor, org.apache.beam.sdk.fn.data.LogicalEndpoint inputLocation, org.apache.beam.sdk.coders.Coder<org.apache.beam.sdk.util.WindowedValue<T>> coder, org.apache.beam.sdk.fn.data.FnDataReceiver<org.apache.beam.sdk.util.WindowedValue<T>> consumer)` Registers the following inbound stream consumer for the provided instruction id and target.
`<T> org.apache.beam.sdk.fn.data.CloseableFnDataReceiver<org.apache.beam.sdk.util.WindowedValue<T>>`	`send(org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor apiServiceDescriptor, org.apache.beam.sdk.fn.data.LogicalEndpoint outputLocation, org.apache.beam.sdk.coders.Coder<org.apache.beam.sdk.util.WindowedValue<T>> coder)` Creates a closeable consumer using the provided instruction id and target.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BeamFnDataGrpcClient

public BeamFnDataGrpcClient(org.apache.beam.sdk.options.PipelineOptions options,
                            java.util.function.Function<org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor,org.apache.beam.vendor.grpc.v1p13p1.io.grpc.ManagedChannel> channelFactory,
                            org.apache.beam.sdk.fn.stream.OutboundObserverFactory outboundObserverFactory)

Method Detail

receive

public <T> org.apache.beam.sdk.fn.data.InboundDataClient receive(org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor apiServiceDescriptor,
                                                                 org.apache.beam.sdk.fn.data.LogicalEndpoint inputLocation,
                                                                 org.apache.beam.sdk.coders.Coder<org.apache.beam.sdk.util.WindowedValue<T>> coder,
                                                                 org.apache.beam.sdk.fn.data.FnDataReceiver<org.apache.beam.sdk.util.WindowedValue<T>> consumer)

Registers the following inbound stream consumer for the provided instruction id and target.

The provided coder is used to decode elements on the inbound stream. The decoded elements are passed to the provided consumer. Any failure during decoding or processing of the element will complete the returned future exceptionally. On successful termination of the stream (signaled by an empty data block), the returned future is completed successfully.

Specified by:: receive in interface BeamFnDataClient

send

public <T> org.apache.beam.sdk.fn.data.CloseableFnDataReceiver<org.apache.beam.sdk.util.WindowedValue<T>> send(org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor apiServiceDescriptor,
                                                                                                               org.apache.beam.sdk.fn.data.LogicalEndpoint outputLocation,
                                                                                                               org.apache.beam.sdk.coders.Coder<org.apache.beam.sdk.util.WindowedValue<T>> coder)

Creates a closeable consumer using the provided instruction id and target.

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

On closing the returned consumer, an empty data block is sent as a signal of the logical data stream finishing.

The returned closeable consumer is not thread safe.

Specified by:: send in interface BeamFnDataClient

Class BeamFnDataGrpcClient