Package org.apache.beam.sdk.fn.server

Class GrpcFnServer<ServiceT extends FnService>

java.lang.Object

org.apache.beam.sdk.fn.server.GrpcFnServer<ServiceT>

All Implemented Interfaces:

AutoCloseable

public class GrpcFnServer<ServiceT extends FnService>
extends Object
implements AutoCloseable

A gRPC Server which manages a single FnService. The lifetime of the service is bound to the GrpcFnServer.

Method Summary

Modifier and Type	Method	Description
static List<GrpcFnServer<? extends FnService>>	allocatePortAndCreateFor(List<? extends FnService> services, ServerFactory factory)	Create GrpcFnServers for the provided FnServices running on an arbitrary port.
static <ServiceT extends FnService> GrpcFnServer<ServiceT>	allocatePortAndCreateFor(ServiceT service, ServerFactory factory)	Create a GrpcFnServer for the provided FnService running on an arbitrary port.
void	close()
static List<GrpcFnServer<? extends FnService>>	create(List<? extends FnService> services, org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor endpoint, ServerFactory factory)	Create GrpcFnServers for the provided FnServices running on a specified port.
static <ServiceT extends FnService> GrpcFnServer<ServiceT>	create(ServiceT service, org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor endpoint)	Deprecated. This create function is used for Dataflow migration purpose only.
static <ServiceT extends FnService> GrpcFnServer<ServiceT>	create(ServiceT service, org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor endpoint, ServerFactory factory)	Create a GrpcFnServer for the provided FnService which will run at the endpoint specified in the Endpoints.ApiServiceDescriptor.
org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor	getApiServiceDescriptor()	Get an Endpoints.ApiServiceDescriptor describing the endpoint this GrpcFnServer is bound to.
org.apache.beam.vendor.grpc.v1p69p0.io.grpc.Server	getServer()	Get the underlying Server contained by this GrpcFnServer.
ServiceT	getService()	Get the service exposed by this GrpcFnServer.

Methods inherited from class java.lang.Object

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

Method Details

allocatePortAndCreateFor

public static <ServiceT extends FnService>
GrpcFnServer<ServiceT> allocatePortAndCreateFor(ServiceT service,
 ServerFactory factory)
                                         throws IOException

Create a GrpcFnServer for the provided FnService running on an arbitrary port.

Throws:

IOException

allocatePortAndCreateFor

public static List<GrpcFnServer<? extends FnService>> allocatePortAndCreateFor(List<? extends FnService> services,
 ServerFactory factory)
                                                                        throws IOException

Create GrpcFnServers for the provided FnServices running on an arbitrary port.

Throws:

IOException

create

public static List<GrpcFnServer<? extends FnService>> create(List<? extends FnService> services,
 org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor endpoint,
 ServerFactory factory)
                                                      throws IOException

Create GrpcFnServers for the provided FnServices running on a specified port.

Throws:

IOException

create

public static <ServiceT extends FnService>
GrpcFnServer<ServiceT> create(ServiceT service,
 org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor endpoint,
 ServerFactory factory)
                       throws IOException

Create a GrpcFnServer for the provided FnService which will run at the endpoint specified in the Endpoints.ApiServiceDescriptor.

Throws:

IOException

create

@Deprecated
public static <ServiceT extends FnService>
GrpcFnServer<ServiceT> create(ServiceT service,
 org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor endpoint)

Deprecated.

This create function is used for Dataflow migration purpose only.

getApiServiceDescriptor

public org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor getApiServiceDescriptor()

Get an Endpoints.ApiServiceDescriptor describing the endpoint this GrpcFnServer is bound to.

getService

public ServiceT getService()

Get the service exposed by this GrpcFnServer.

getServer

public org.apache.beam.vendor.grpc.v1p69p0.io.grpc.Server getServer()

Get the underlying Server contained by this GrpcFnServer.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception