| <!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 --> |
| <title>LuceneIndexMetrics (Apache Geode 1.15.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="LuceneIndexMetrics (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":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/geode/cache/lucene/management/LuceneServiceMXBean.html" title="interface in org.apache.geode.cache.lucene.management"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" target="_top">Frames</a></li> |
| <li><a href="LuceneIndexMetrics.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.geode.cache.lucene.management</div> |
| <h2 title="Class LuceneIndexMetrics" class="title">Class LuceneIndexMetrics</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.geode.cache.lucene.management.LuceneIndexMetrics</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">LuceneIndexMetrics</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| </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/geode/cache/lucene/management/LuceneIndexMetrics.html#LuceneIndexMetrics-java.lang.String-java.lang.String-int-long-long-int-long-int-long-long-int-int-long-long-int-int-">LuceneIndexMetrics</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> regionPath, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> indexName, |
| int queryExecutions, |
| long queryExecutionTime, |
| long queryRateAverageLatency, |
| int queryExecutionsInProgress, |
| long queryExecutionTotalHits, |
| int updates, |
| long updateTime, |
| long updateRateAverageLatency, |
| int updatesInProgress, |
| int commits, |
| long commitTime, |
| long commitRateAverageLatency, |
| int commitsInProgress, |
| int documents)</code> |
| <div class="block">This constructor is to be used by internal JMX framework only.</div> |
| </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>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getCommitRateAverageLatency--">getCommitRateAverageLatency</a></span>()</code> |
| <div class="block">Returns the average latency for the commit operations using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getCommits--">getCommits</a></span>()</code> |
| <div class="block">Returns the number of commit operations executed on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getCommitsInProgress--">getCommitsInProgress</a></span>()</code> |
| <div class="block">Returns the number of commit operations in progress for the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getCommitTime--">getCommitTime</a></span>()</code> |
| <div class="block">Returns the time consumed by the commit operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getDocuments--">getDocuments</a></span>()</code> |
| <div class="block">Returns the number of documents indexed by <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getIndexName--">getIndexName</a></span>()</code> |
| <div class="block">Returns the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> name of the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> created</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getQueryExecutions--">getQueryExecutions</a></span>()</code> |
| <div class="block">Returns the number of query executions using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getQueryExecutionsInProgress--">getQueryExecutionsInProgress</a></span>()</code> |
| <div class="block">Returns the number of query executions in progress which are using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getQueryExecutionTime--">getQueryExecutionTime</a></span>()</code> |
| <div class="block">Returns the time duration for execution of queries using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getQueryExecutionTotalHits--">getQueryExecutionTotalHits</a></span>()</code> |
| <div class="block">Returns the number of hits for the query execution using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getQueryRateAverageLatency--">getQueryRateAverageLatency</a></span>()</code> |
| <div class="block">Returns the average latency for query executions using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getRegionPath--">getRegionPath</a></span>()</code> |
| <div class="block">Returns the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> path for the region on which the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> is created</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getUpdateRateAverageLatency--">getUpdateRateAverageLatency</a></span>()</code> |
| <div class="block">Returns the average latency for the update operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getUpdates--">getUpdates</a></span>()</code> |
| <div class="block">Returns the number of update operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getUpdatesInProgress--">getUpdatesInProgress</a></span>()</code> |
| <div class="block">Returns the number of update operations in progress for the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#getUpdateTime--">getUpdateTime</a></span>()</code> |
| <div class="block">Returns the time consumed for the update operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html#toString--">toString</a></span>()</code> |
| <div class="block">Outputs the string message containing all the stats stored for the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="LuceneIndexMetrics-java.lang.String-java.lang.String-int-long-long-int-long-int-long-long-int-int-long-long-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LuceneIndexMetrics</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/beans/ConstructorProperties.html?is-external=true" title="class or interface in java.beans">@ConstructorProperties</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/beans/ConstructorProperties.html?is-external=true#value--" title="class or interface in java.beans">value</a>={"regionPath","indexName","queryExecutions","queryExecutionTime","queryRateAverageLatency","queryExecutionsInProgress","queryExecutionTotalHits","updates","updateTime","updateRateAverageLatency","updatesInProgress","commits","commitTime","commitRateAverageLatency","commitsInProgress","documents"}) |
| public LuceneIndexMetrics(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> regionPath, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> indexName, |
| int queryExecutions, |
| long queryExecutionTime, |
| long queryRateAverageLatency, |
| int queryExecutionsInProgress, |
| long queryExecutionTotalHits, |
| int updates, |
| long updateTime, |
| long updateRateAverageLatency, |
| int updatesInProgress, |
| int commits, |
| long commitTime, |
| long commitRateAverageLatency, |
| int commitsInProgress, |
| int documents)</pre> |
| <div class="block">This constructor is to be used by internal JMX framework only. A user should not try to create |
| an instance of this class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionPath</code> - the path for the region on which the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> is created</dd> |
| <dd><code>indexName</code> - the name of the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> created</dd> |
| <dd><code>queryExecutions</code> - the number of query executions using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>queryExecutionTime</code> - the time duration for execution of queries using the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>queryRateAverageLatency</code> - the average latency for query executions using the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>queryExecutionsInProgress</code> - the number of query executions in progress which are using the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>queryExecutionTotalHits</code> - the number of hits for the query execution using the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>updates</code> - the number of update operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>updateTime</code> - the time consumed for the update operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>updateRateAverageLatency</code> - the average latency for the update operations on the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>updatesInProgress</code> - the number of update operations in progress for the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>commits</code> - the number of commit operations executed on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>commitTime</code> - the time consumed by the commit operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>commitRateAverageLatency</code> - the average latency for the commit operations using the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>commitsInProgress</code> - the number of commit operations in progress for the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| <dd><code>documents</code> - the number of documents indexed by <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRegionPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionPath</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRegionPath()</pre> |
| <div class="block">Returns the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> path for the region on which the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> is created</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String value of the region path on the Lucene Index is created</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIndexName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndexName</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getIndexName()</pre> |
| <div class="block">Returns the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> name of the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> created</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String value of the index name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryExecutions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryExecutions</h4> |
| <pre>public int getQueryExecutions()</pre> |
| <div class="block">Returns the number of query executions using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Number of queries executed using this Lucene index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryExecutionTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryExecutionTime</h4> |
| <pre>public long getQueryExecutionTime()</pre> |
| <div class="block">Returns the time duration for execution of queries using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>long value for the time in nanoseconds consumed in the execution of queries using this |
| Lucene Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryRateAverageLatency--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryRateAverageLatency</h4> |
| <pre>public long getQueryRateAverageLatency()</pre> |
| <div class="block">Returns the average latency for query executions using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the average latency for query executions in nanoseconds using the Lucene Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryExecutionsInProgress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryExecutionsInProgress</h4> |
| <pre>public int getQueryExecutionsInProgress()</pre> |
| <div class="block">Returns the number of query executions in progress which are using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of query executions in progress which are using the Lucene Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryExecutionTotalHits--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryExecutionTotalHits</h4> |
| <pre>public long getQueryExecutionTotalHits()</pre> |
| <div class="block">Returns the number of hits for the query execution using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of hits for the query execution using the Lucene Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUpdates--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpdates</h4> |
| <pre>public int getUpdates()</pre> |
| <div class="block">Returns the number of update operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of update operations on the Lucene Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUpdateTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpdateTime</h4> |
| <pre>public long getUpdateTime()</pre> |
| <div class="block">Returns the time consumed for the update operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the time consumed in nanoseconds for the update operations on the Lucene Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUpdateRateAverageLatency--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpdateRateAverageLatency</h4> |
| <pre>public long getUpdateRateAverageLatency()</pre> |
| <div class="block">Returns the average latency for the update operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the average latency for the update operations in nanoseconds on the Lucene Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUpdatesInProgress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpdatesInProgress</h4> |
| <pre>public int getUpdatesInProgress()</pre> |
| <div class="block">Returns the number of update operations in progress for the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of update operations in progress for the Lucene Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCommits--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCommits</h4> |
| <pre>public int getCommits()</pre> |
| <div class="block">Returns the number of commit operations executed on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of commit operations executed on the Lucene Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCommitTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCommitTime</h4> |
| <pre>public long getCommitTime()</pre> |
| <div class="block">Returns the time consumed by the commit operations on the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the time consumed in nanoseconds by the commit operations on the Lucene Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCommitRateAverageLatency--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCommitRateAverageLatency</h4> |
| <pre>public long getCommitRateAverageLatency()</pre> |
| <div class="block">Returns the average latency for the commit operations using the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the average latency for the commit operations in nanoseconds using the Lucene |
| Index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCommitsInProgress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCommitsInProgress</h4> |
| <pre>public int getCommitsInProgress()</pre> |
| <div class="block">Returns the number of commit operations in progress for the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the number of commit operations in progress for the Lucene Indexes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDocuments--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDocuments</h4> |
| <pre>public int getDocuments()</pre> |
| <div class="block">Returns the number of documents indexed by <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the number of documents indexed by Lucene</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <div class="block">Outputs the string message containing all the stats stored for the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string message containing all the stats stored for the Lucene Index</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/geode/cache/lucene/management/LuceneServiceMXBean.html" title="interface in org.apache.geode.cache.lucene.management"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" target="_top">Frames</a></li> |
| <li><a href="LuceneIndexMetrics.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> |
