| <!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:29 PST 2020 --> |
| <title>DoFnFunction (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="DoFnFunction (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/spark/structuredstreaming/translation/batch/DatasetSourceBatch.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.batch"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/PipelineTranslatorBatch.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.batch"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" target="_top">Frames</a></li> |
| <li><a href="DoFnFunction.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.spark.structuredstreaming.translation.batch</div> |
| <h2 title="Class DoFnFunction" class="title">Class DoFnFunction<InputT,OutputT></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.runners.spark.structuredstreaming.translation.batch.DoFnFunction<InputT,OutputT></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, org.apache.spark.api.java.function.MapPartitionsFunction<org.apache.beam.sdk.util.WindowedValue<InputT>,scala.Tuple2<<a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,org.apache.beam.sdk.util.WindowedValue<?>>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">DoFnFunction<InputT,OutputT></span> |
| extends java.lang.Object |
| implements org.apache.spark.api.java.function.MapPartitionsFunction<org.apache.beam.sdk.util.WindowedValue<InputT>,scala.Tuple2<<a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,org.apache.beam.sdk.util.WindowedValue<?>>></pre> |
| <div class="block">Encapsulates a <a href="../../../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> inside a Spark <code>MapPartitionsFunction</code>. |
| |
| <p>We get a mapping from <a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values"><code>TupleTag</code></a> to output index and must tag |
| all outputs with the output number. Afterwards a filter will filter out those elements that are |
| not to be in a specific output.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../serialized-form.html#org.apache.beam.runners.spark.structuredstreaming.translation.batch.DoFnFunction">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html#DoFnFunction-org.apache.beam.runners.spark.structuredstreaming.metrics.MetricsContainerStepMapAccumulator-java.lang.String-org.apache.beam.sdk.transforms.DoFn-org.apache.beam.sdk.values.WindowingStrategy-java.util.Map-org.apache.beam.runners.core.construction.SerializablePipelineOptions-java.util.List-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.coders.Coder-java.util.Map-org.apache.beam.runners.spark.structuredstreaming.translation.helpers.SideInputBroadcast-org.apache.beam.sdk.transforms.DoFnSchemaInformation-java.util.Map-">DoFnFunction</a></span>(<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/metrics/MetricsContainerStepMapAccumulator.html" title="class in org.apache.beam.runners.spark.structuredstreaming.metrics">MetricsContainerStepMapAccumulator</a> metricsAccum, |
| java.lang.String stepName, |
| <a href="../../../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a><<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">InputT</a>,<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">OutputT</a>> doFn, |
| <a href="../../../../../../../../org/apache/beam/sdk/values/WindowingStrategy.html" title="class in org.apache.beam.sdk.values">WindowingStrategy</a><?,?> windowingStrategy, |
| java.util.Map<<a href="../../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?>,<a href="../../../../../../../../org/apache/beam/sdk/values/WindowingStrategy.html" title="class in org.apache.beam.sdk.values">WindowingStrategy</a><?,?>> sideInputs, |
| org.apache.beam.runners.core.construction.SerializablePipelineOptions serializableOptions, |
| java.util.List<<a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>> additionalOutputTags, |
| <a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">OutputT</a>> mainOutputTag, |
| <a href="../../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">InputT</a>> inputCoder, |
| java.util.Map<<a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,<a href="../../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><?>> outputCoderMap, |
| <a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/SideInputBroadcast.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.helpers">SideInputBroadcast</a> broadcastStateData, |
| <a href="../../../../../../../../org/apache/beam/sdk/transforms/DoFnSchemaInformation.html" title="class in org.apache.beam.sdk.transforms">DoFnSchemaInformation</a> doFnSchemaInformation, |
| java.util.Map<java.lang.String,<a href="../../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?>> sideInputMapping)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="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></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>java.util.Iterator<scala.Tuple2<<a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,org.apache.beam.sdk.util.WindowedValue<?>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html#call-java.util.Iterator-">call</a></span>(java.util.Iterator<org.apache.beam.sdk.util.WindowedValue<<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">InputT</a>>> iter)</code> </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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DoFnFunction-org.apache.beam.runners.spark.structuredstreaming.metrics.MetricsContainerStepMapAccumulator-java.lang.String-org.apache.beam.sdk.transforms.DoFn-org.apache.beam.sdk.values.WindowingStrategy-java.util.Map-org.apache.beam.runners.core.construction.SerializablePipelineOptions-java.util.List-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.coders.Coder-java.util.Map-org.apache.beam.runners.spark.structuredstreaming.translation.helpers.SideInputBroadcast-org.apache.beam.sdk.transforms.DoFnSchemaInformation-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DoFnFunction</h4> |
| <pre>public DoFnFunction(<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/metrics/MetricsContainerStepMapAccumulator.html" title="class in org.apache.beam.runners.spark.structuredstreaming.metrics">MetricsContainerStepMapAccumulator</a> metricsAccum, |
| java.lang.String stepName, |
| <a href="../../../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a><<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">InputT</a>,<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">OutputT</a>> doFn, |
| <a href="../../../../../../../../org/apache/beam/sdk/values/WindowingStrategy.html" title="class in org.apache.beam.sdk.values">WindowingStrategy</a><?,?> windowingStrategy, |
| java.util.Map<<a href="../../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?>,<a href="../../../../../../../../org/apache/beam/sdk/values/WindowingStrategy.html" title="class in org.apache.beam.sdk.values">WindowingStrategy</a><?,?>> sideInputs, |
| org.apache.beam.runners.core.construction.SerializablePipelineOptions serializableOptions, |
| java.util.List<<a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>> additionalOutputTags, |
| <a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">OutputT</a>> mainOutputTag, |
| <a href="../../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">InputT</a>> inputCoder, |
| java.util.Map<<a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,<a href="../../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><?>> outputCoderMap, |
| <a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/SideInputBroadcast.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.helpers">SideInputBroadcast</a> broadcastStateData, |
| <a href="../../../../../../../../org/apache/beam/sdk/transforms/DoFnSchemaInformation.html" title="class in org.apache.beam.sdk.transforms">DoFnSchemaInformation</a> doFnSchemaInformation, |
| java.util.Map<java.lang.String,<a href="../../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?>> sideInputMapping)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="call-java.util.Iterator-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>call</h4> |
| <pre>public java.util.Iterator<scala.Tuple2<<a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,org.apache.beam.sdk.util.WindowedValue<?>>> call(java.util.Iterator<org.apache.beam.sdk.util.WindowedValue<<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">InputT</a>>> iter) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>call</code> in interface <code>org.apache.spark.api.java.function.MapPartitionsFunction<org.apache.beam.sdk.util.WindowedValue<<a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" title="type parameter in DoFnFunction">InputT</a>>,scala.Tuple2<<a href="../../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,org.apache.beam.sdk.util.WindowedValue<?>>></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/spark/structuredstreaming/translation/batch/DatasetSourceBatch.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.batch"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/PipelineTranslatorBatch.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.batch"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/beam/runners/spark/structuredstreaming/translation/batch/DoFnFunction.html" target="_top">Frames</a></li> |
| <li><a href="DoFnFunction.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |