| <!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_161-google-v7) on Thu Oct 18 16:14:35 PDT 2018 --> |
| <title>DoFnRunnerWithMetricsUpdate (Apache Beam 2.8.0-SNAPSHOT)</title> |
| <meta name="date" content="2018-10-18"> |
| <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="DoFnRunnerWithMetricsUpdate (Apache Beam 2.8.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/runners/flink/metrics/FlinkMetricContainer.html" title="class in org.apache.beam.runners.flink.metrics"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" target="_top">Frames</a></li> |
| <li><a href="DoFnRunnerWithMetricsUpdate.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.flink.metrics</div> |
| <h2 title="Class DoFnRunnerWithMetricsUpdate" class="title">Class DoFnRunnerWithMetricsUpdate<InputT,OutputT></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.runners.flink.metrics.DoFnRunnerWithMetricsUpdate<InputT,OutputT></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.beam.runners.core.DoFnRunner<InputT,OutputT></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">DoFnRunnerWithMetricsUpdate<InputT,OutputT></span> |
| extends java.lang.Object |
| implements org.apache.beam.runners.core.DoFnRunner<InputT,OutputT></pre> |
| <div class="block"><code>DoFnRunner</code> decorator which registers <code>MetricsContainerImpl</code>. It updates metrics to |
| Flink metrics and accumulators in <a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html#finishBundle--"><code>finishBundle()</code></a>.</div> |
| </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/flink/metrics/DoFnRunnerWithMetricsUpdate.html#DoFnRunnerWithMetricsUpdate-java.lang.String-org.apache.beam.runners.core.DoFnRunner-org.apache.flink.api.common.functions.RuntimeContext-">DoFnRunnerWithMetricsUpdate</a></span>(java.lang.String stepName, |
| org.apache.beam.runners.core.DoFnRunner<<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>,<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">OutputT</a>> delegate, |
| org.apache.flink.api.common.functions.RuntimeContext runtimeContext)</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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html#finishBundle--">finishBundle</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><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/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>,<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">OutputT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html#getFn--">getFn</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html#onTimer-java.lang.String-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.joda.time.Instant-org.apache.beam.sdk.state.TimeDomain-">onTimer</a></span>(java.lang.String timerId, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window, |
| <a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a> timestamp, |
| <a href="../../../../../../org/apache/beam/sdk/state/TimeDomain.html" title="enum in org.apache.beam.sdk.state">TimeDomain</a> timeDomain)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html#processElement-org.apache.beam.sdk.util.WindowedValue-">processElement</a></span>(org.apache.beam.sdk.util.WindowedValue<<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>> elem)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html#startBundle--">startBundle</a></span>()</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="DoFnRunnerWithMetricsUpdate-java.lang.String-org.apache.beam.runners.core.DoFnRunner-org.apache.flink.api.common.functions.RuntimeContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DoFnRunnerWithMetricsUpdate</h4> |
| <pre>public DoFnRunnerWithMetricsUpdate(java.lang.String stepName, |
| org.apache.beam.runners.core.DoFnRunner<<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>,<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">OutputT</a>> delegate, |
| org.apache.flink.api.common.functions.RuntimeContext runtimeContext)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="startBundle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startBundle</h4> |
| <pre>public void startBundle()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>startBundle</code> in interface <code>org.apache.beam.runners.core.DoFnRunner<<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>,<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">OutputT</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="processElement-org.apache.beam.sdk.util.WindowedValue-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processElement</h4> |
| <pre>public void processElement(org.apache.beam.sdk.util.WindowedValue<<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>> elem)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>processElement</code> in interface <code>org.apache.beam.runners.core.DoFnRunner<<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>,<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">OutputT</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onTimer-java.lang.String-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.joda.time.Instant-org.apache.beam.sdk.state.TimeDomain-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onTimer</h4> |
| <pre>public void onTimer(java.lang.String timerId, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window, |
| <a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a> timestamp, |
| <a href="../../../../../../org/apache/beam/sdk/state/TimeDomain.html" title="enum in org.apache.beam.sdk.state">TimeDomain</a> timeDomain)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>onTimer</code> in interface <code>org.apache.beam.runners.core.DoFnRunner<<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>,<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">OutputT</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="finishBundle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finishBundle</h4> |
| <pre>public void finishBundle()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>finishBundle</code> in interface <code>org.apache.beam.runners.core.DoFnRunner<<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>,<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">OutputT</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFn--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getFn</h4> |
| <pre>public <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/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>,<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">OutputT</a>> getFn()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getFn</code> in interface <code>org.apache.beam.runners.core.DoFnRunner<<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">InputT</a>,<a href="../../../../../../org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" title="type parameter in DoFnRunnerWithMetricsUpdate">OutputT</a>></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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/runners/flink/metrics/FlinkMetricContainer.html" title="class in org.apache.beam.runners.flink.metrics"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/flink/metrics/DoFnRunnerWithMetricsUpdate.html" target="_top">Frames</a></li> |
| <li><a href="DoFnRunnerWithMetricsUpdate.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> |
