org.apache.beam.fn.harness.data

Interface BeamFnDataClient

All Known Implementing Classes:

BeamFnDataGrpcClient, QueueingBeamFnDataClient

public interface BeamFnDataClient

The BeamFnDataClient is able to forward inbound elements to a FnDataReceiver and provide a receiver of outbound elements. Callers can register themselves as receivers for inbound elements or can get a handle for a receiver of outbound elements.

Method Summary

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>> receiver) Registers the following inbound receiver 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 CloseableFnDataReceiver using the provided instruction id and target.

Method Detail

receive

<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>> receiver)

Registers the following inbound receiver for the provided instruction id and target.

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 complete the returned future exceptionally. On successful termination of the stream, the returned future is completed successfully.

The receiver is not required to be thread safe.

send

<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 CloseableFnDataReceiver using the provided instruction id and target.

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

Closing the returned receiver signals the end of the stream.

The returned closeable receiver is not thread safe.