UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

955 lines 85.4 kB
<!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 (version 1.7.0_67) on Sun Sep 07 15:29:32 CEST 2014 --> <title>StorageServiceMBean (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="StorageServiceMBean (apache-cassandra API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/StorageServiceMBean.html">Use</a></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/cassandra/service/StorageService.html" title="class in org.apache.cassandra.service"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/service/TruncateResponseHandler.html" title="class in org.apache.cassandra.service"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/service/StorageServiceMBean.html" target="_top">Frames</a></li> <li><a href="StorageServiceMBean.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</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.cassandra.service</div> <h2 title="Interface StorageServiceMBean" class="title">Interface StorageServiceMBean</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Superinterfaces:</dt> <dd>javax.management.NotificationBroadcaster, javax.management.NotificationEmitter</dd> </dl> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../../org/apache/cassandra/service/StorageService.html" title="class in org.apache.cassandra.service">StorageService</a></dd> </dl> <hr> <br> <pre>public interface <span class="strong">StorageServiceMBean</span> extends javax.management.NotificationEmitter</pre> </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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#bulkLoad(java.lang.String)">bulkLoad</a></strong>(java.lang.String&nbsp;directory)</code> <div class="block">Starts a bulk load and blocks until it completes.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#bulkLoadAsync(java.lang.String)">bulkLoadAsync</a></strong>(java.lang.String&nbsp;directory)</code> <div class="block">Starts a bulk load asynchronously and returns the String representation of the planID for the new streaming session.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#clearSnapshot(java.lang.String,%20java.lang.String...)">clearSnapshot</a></strong>(java.lang.String&nbsp;tag, java.lang.String...&nbsp;keyspaceNames)</code> <div class="block">Remove the snapshot with the given name from the given keyspaces.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#decommission()">decommission</a></strong>()</code> <div class="block">transfer this node's data to other machines and remove it from service.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#deliverHints(java.lang.String)">deliverHints</a></strong>(java.lang.String&nbsp;host)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#describeRingJMX(java.lang.String)">describeRingJMX</a></strong>(java.lang.String&nbsp;keyspace)</code> <div class="block">The same as <code>describeRing(String)</code> but converts TokenRange to the String for JMX compatibility</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#disableAutoCompaction(java.lang.String,%20java.lang.String...)">disableAutoCompaction</a></strong>(java.lang.String&nbsp;ks, java.lang.String...&nbsp;columnFamilies)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#drain()">drain</a></strong>()</code> <div class="block">makes node unavailable for writes, flushes memtables and replays commitlog.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map&lt;java.net.InetAddress,java.lang.Float&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#effectiveOwnership(java.lang.String)">effectiveOwnership</a></strong>(java.lang.String&nbsp;keyspace)</code> <div class="block">Effective ownership is % of the data each node owns given the keyspace we calculate the percentage using replication factor.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#enableAutoCompaction(java.lang.String,%20java.lang.String...)">enableAutoCompaction</a></strong>(java.lang.String&nbsp;ks, java.lang.String...&nbsp;columnFamilies)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#forceKeyspaceCleanup(java.lang.String,%20java.lang.String...)">forceKeyspaceCleanup</a></strong>(java.lang.String&nbsp;keyspaceName, java.lang.String...&nbsp;columnFamilies)</code> <div class="block">Trigger a cleanup of keys on a single keyspace</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#forceKeyspaceCompaction(java.lang.String,%20java.lang.String...)">forceKeyspaceCompaction</a></strong>(java.lang.String&nbsp;keyspaceName, java.lang.String...&nbsp;columnFamilies)</code> <div class="block">Forces major compaction of a single keyspace</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#forceKeyspaceFlush(java.lang.String,%20java.lang.String...)">forceKeyspaceFlush</a></strong>(java.lang.String&nbsp;keyspaceName, java.lang.String...&nbsp;columnFamilies)</code> <div class="block">Flush all memtables for the given column families, or all columnfamilies for the given keyspace if none are explicitly listed.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#forceRemoveCompletion()">forceRemoveCompletion</a></strong>()</code> <div class="block">Force a remove operation to finish.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#forceRepairAsync(java.lang.String,%20boolean,%20boolean,%20boolean,%20boolean,%20java.lang.String...)">forceRepairAsync</a></strong>(java.lang.String&nbsp;keyspace, boolean&nbsp;isSequential, boolean&nbsp;isLocal, boolean&nbsp;primaryRange, boolean&nbsp;fullRepair, java.lang.String...&nbsp;columnFamilies)</code> <div class="block">Invoke repair asynchronously.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#forceRepairAsync(java.lang.String,%20boolean,%20java.util.Collection,%20java.util.Collection,%20boolean,%20boolean,%20java.lang.String...)">forceRepairAsync</a></strong>(java.lang.String&nbsp;keyspace, boolean&nbsp;isSequential, java.util.Collection&lt;java.lang.String&gt;&nbsp;dataCenters, java.util.Collection&lt;java.lang.String&gt;&nbsp;hosts, boolean&nbsp;primaryRange, boolean&nbsp;repairedAt, java.lang.String...&nbsp;columnFamilies)</code> <div class="block">Invoke repair asynchronously.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#forceRepairRangeAsync(java.lang.String,%20java.lang.String,%20java.lang.String,%20boolean,%20boolean,%20boolean,%20java.lang.String...)">forceRepairRangeAsync</a></strong>(java.lang.String&nbsp;beginToken, java.lang.String&nbsp;endToken, java.lang.String&nbsp;keyspaceName, boolean&nbsp;isSequential, boolean&nbsp;isLocal, boolean&nbsp;repairedAt, java.lang.String...&nbsp;columnFamilies)</code> <div class="block">Same as forceRepairAsync, but handles a specified range</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#forceRepairRangeAsync(java.lang.String,%20java.lang.String,%20java.lang.String,%20boolean,%20java.util.Collection,%20java.util.Collection,%20boolean,%20java.lang.String...)">forceRepairRangeAsync</a></strong>(java.lang.String&nbsp;beginToken, java.lang.String&nbsp;endToken, java.lang.String&nbsp;keyspaceName, boolean&nbsp;isSequential, java.util.Collection&lt;java.lang.String&gt;&nbsp;dataCenters, java.util.Collection&lt;java.lang.String&gt;&nbsp;hosts, boolean&nbsp;repairedAt, java.lang.String...&nbsp;columnFamilies)</code> <div class="block">Same as forceRepairAsync, but handles a specified range</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#forceTerminateAllRepairSessions()">forceTerminateAllRepairSessions</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String[]</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getAllDataFileLocations()">getAllDataFileLocations</a></strong>()</code> <div class="block">Get the list of all data file locations from conf</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getClusterName()">getClusterName</a></strong>()</code> <div class="block">Returns the name of the cluster</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getCommitLogLocation()">getCommitLogLocation</a></strong>()</code> <div class="block">Get location of the commit log</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getCompactionThroughputMbPerSec()">getCompactionThroughputMbPerSec</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getCurrentGenerationNumber()">getCurrentGenerationNumber</a></strong>()</code> <div class="block">Return the generation value for this node.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getDrainProgress()">getDrainProgress</a></strong>()</code> <div class="block">get the progress of a drain operation</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getExceptionCount()">getExceptionCount</a></strong>()</code> <div class="block"><strong>Deprecated.</strong>&nbsp;</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getHostIdMap()">getHostIdMap</a></strong>()</code> <div class="block">Retrieve the mapping of endpoint to host ID</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getJoiningNodes()">getJoiningNodes</a></strong>()</code> <div class="block">Retrieve the list of nodes currently bootstrapping into the ring.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getKeyspaces()">getKeyspaces</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getLeavingNodes()">getLeavingNodes</a></strong>()</code> <div class="block">Retrieve the list of nodes currently leaving the ring.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getLiveNodes()">getLiveNodes</a></strong>()</code> <div class="block">Retrieve the list of live nodes in the cluster, where "liveness" is determined by the failure detector of the node being queried.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>double</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getLoad()">getLoad</a></strong>()</code> <div class="block"><strong>Deprecated.</strong>&nbsp;</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getLoadMap()">getLoadMap</a></strong>()</code> <div class="block">Human-readable load value.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getLoadString()">getLoadString</a></strong>()</code> <div class="block">Human-readable load value</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getLocalHostId()">getLocalHostId</a></strong>()</code> <div class="block">Retrieve this hosts unique ID</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getLoggingLevels()">getLoggingLevels</a></strong>()</code> <div class="block">get the runtime logging levels</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getMovingNodes()">getMovingNodes</a></strong>()</code> <div class="block">Retrieve the list of nodes currently moving in the ring.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List&lt;java.net.InetAddress&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getNaturalEndpoints(java.lang.String,%20java.nio.ByteBuffer)">getNaturalEndpoints</a></strong>(java.lang.String&nbsp;keyspaceName, java.nio.ByteBuffer&nbsp;key)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List&lt;java.net.InetAddress&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getNaturalEndpoints(java.lang.String,%20java.lang.String,%20java.lang.String)">getNaturalEndpoints</a></strong>(java.lang.String&nbsp;keyspaceName, java.lang.String&nbsp;cf, java.lang.String&nbsp;key)</code> <div class="block">This method returns the N endpoints that are responsible for storing the specified key i.e for replication.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getOperationMode()">getOperationMode</a></strong>()</code> <div class="block">get the operational mode (leaving, joining, normal, decommissioned, client)</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map&lt;java.net.InetAddress,java.lang.Float&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getOwnership()">getOwnership</a></strong>()</code> <div class="block">given a list of tokens (representing the nodes in the cluster), returns a mapping from "token -> %age of cluster owned by that token"</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getPartitionerName()">getPartitionerName</a></strong>()</code> <div class="block">Returns the cluster partitioner</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map&lt;java.util.List&lt;java.lang.String&gt;,java.util.List&lt;java.lang.String&gt;&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getPendingRangeToEndpointMap(java.lang.String)">getPendingRangeToEndpointMap</a></strong>(java.lang.String&nbsp;keyspace)</code> <div class="block">Retrieve a map of pending ranges to endpoints that describe the ring topology</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Map&lt;java.util.List&lt;java.lang.String&gt;,java.util.List&lt;java.lang.String&gt;&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getRangeToEndpointMap(java.lang.String)">getRangeToEndpointMap</a></strong>(java.lang.String&nbsp;keyspace)</code> <div class="block">Retrieve a map of range to end points that describe the ring topology of a Cassandra cluster.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map&lt;java.util.List&lt;java.lang.String&gt;,java.util.List&lt;java.lang.String&gt;&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getRangeToRpcaddressMap(java.lang.String)">getRangeToRpcaddressMap</a></strong>(java.lang.String&nbsp;keyspace)</code> <div class="block">Retrieve a map of range to rpc addresses that describe the ring topology of a Cassandra cluster.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getReleaseVersion()">getReleaseVersion</a></strong>()</code> <div class="block">Fetch a string representation of the Cassandra version.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getRemovalStatus()">getRemovalStatus</a></strong>()</code> <div class="block">Get the status of a token removal.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getSavedCachesLocation()">getSavedCachesLocation</a></strong>()</code> <div class="block">Get location of the saved caches dir</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getSchemaVersion()">getSchemaVersion</a></strong>()</code> <div class="block">Fetch a string representation of the current Schema version.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Map&lt;java.lang.String,javax.management.openmbean.TabularData&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getSnapshotDetails()">getSnapshotDetails</a></strong>()</code> <div class="block">Get the details of all the snapshot</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getStreamThroughputMbPerSec()">getStreamThroughputMbPerSec</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getTokens()">getTokens</a></strong>()</code> <div class="block">Fetch string representations of the tokens for this node.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getTokens(java.lang.String)">getTokens</a></strong>(java.lang.String&nbsp;endpoint)</code> <div class="block">Fetch string representations of the tokens for a specified node.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getTokenToEndpointMap()">getTokenToEndpointMap</a></strong>()</code> <div class="block">Retrieve a map of tokens to endpoints, including the bootstrapping ones.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getTombstoneFailureThreshold()">getTombstoneFailureThreshold</a></strong>()</code> <div class="block">Returns the threshold for abandoning queries with many tombstones</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getTombstoneWarnThreshold()">getTombstoneWarnThreshold</a></strong>()</code> <div class="block">Returns the threshold for warning of queries with many tombstones</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>double</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getTracingProbability()">getTracingProbability</a></strong>()</code> <div class="block">Returns the configured tracing probability.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#getUnreachableNodes()">getUnreachableNodes</a></strong>()</code> <div class="block">Retrieve the list of unreachable nodes in the cluster, as determined by this node's failure detector.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#isIncrementalBackupsEnabled()">isIncrementalBackupsEnabled</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#isInitialized()">isInitialized</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#isJoined()">isJoined</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#isNativeTransportRunning()">isNativeTransportRunning</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#isRPCServerRunning()">isRPCServerRunning</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#joinRing()">joinRing</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#loadNewSSTables(java.lang.String,%20java.lang.String)">loadNewSSTables</a></strong>(java.lang.String&nbsp;ksName, java.lang.String&nbsp;cfName)</code> <div class="block">Load new SSTables to the given keyspace/columnFamily</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#move(java.lang.String)">move</a></strong>(java.lang.String&nbsp;newToken)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#rebuild(java.lang.String)">rebuild</a></strong>(java.lang.String&nbsp;sourceDc)</code> <div class="block">Initiate a process of streaming data for which we are responsible from other nodes.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#rebuildSecondaryIndex(java.lang.String,%20java.lang.String,%20java.lang.String...)">rebuildSecondaryIndex</a></strong>(java.lang.String&nbsp;ksName, java.lang.String&nbsp;cfName, java.lang.String...&nbsp;idxNames)</code> <div class="block">rebuild the specified indexes</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#removeNode(java.lang.String)">removeNode</a></strong>(java.lang.String&nbsp;token)</code> <div class="block">removeToken removes token (and all data associated with enpoint that had it) from the ring</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#rescheduleFailedDeletions()">rescheduleFailedDeletions</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#resetLocalSchema()">resetLocalSchema</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#sampleKeyRange()">sampleKeyRange</a></strong>()</code> <div class="block">Return a List of Tokens representing a sample of keys across all ColumnFamilyStores.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#scrub(boolean,%20boolean,%20java.lang.String,%20java.lang.String...)">scrub</a></strong>(boolean&nbsp;disableSnapshot, boolean&nbsp;skipCorrupted, java.lang.String&nbsp;keyspaceName, java.lang.String...&nbsp;columnFamilies)</code> <div class="block">Scrub (deserialize + reserialize at the latest version, skipping bad rows if any) the given keyspace.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#setCompactionThroughputMbPerSec(int)">setCompactionThroughputMbPerSec</a></strong>(int&nbsp;value)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#setHintedHandoffThrottleInKB(int)">setHintedHandoffThrottleInKB</a></strong>(int&nbsp;throttleInKB)</code> <div class="block">Sets the hinted handoff throttle in kb per second, per delivery thread.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#setIncrementalBackupsEnabled(boolean)">setIncrementalBackupsEnabled</a></strong>(boolean&nbsp;value)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#setLoggingLevel(java.lang.String,%20java.lang.String)">setLoggingLevel</a></strong>(java.lang.String&nbsp;classQualifier, java.lang.String&nbsp;level)</code> <div class="block">set the logging level at runtime<br> <br> If both classQualifer and level are empty/null, it will reload the configuration to reset.<br> If classQualifer is not empty but level is empty/null, it will set the level to null for the defined classQualifer<br> If level cannot be parsed, then the level will be defaulted to DEBUG<br> <br> The logback configuration should have < jmxConfigurator /> set</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#setStreamThroughputMbPerSec(int)">setStreamThroughputMbPerSec</a></strong>(int&nbsp;value)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#setTombstoneFailureThreshold(int)">setTombstoneFailureThreshold</a></strong>(int&nbsp;tombstoneDebugThreshold)</code> <div class="block">Sets the threshold for abandoning queries with many tombstones</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#setTombstoneWarnThreshold(int)">setTombstoneWarnThreshold</a></strong>(int&nbsp;tombstoneDebugThreshold)</code> <div class="block">Sets the threshold for warning queries with many tombstones</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#setTraceProbability(double)">setTraceProbability</a></strong>(double&nbsp;probability)</code> <div class="block">Enables/Disables tracing for the whole system.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#startGossiping()">startGossiping</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#startNativeTransport()">startNativeTransport</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#startRPCServer()">startRPCServer</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#stopDaemon()">stopDaemon</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#stopGossiping()">stopGossiping</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#stopNativeTransport()">stopNativeTransport</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#stopRPCServer()">stopRPCServer</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#takeColumnFamilySnapshot(java.lang.String,%20java.lang.String,%20java.lang.String)">takeColumnFamilySnapshot</a></strong>(java.lang.String&nbsp;keyspaceName, java.lang.String&nbsp;columnFamilyName, java.lang.String&nbsp;tag)</code> <div class="block">Takes the snapshot of a specific column family.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#takeSnapshot(java.lang.String,%20java.lang.String...)">takeSnapshot</a></strong>(java.lang.String&nbsp;tag, java.lang.String...&nbsp;keyspaceNames)</code> <div class="block">Takes the snapshot for the given keyspaces.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#trueSnapshotsSize()">trueSnapshotsSize</a></strong>()</code> <div class="block">Get the true size taken by all snapshots across all keyspaces.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#truncate(java.lang.String,%20java.lang.String)">truncate</a></strong>(java.lang.String&nbsp;keyspace, java.lang.String&nbsp;columnFamily)</code> <div class="block">Truncates (deletes) the given columnFamily from the provided keyspace.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#updateSnitch(java.lang.String,%20java.lang.Boolean,%20java.lang.Integer,%20java.lang.Integer,%20java.lang.Double)">updateSnitch</a></strong>(java.lang.String&nbsp;epSnitchClassName, java.lang.Boolean&nbsp;dynamic, java.lang.Integer&nbsp;dynamicUpdateInterval, java.lang.Integer&nbsp;dynamicResetInterval, java.lang.Double&nbsp;dynamicBadnessThreshold)</code> <div class="block">Change endpointsnitch class and dynamic-ness (and dynamic attributes) at runtime</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html#upgradeSSTables(java.lang.String,%20boolean,%20java.lang.String...)">upgradeSSTables</a></strong>(java.lang.String&nbsp;keyspaceName, boolean&nbsp;excludeCurrentVersion, java.lang.String...&nbsp;columnFamilies)</code> <div class="block">Rewrite all sstables to the latest version.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_javax.management.NotificationEmitter"> <!-- --> </a> <h3>Methods inherited from interface&nbsp;javax.management.NotificationEmitter</h3> <code>removeNotificationListener</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_javax.management.NotificationBroadcaster"> <!-- --> </a> <h3>Methods inherited from interface&nbsp;javax.management.NotificationBroadcaster</h3> <code>addNotificationListener, getNotificationInfo, removeNotificationListener</code></li> </ul> </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="getLiveNodes()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLiveNodes</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;getLiveNodes()</pre> <div class="block">Retrieve the list of live nodes in the cluster, where "liveness" is determined by the failure detector of the node being queried.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>set of IP addresses, as Strings</dd></dl> </li> </ul> <a name="getUnreachableNodes()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getUnreachableNodes</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;getUnreachableNodes()</pre> <div class="block">Retrieve the list of unreachable nodes in the cluster, as determined by this node's failure detector.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>set of IP addresses, as Strings</dd></dl> </li> </ul> <a name="getJoiningNodes()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getJoiningNodes</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;getJoiningNodes()</pre> <div class="block">Retrieve the list of nodes currently bootstrapping into the ring.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>set of IP addresses, as Strings</dd></dl> </li> </ul> <a name="getLeavingNodes()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLeavingNodes</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;getLeavingNodes()</pre> <div class="block">Retrieve the list of nodes currently leaving the ring.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>set of IP addresses, as Strings</dd></dl> </li> </ul> <a name="getMovingNodes()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMovingNodes</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;getMovingNodes()</pre> <div class="block">Retrieve the list of nodes currently moving in the ring.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>set of IP addresses, as Strings</dd></dl> </li> </ul> <a name="getTokens()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTokens</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;getTokens()</pre> <div class="block">Fetch string representations of the tokens for this node.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>a collection of tokens formatted as strings</dd></dl> </li> </ul> <a name="getTokens(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTokens</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;getTokens(java.lang.String&nbsp;endpoint) throws java.net.UnknownHostException</pre> <div class="block">Fetch string representations of the tokens for a specified node.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>endpoint</code> - string representation of an node</dd> <dt><span class="strong">Returns:</span></dt><dd>a collection of tokens formatted as strings</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.net.UnknownHostException</code></dd></dl> </li> </ul> <a name="getReleaseVersion()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getReleaseVersion</h4> <pre>java.lang.String&nbsp;getReleaseVersion()</pre> <div class="block">Fetch a string representation of the Cassandra version.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>A string representation of the Cassandra version.</dd></dl> </li> </ul> <a name="getSchemaVersion()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSchemaVersion</h4> <pre>java.lang.String&nbsp;getSchemaVersion()</pre> <div class="block">Fetch a string representation of the current Schema version.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>A string representation of the Schema version.</dd></dl> </li> </ul> <a name="getAllDataFileLocations()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getAllDataFileLocations</h4> <pre>java.lang.String[]&nbsp;getAllDataFileLocations()</pre> <div class="block">Get the list of all data file locations from conf</div> <dl><dt><span class="strong">Returns:</span></dt><dd>String array of all locations</dd></dl> </li> </ul> <a name="getCommitLogLocation()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCommitLogLocation</h4> <pre>java.lang.String&nbsp;getCommitLogLocation()</pre> <div class="block">Get location of the commit log</div> <dl><dt><span class="strong">Returns:</span></dt><dd>a string path</dd></dl> </li> </ul> <a name="getSavedCachesLocation()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSavedCachesLocation</h4> <pre>java.lang.String&nbsp;getSavedCachesLocation()</pre> <div class="block">Get location of the saved caches dir</div> <dl><dt><span class="strong">Returns:</span></dt><dd>a string path</dd></dl> </li> </ul> <a name="getRangeToEndpointMap(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRangeToEndpointMap</h4> <pre>java.util.Map&lt;java.util.List&lt;java.lang.String&gt;,java.util.List&lt;java.lang.String&gt;&gt;&nbsp;getRangeToEndpointMap(java.lang.String&nbsp;keyspace)</pre> <div class="block">Retrieve a map of range to end points that describe the ring topology of a Cassandra cluster.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>mapping of ranges to end points</dd></dl> </li> </ul> <a name="getRangeToRpcaddressMap(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRangeToRpcaddressMap</h4> <pre>java.util.Map&lt;java.util.List&lt;java.lang.String&gt;,java.util.List&lt;java.lang.String&gt;&gt;&nbsp;getRangeToRpcaddressMap(java.lang.String&nbsp;keyspace)</pre> <div class="block">Retrieve a map of range to rpc addresses that describe the ring topology of a Cassandra cluster.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>mapping of ranges to rpc addresses</dd></dl> </li> </ul> <a name="describeRingJMX(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>describeRingJMX</h4> <pre>java.util.List&lt;java.lang.String&gt;&nbsp;describeRingJMX(java.lang.String&nbsp;keyspace) throws java.io.IOException</pre> <div class="block">The same as <code>describeRing(String)</code> but converts TokenRange to the String for JMX compatibility</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspace</code> - The keyspace to fetch information about</dd> <dt><span class="strong">Returns:</span></dt><dd>a List of TokenRange(s) converted to String for the given keyspace</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="getPendingRangeToEndpointMap(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPendingRangeToEndpointMap</h4> <pre>java.util.Map&lt;java.util.List&lt;java.lang.String&gt;,java.util.List&lt;java.lang.String&gt;&gt;&nbsp;getPendingRangeToEndpointMap(java.lang.String&nbsp;keyspace)</pre> <div class="block">Retrieve a map of pending ranges to endpoints that describe the ring topology</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspace</code> - the keyspace to get the pending range map for.</dd> <dt><span class="strong">Returns:</span></dt><dd>a map of pending ranges to endpoints</dd></dl> </li> </ul> <a name="getTokenToEndpointMap()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTokenToEndpointMap</h4> <pre>java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;getTokenToEndpointMap()</pre> <div class="block">Retrieve a map of tokens to endpoints, including the bootstrapping ones.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>a map of tokens to endpoints in ascending order</dd></dl> </li> </ul> <a name="getLocalHostId()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLocalHostId</h4> <pre>java.lang.String&nbsp;getLocalHostId()</pre> <div class="block">Retrieve this hosts unique ID</div> </li> </ul> <a name="getHostIdMap()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getHostIdMap</h4> <pre>java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;getHostIdMap()</pre> <div class="block">Retrieve the mapping of endpoint to host ID</div> </li> </ul> <a name="getLoad()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLoad</h4> <pre>@Deprecated double&nbsp;getLoad()</pre> <div class="block"><span class="strong">Deprecated.</span>&nbsp;</div> <div class="block">Numeric load value.</