| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- GitHub action javadoc-cleanup --> |
| <link rel="canonical" href="https://beam.apache.org/releases/javadoc/current/org/apache/beam/io/requestresponse/Monitoring.html"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <!-- End javadoc-cleanup block --> |
| <!-- Generated by javadoc --> |
| <title>Monitoring (Apache Beam 2.55.1)</title> |
| <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="Monitoring (Apache Beam 2.55.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":10,"i19":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/io/requestresponse/CallShouldBackoff.html" title="interface in org.apache.beam.io.requestresponse"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.Builder.html" title="class in org.apache.beam.io.requestresponse"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/io/requestresponse/Monitoring.html" target="_top">Frames</a></li> |
| <li><a href="Monitoring.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><a href="#nested.class.summary">Nested</a> | </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.io.requestresponse</div> |
| <h2 title="Class Monitoring" class="title">Class Monitoring</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.io.requestresponse.Monitoring</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">Monitoring</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <div class="block">Configures <a href="../../../../../org/apache/beam/sdk/metrics/Metric.html" title="interface in org.apache.beam.sdk.metrics"><code>Metric</code></a>s throughout various features of <a href="../../../../../org/apache/beam/io/requestresponse/RequestResponseIO.html" title="class in org.apache.beam.io.requestresponse"><code>RequestResponseIO</code></a>. By default, |
| all monitoring is turned off. |
| |
| <pre> |
| Cache metrics are not yet supported. See <a href="https://github.com/apache/beam/issues/29888">https://github.com/apache/beam/issues/29888</a> |
| </pre></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.beam.io.requestresponse.Monitoring">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.Builder.html" title="class in org.apache.beam.io.requestresponse">Monitoring.Builder</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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/io/requestresponse/Monitoring.html#Monitoring--">Monitoring</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/io/requestresponse/Monitoring.Builder.html" title="class in org.apache.beam.io.requestresponse">Monitoring.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#builder--">builder</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountBackoffs--">getCountBackoffs</a></span>()</code> |
| <div class="block">Count invocations of <code>BackOff.nextBackOffMillis()</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountCacheReadFailures--">getCountCacheReadFailures</a></span>()</code> |
| <div class="block">Count <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a> read failures.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountCacheReadNonNulls--">getCountCacheReadNonNulls</a></span>()</code> |
| <div class="block">Count associated non-null values resulting from <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a> reads.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountCacheReadNulls--">getCountCacheReadNulls</a></span>()</code> |
| <div class="block">Count associated null values resulting from <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a> reads.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountCacheReadRequests--">getCountCacheReadRequests</a></span>()</code> |
| <div class="block">Count number of attempts to read from the <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountCacheWriteFailures--">getCountCacheWriteFailures</a></span>()</code> |
| <div class="block">Count <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a> write failures.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountCacheWriteRequests--">getCountCacheWriteRequests</a></span>()</code> |
| <div class="block">Count number of attempts to write to the <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountCacheWriteSuccesses--">getCountCacheWriteSuccesses</a></span>()</code> |
| <div class="block">Count <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a> write successes.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountCalls--">getCountCalls</a></span>()</code> |
| <div class="block">Count invocations of <a href="../../../../../org/apache/beam/io/requestresponse/Caller.html#call-RequestT-"><code>Caller.call(RequestT)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountFailures--">getCountFailures</a></span>()</code> |
| <div class="block">Count failures resulting from <code>Call</code>'s successful <a href="../../../../../org/apache/beam/io/requestresponse/Caller.html" title="interface in org.apache.beam.io.requestresponse"><code>Caller</code></a> invocation.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountRequests--">getCountRequests</a></span>()</code> |
| <div class="block">Count incoming request elements processed by <code>Call</code>'s <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountResponses--">getCountResponses</a></span>()</code> |
| <div class="block">Count outgoing responses resulting from <code>Call</code>'s successful <a href="../../../../../org/apache/beam/io/requestresponse/Caller.html" title="interface in org.apache.beam.io.requestresponse"><code>Caller</code></a> invocation.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountSetup--">getCountSetup</a></span>()</code> |
| <div class="block">Count invocations of <a href="../../../../../org/apache/beam/io/requestresponse/SetupTeardown.html#setup--"><code>SetupTeardown.setup()</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountShouldBackoff--">getCountShouldBackoff</a></span>()</code> |
| <div class="block">Count when <a href="../../../../../org/apache/beam/io/requestresponse/CallShouldBackoff.html#isTrue--"><code>CallShouldBackoff.isTrue()</code></a> is found true.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountSleeps--">getCountSleeps</a></span>()</code> |
| <div class="block">Count invocations of <code>Sleeper.sleep(long)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#getCountTeardown--">getCountTeardown</a></span>()</code> |
| <div class="block">Count invocations of <a href="../../../../../org/apache/beam/io/requestresponse/SetupTeardown.html#teardown--"><code>SetupTeardown.teardown()</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.Builder.html" title="class in org.apache.beam.io.requestresponse">Monitoring.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#toBuilder--">toBuilder</a></span>()</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html" title="class in org.apache.beam.io.requestresponse">Monitoring</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#withEverythingCounted--">withEverythingCounted</a></span>()</code> |
| <div class="block">Turns on all monitoring.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html" title="class in org.apache.beam.io.requestresponse">Monitoring</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#withEverythingCountedExceptedCaching--">withEverythingCountedExceptedCaching</a></span>()</code> |
| <div class="block">Turns on all monitoring except for cache related metrics.</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="Monitoring--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Monitoring</h4> |
| <pre>public Monitoring()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="builder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>builder</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.Builder.html" title="class in org.apache.beam.io.requestresponse">Monitoring.Builder</a> builder()</pre> |
| </li> |
| </ul> |
| <a name="getCountRequests--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountRequests</h4> |
| <pre>public abstract java.lang.Boolean getCountRequests()</pre> |
| <div class="block">Count incoming request elements processed by <code>Call</code>'s <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getCountResponses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountResponses</h4> |
| <pre>public abstract java.lang.Boolean getCountResponses()</pre> |
| <div class="block">Count outgoing responses resulting from <code>Call</code>'s successful <a href="../../../../../org/apache/beam/io/requestresponse/Caller.html" title="interface in org.apache.beam.io.requestresponse"><code>Caller</code></a> invocation.</div> |
| </li> |
| </ul> |
| <a name="getCountCalls--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountCalls</h4> |
| <pre>public abstract java.lang.Boolean getCountCalls()</pre> |
| <div class="block">Count invocations of <a href="../../../../../org/apache/beam/io/requestresponse/Caller.html#call-RequestT-"><code>Caller.call(RequestT)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getCountFailures--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountFailures</h4> |
| <pre>public abstract java.lang.Boolean getCountFailures()</pre> |
| <div class="block">Count failures resulting from <code>Call</code>'s successful <a href="../../../../../org/apache/beam/io/requestresponse/Caller.html" title="interface in org.apache.beam.io.requestresponse"><code>Caller</code></a> invocation.</div> |
| </li> |
| </ul> |
| <a name="getCountSetup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountSetup</h4> |
| <pre>public abstract java.lang.Boolean getCountSetup()</pre> |
| <div class="block">Count invocations of <a href="../../../../../org/apache/beam/io/requestresponse/SetupTeardown.html#setup--"><code>SetupTeardown.setup()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getCountTeardown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountTeardown</h4> |
| <pre>public abstract java.lang.Boolean getCountTeardown()</pre> |
| <div class="block">Count invocations of <a href="../../../../../org/apache/beam/io/requestresponse/SetupTeardown.html#teardown--"><code>SetupTeardown.teardown()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getCountBackoffs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountBackoffs</h4> |
| <pre>public abstract java.lang.Boolean getCountBackoffs()</pre> |
| <div class="block">Count invocations of <code>BackOff.nextBackOffMillis()</code>.</div> |
| </li> |
| </ul> |
| <a name="getCountSleeps--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountSleeps</h4> |
| <pre>public abstract java.lang.Boolean getCountSleeps()</pre> |
| <div class="block">Count invocations of <code>Sleeper.sleep(long)</code>.</div> |
| </li> |
| </ul> |
| <a name="getCountShouldBackoff--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountShouldBackoff</h4> |
| <pre>public abstract java.lang.Boolean getCountShouldBackoff()</pre> |
| <div class="block">Count when <a href="../../../../../org/apache/beam/io/requestresponse/CallShouldBackoff.html#isTrue--"><code>CallShouldBackoff.isTrue()</code></a> is found true.</div> |
| </li> |
| </ul> |
| <a name="getCountCacheReadRequests--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountCacheReadRequests</h4> |
| <pre>public abstract java.lang.Boolean getCountCacheReadRequests()</pre> |
| <div class="block">Count number of attempts to read from the <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getCountCacheReadNulls--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountCacheReadNulls</h4> |
| <pre>public abstract java.lang.Boolean getCountCacheReadNulls()</pre> |
| <div class="block">Count associated null values resulting from <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a> reads.</div> |
| </li> |
| </ul> |
| <a name="getCountCacheReadNonNulls--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountCacheReadNonNulls</h4> |
| <pre>public abstract java.lang.Boolean getCountCacheReadNonNulls()</pre> |
| <div class="block">Count associated non-null values resulting from <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a> reads.</div> |
| </li> |
| </ul> |
| <a name="getCountCacheReadFailures--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountCacheReadFailures</h4> |
| <pre>public abstract java.lang.Boolean getCountCacheReadFailures()</pre> |
| <div class="block">Count <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a> read failures.</div> |
| </li> |
| </ul> |
| <a name="getCountCacheWriteRequests--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountCacheWriteRequests</h4> |
| <pre>public abstract java.lang.Boolean getCountCacheWriteRequests()</pre> |
| <div class="block">Count number of attempts to write to the <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getCountCacheWriteSuccesses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountCacheWriteSuccesses</h4> |
| <pre>public abstract java.lang.Boolean getCountCacheWriteSuccesses()</pre> |
| <div class="block">Count <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a> write successes.</div> |
| </li> |
| </ul> |
| <a name="getCountCacheWriteFailures--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountCacheWriteFailures</h4> |
| <pre>public abstract java.lang.Boolean getCountCacheWriteFailures()</pre> |
| <div class="block">Count <a href="../../../../../org/apache/beam/io/requestresponse/Cache.html" title="class in org.apache.beam.io.requestresponse"><code>Cache</code></a> write failures.</div> |
| </li> |
| </ul> |
| <a name="withEverythingCounted--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withEverythingCounted</h4> |
| <pre>public <a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html" title="class in org.apache.beam.io.requestresponse">Monitoring</a> withEverythingCounted()</pre> |
| <div class="block">Turns on all monitoring. The purpose of this method is, when used with <a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html#toBuilder--"><code>toBuilder()</code></a> and |
| other setters, to turn everything on except for a few select counters.</div> |
| </li> |
| </ul> |
| <a name="withEverythingCountedExceptedCaching--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withEverythingCountedExceptedCaching</h4> |
| <pre>public <a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.html" title="class in org.apache.beam.io.requestresponse">Monitoring</a> withEverythingCountedExceptedCaching()</pre> |
| <div class="block">Turns on all monitoring except for cache related metrics.</div> |
| </li> |
| </ul> |
| <a name="toBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toBuilder</h4> |
| <pre>public abstract <a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.Builder.html" title="class in org.apache.beam.io.requestresponse">Monitoring.Builder</a> toBuilder()</pre> |
| </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/io/requestresponse/CallShouldBackoff.html" title="interface in org.apache.beam.io.requestresponse"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/io/requestresponse/Monitoring.Builder.html" title="class in org.apache.beam.io.requestresponse"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/io/requestresponse/Monitoring.html" target="_top">Frames</a></li> |
| <li><a href="Monitoring.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><a href="#nested.class.summary">Nested</a> | </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> |