| <!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>LuceneServiceMXBean (Apache Geode 1.15.0)</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="LuceneServiceMXBean (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/geode/cache/lucene/management/LuceneServiceMXBean.html" target="_top">Frames</a></li> |
| <li><a href="LuceneServiceMXBean.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface LuceneServiceMXBean" class="title">Interface LuceneServiceMXBean</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">LuceneServiceMXBean</span></pre> |
| <div class="block">MBean that provides access to the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneService.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneService</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management">LuceneIndexMetrics</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneServiceMXBean.html#listIndexMetrics--">listIndexMetrics</a></span>()</code> |
| <div class="block">Returns an array of <a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management"><code>LuceneIndexMetrics</code></a> for the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> instances defined in this member</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management">LuceneIndexMetrics</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneServiceMXBean.html#listIndexMetrics-java.lang.String-">listIndexMetrics</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)</code> |
| <div class="block">Returns an array of <a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management"><code>LuceneIndexMetrics</code></a> for the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> instances defined on the input region in this |
| member</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management">LuceneIndexMetrics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneServiceMXBean.html#listIndexMetrics-java.lang.String-java.lang.String-">listIndexMetrics</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)</code> |
| <div class="block">Returns a <a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management"><code>LuceneIndexMetrics</code></a> for the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> |
| with the input index name defined on the input region in this member.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="listIndexMetrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listIndexMetrics</h4> |
| <pre><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management">LuceneIndexMetrics</a>[] listIndexMetrics()</pre> |
| <div class="block">Returns an array of <a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management"><code>LuceneIndexMetrics</code></a> for the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> instances defined in this member</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array of LuceneIndexMetrics for the LuceneIndexes defined in this member</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listIndexMetrics-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listIndexMetrics</h4> |
| <pre><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management">LuceneIndexMetrics</a>[] listIndexMetrics(<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)</pre> |
| <div class="block">Returns an array of <a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management"><code>LuceneIndexMetrics</code></a> for the |
| <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> instances defined on the input region in this |
| member</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionPath</code> - The full path of the region to retrieve</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array of LuceneIndexMetrics for the LuceneIndex instances defined on the input |
| region in this member</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listIndexMetrics-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>listIndexMetrics</h4> |
| <pre><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management">LuceneIndexMetrics</a> listIndexMetrics(<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)</pre> |
| <div class="block">Returns a <a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management"><code>LuceneIndexMetrics</code></a> for the <a href="../../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneIndex</code></a> |
| with the input index name defined on the input region in this member.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionPath</code> - The full path of the region to retrieve</dd> |
| <dd><code>indexName</code> - The name of the index to retrieve</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a LuceneIndexMetrics for the LuceneIndex with the input index name defined on the input |
| region in this member.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/geode/cache/lucene/management/LuceneIndexMetrics.html" title="class in org.apache.geode.cache.lucene.management"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/geode/cache/lucene/management/LuceneServiceMXBean.html" target="_top">Frames</a></li> |
| <li><a href="LuceneServiceMXBean.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
