| <!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:33 PDT 2018 --> |
| <title>SourceMetrics (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="SourceMetrics (Apache Beam 2.8.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":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/sdk/metrics/SinkMetrics.html" title="class in org.apache.beam.sdk.metrics"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/metrics/SourceMetrics.html" target="_top">Frames</a></li> |
| <li><a href="SourceMetrics.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.sdk.metrics</div> |
| <h2 title="Class SourceMetrics" class="title">Class SourceMetrics</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.metrics.SourceMetrics</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#METRICS">METRICS</a>) |
| public class <span class="typeNameLabel">SourceMetrics</span> |
| extends java.lang.Object</pre> |
| <div class="block">Standard <a href="../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a> Metrics.</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/sdk/metrics/SourceMetrics.html#SourceMetrics--">SourceMetrics</a></span>()</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="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 <a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics">Gauge</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/SourceMetrics.html#backlogBytes--">backlogBytes</a></span>()</code> |
| <div class="block">Gauge for source backlog in bytes.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics">Gauge</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/SourceMetrics.html#backlogBytesOfSplit-java.lang.String-">backlogBytesOfSplit</a></span>(java.lang.String splitId)</code> |
| <div class="block">Gauge for source split backlog in bytes.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics">Gauge</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/SourceMetrics.html#backlogElements--">backlogElements</a></span>()</code> |
| <div class="block">Gauge for source backlog in elements.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics">Gauge</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/SourceMetrics.html#backlogElementsOfSplit-java.lang.String-">backlogElementsOfSplit</a></span>(java.lang.String splitId)</code> |
| <div class="block">Gauge for source split backlog in elements.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/SourceMetrics.html#bytesRead--">bytesRead</a></span>()</code> |
| <div class="block">Counter of bytes read by a source.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/SourceMetrics.html#bytesReadBySplit-java.lang.String-">bytesReadBySplit</a></span>(java.lang.String splitId)</code> |
| <div class="block">Counter of bytes read by a source split.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/SourceMetrics.html#elementsRead--">elementsRead</a></span>()</code> |
| <div class="block">Counter of elements read by a source.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/metrics/SourceMetrics.html#elementsReadBySplit-java.lang.String-">elementsReadBySplit</a></span>(java.lang.String splitId)</code> |
| <div class="block">Counter of elements read by a source split.</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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SourceMetrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SourceMetrics</h4> |
| <pre>public SourceMetrics()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="elementsRead--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>elementsRead</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> elementsRead()</pre> |
| <div class="block">Counter of elements read by a source.</div> |
| </li> |
| </ul> |
| <a name="elementsReadBySplit-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>elementsReadBySplit</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> elementsReadBySplit(java.lang.String splitId)</pre> |
| <div class="block">Counter of elements read by a source split. |
| |
| <p>Should only be used when there is a small, fixed set of split IDs so as not to overload |
| metrics backends.</div> |
| </li> |
| </ul> |
| <a name="bytesRead--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bytesRead</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> bytesRead()</pre> |
| <div class="block">Counter of bytes read by a source.</div> |
| </li> |
| </ul> |
| <a name="bytesReadBySplit-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bytesReadBySplit</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics">Counter</a> bytesReadBySplit(java.lang.String splitId)</pre> |
| <div class="block">Counter of bytes read by a source split. |
| |
| <p>Should only be used when there is a small, fixed set of split IDs so as not to overload |
| metrics backends.</div> |
| </li> |
| </ul> |
| <a name="backlogBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>backlogBytes</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics">Gauge</a> backlogBytes()</pre> |
| <div class="block">Gauge for source backlog in bytes.</div> |
| </li> |
| </ul> |
| <a name="backlogBytesOfSplit-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>backlogBytesOfSplit</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics">Gauge</a> backlogBytesOfSplit(java.lang.String splitId)</pre> |
| <div class="block">Gauge for source split backlog in bytes. |
| |
| <p>Should only be used when there is a small, fixed set of split IDs so as not to overload |
| metrics backends.</div> |
| </li> |
| </ul> |
| <a name="backlogElements--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>backlogElements</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics">Gauge</a> backlogElements()</pre> |
| <div class="block">Gauge for source backlog in elements.</div> |
| </li> |
| </ul> |
| <a name="backlogElementsOfSplit-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>backlogElementsOfSplit</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics">Gauge</a> backlogElementsOfSplit(java.lang.String splitId)</pre> |
| <div class="block">Gauge for source split backlog in elements. |
| |
| <p>Should only be used when there is a small, fixed set of split IDs so as not to overload |
| metrics backends.</div> |
| </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/sdk/metrics/SinkMetrics.html" title="class in org.apache.beam.sdk.metrics"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/metrics/SourceMetrics.html" target="_top">Frames</a></li> |
| <li><a href="SourceMetrics.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> |