| <!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:32 PST 2020 --> |
| <title>WireCoders (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="WireCoders (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/wire/LengthPrefixUnknownCoders.html" title="class in org.apache.beam.runners.fnexecution.wire"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/wire/WireCoders.html" target="_top">Frames</a></li> |
| <li><a href="WireCoders.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.wire</div> |
| <h2 title="Class WireCoders" class="title">Class WireCoders</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.runners.fnexecution.wire.WireCoders</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">WireCoders</span> |
| extends java.lang.Object</pre> |
| <div class="block">Helpers to construct coders for gRPC port reads and writes.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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 java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/wire/WireCoders.html#addRunnerWireCoder-org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode-org.apache.beam.model.pipeline.v1.RunnerApi.Components.Builder-org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting-">addRunnerWireCoder</a></span>(org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode pCollectionNode, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Components.Builder components, |
| org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting wireCoderSetting)</code> |
| <div class="block">Creates a runner-side wire coder for a port read/write for the given PCollection.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/wire/WireCoders.html#addSdkWireCoder-org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode-org.apache.beam.model.pipeline.v1.RunnerApi.Components.Builder-org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting-">addSdkWireCoder</a></span>(org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode pCollectionNode, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Components.Builder components, |
| org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting wireCoderSetting)</code> |
| <div class="block">Creates an SDK-side wire coder for a port read/write for the given PCollection.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><org.apache.beam.sdk.util.WindowedValue<T>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/wire/WireCoders.html#instantiateRunnerWireCoder-org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode-org.apache.beam.model.pipeline.v1.RunnerApi.Components-">instantiateRunnerWireCoder</a></span>(org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode pCollectionNode, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Components components)</code> |
| <div class="block">Instantiates a runner-side wire coder for the given PCollection.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><org.apache.beam.sdk.util.WindowedValue<T>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/wire/WireCoders.html#instantiateRunnerWireCoder-org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode-org.apache.beam.model.pipeline.v1.RunnerApi.Components-org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting-">instantiateRunnerWireCoder</a></span>(org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode pCollectionNode, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Components components, |
| org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting wireCoderSetting)</code> |
| <div class="block">Instantiates a runner-side wire coder for the given PCollection.</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="addSdkWireCoder-org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode-org.apache.beam.model.pipeline.v1.RunnerApi.Components.Builder-org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSdkWireCoder</h4> |
| <pre>public static java.lang.String addSdkWireCoder(org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode pCollectionNode, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Components.Builder components, |
| org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting wireCoderSetting)</pre> |
| <div class="block">Creates an SDK-side wire coder for a port read/write for the given PCollection. Coders that are |
| unknown to the runner are wrapped with length-prefix coders. The inner element coders are kept |
| intact so that SDK harnesses can reconstruct the original elements. |
| |
| <p>Adds all necessary coders to the components builder.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>id of a windowed value coder containing the PCollection's element coder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addRunnerWireCoder-org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode-org.apache.beam.model.pipeline.v1.RunnerApi.Components.Builder-org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRunnerWireCoder</h4> |
| <pre>public static java.lang.String addRunnerWireCoder(org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode pCollectionNode, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Components.Builder components, |
| org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting wireCoderSetting)</pre> |
| <div class="block">Creates a runner-side wire coder for a port read/write for the given PCollection. Unknown |
| coders are replaced with length-prefixed byte arrays. |
| |
| <p>Adds all necessary coders to the components builder.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>id of a windowed value coder containing the PCollection's element coder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="instantiateRunnerWireCoder-org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode-org.apache.beam.model.pipeline.v1.RunnerApi.Components-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>instantiateRunnerWireCoder</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><org.apache.beam.sdk.util.WindowedValue<T>> instantiateRunnerWireCoder(org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode pCollectionNode, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Components components) |
| throws java.io.IOException</pre> |
| <div class="block">Instantiates a runner-side wire coder for the given PCollection. Any component coders that are |
| unknown by the runner are replaced with length-prefixed byte arrays.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a full windowed value coder containing the PCollection's element coder</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="instantiateRunnerWireCoder-org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode-org.apache.beam.model.pipeline.v1.RunnerApi.Components-org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>instantiateRunnerWireCoder</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><org.apache.beam.sdk.util.WindowedValue<T>> instantiateRunnerWireCoder(org.apache.beam.runners.core.construction.graph.PipelineNode.PCollectionNode pCollectionNode, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Components components, |
| org.apache.beam.model.pipeline.v1.RunnerApi.ExecutableStagePayload.WireCoderSetting wireCoderSetting) |
| throws java.io.IOException</pre> |
| <div class="block">Instantiates a runner-side wire coder for the given PCollection. Any component coders that are |
| unknown by the runner are replaced with length-prefixed byte arrays.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a full or parameterized windowed value coder containing the PCollection's element coder</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</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/wire/LengthPrefixUnknownCoders.html" title="class in org.apache.beam.runners.fnexecution.wire"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/wire/WireCoders.html" target="_top">Frames</a></li> |
| <li><a href="WireCoders.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> |
