| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_181-google-v7) on Mon Jan 27 16:42:28 PST 2020 --> |
| <title>GrpcFnServer (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="GrpcFnServer (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10,"i2":41,"i3":9,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcContextHeaderAccessorProvider.html" title="class in org.apache.beam.runners.fnexecution"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/runners/fnexecution/HeaderAccessor.html" title="interface in org.apache.beam.runners.fnexecution"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/runners/fnexecution/GrpcFnServer.html" target="_top">Frames</a></li> |
| <li><a href="GrpcFnServer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.runners.fnexecution</div> |
| <h2 title="Class GrpcFnServer" class="title">Class GrpcFnServer<ServiceT extends <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution">FnService</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.runners.fnexecution.GrpcFnServer<ServiceT></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.lang.AutoCloseable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">GrpcFnServer<ServiceT extends <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution">FnService</a>></span> |
| extends java.lang.Object |
| implements java.lang.AutoCloseable</pre> |
| <div class="block">A <code>gRPC Server</code> which manages a single <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution"><code>FnService</code></a>. The lifetime of the |
| service is bound to the <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <ServiceT extends <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution">FnService</a>><br><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution">GrpcFnServer</a><ServiceT></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html#allocatePortAndCreateFor-ServiceT-org.apache.beam.runners.fnexecution.ServerFactory-">allocatePortAndCreateFor</a></span>(ServiceT service, |
| <a href="../../../../../org/apache/beam/runners/fnexecution/ServerFactory.html" title="class in org.apache.beam.runners.fnexecution">ServerFactory</a> factory)</code> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a> for the provided <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution"><code>FnService</code></a> running on an arbitrary port.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <ServiceT extends <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution">FnService</a>><br><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution">GrpcFnServer</a><ServiceT></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html#create-ServiceT-org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor-">create</a></span>(ServiceT service, |
| org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor endpoint)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">This create function is used for Dataflow migration purpose only.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <ServiceT extends <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution">FnService</a>><br><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution">GrpcFnServer</a><ServiceT></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html#create-ServiceT-org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor-org.apache.beam.runners.fnexecution.ServerFactory-">create</a></span>(ServiceT service, |
| org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor endpoint, |
| <a href="../../../../../org/apache/beam/runners/fnexecution/ServerFactory.html" title="class in org.apache.beam.runners.fnexecution">ServerFactory</a> factory)</code> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a> for the provided <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution"><code>FnService</code></a> which will run at the endpoint |
| specified in the <code>Endpoints.ApiServiceDescriptor</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html#getApiServiceDescriptor--">getApiServiceDescriptor</a></span>()</code> |
| <div class="block">Get an <code>Endpoints.ApiServiceDescriptor</code> describing the endpoint this <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a> is bound |
| to.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>org.apache.beam.vendor.grpc.v1p26p0.io.grpc.Server</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html#getServer--">getServer</a></span>()</code> |
| <div class="block">Get the underlying <code>Server</code> contained by this <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="type parameter in GrpcFnServer">ServiceT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html#getService--">getService</a></span>()</code> |
| <div class="block">Get the service exposed by this <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="allocatePortAndCreateFor-org.apache.beam.runners.fnexecution.FnService-org.apache.beam.runners.fnexecution.ServerFactory-"> |
| <!-- --> |
| </a><a name="allocatePortAndCreateFor-ServiceT-org.apache.beam.runners.fnexecution.ServerFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocatePortAndCreateFor</h4> |
| <pre>public static <ServiceT extends <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution">FnService</a>> <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution">GrpcFnServer</a><ServiceT> allocatePortAndCreateFor(ServiceT service, |
| <a href="../../../../../org/apache/beam/runners/fnexecution/ServerFactory.html" title="class in org.apache.beam.runners.fnexecution">ServerFactory</a> factory) |
| throws java.io.IOException</pre> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a> for the provided <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution"><code>FnService</code></a> running on an arbitrary port.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.beam.runners.fnexecution.FnService-org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor-org.apache.beam.runners.fnexecution.ServerFactory-"> |
| <!-- --> |
| </a><a name="create-ServiceT-org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor-org.apache.beam.runners.fnexecution.ServerFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <ServiceT extends <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution">FnService</a>> <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution">GrpcFnServer</a><ServiceT> create(ServiceT service, |
| org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor endpoint, |
| <a href="../../../../../org/apache/beam/runners/fnexecution/ServerFactory.html" title="class in org.apache.beam.runners.fnexecution">ServerFactory</a> factory) |
| throws java.io.IOException</pre> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a> for the provided <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution"><code>FnService</code></a> which will run at the endpoint |
| specified in the <code>Endpoints.ApiServiceDescriptor</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.beam.runners.fnexecution.FnService-org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor-"> |
| <!-- --> |
| </a><a name="create-ServiceT-org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>@Deprecated |
| public static <ServiceT extends <a href="../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution">FnService</a>> <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution">GrpcFnServer</a><ServiceT> create(ServiceT service, |
| org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor endpoint)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">This create function is used for Dataflow migration purpose only.</span></div> |
| </li> |
| </ul> |
| <a name="getApiServiceDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApiServiceDescriptor</h4> |
| <pre>public org.apache.beam.model.pipeline.v1.Endpoints.ApiServiceDescriptor getApiServiceDescriptor()</pre> |
| <div class="block">Get an <code>Endpoints.ApiServiceDescriptor</code> describing the endpoint this <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a> is bound |
| to.</div> |
| </li> |
| </ul> |
| <a name="getService--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getService</h4> |
| <pre>public <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="type parameter in GrpcFnServer">ServiceT</a> getService()</pre> |
| <div class="block">Get the service exposed by this <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getServer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServer</h4> |
| <pre>public org.apache.beam.vendor.grpc.v1p26p0.io.grpc.Server getServer()</pre> |
| <div class="block">Get the underlying <code>Server</code> contained by this <a href="../../../../../org/apache/beam/runners/fnexecution/GrpcFnServer.html" title="class in org.apache.beam.runners.fnexecution"><code>GrpcFnServer</code></a>.</div> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/beam/runners/fnexecution/GrpcContextHeaderAccessorProvider.html" title="class in org.apache.beam.runners.fnexecution"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/runners/fnexecution/HeaderAccessor.html" title="interface in org.apache.beam.runners.fnexecution"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/runners/fnexecution/GrpcFnServer.html" target="_top">Frames</a></li> |
| <li><a href="GrpcFnServer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |