cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
452 lines (451 loc) • 18.5 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:30 CEST 2014 -->
<title>CompactionInfo (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="CompactionInfo (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/CompactionInfo.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/db/compaction/CompactionHistoryTabularData.html" title="class in org.apache.cassandra.db.compaction"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/db/compaction/CompactionInfo.html" target="_top">Frames</a></li>
<li><a href="CompactionInfo.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.db.compaction</div>
<h2 title="Class CompactionInfo" class="title">Class CompactionInfo</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.db.compaction.CompactionInfo</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">CompactionInfo</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">Implements serializable to allow structured info to be returned via JMX.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.cassandra.db.compaction.CompactionInfo">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction">CompactionInfo.Holder</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#CompactionInfo(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.db.compaction.OperationType,%20long,%20long)">CompactionInfo</a></strong>(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm,
<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a> tasktype,
long bytesComplete,
long totalBytes)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#CompactionInfo(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.db.compaction.OperationType,%20long,%20long,%20java.lang.String)">CompactionInfo</a></strong>(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm,
<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a> tasktype,
long completed,
long total,
java.lang.String unit)</code> </td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#CompactionInfo(org.apache.cassandra.db.compaction.OperationType,%20long,%20long,%20java.lang.String)">CompactionInfo</a></strong>(<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a> tasktype,
long completed,
long total,
java.lang.String unit)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </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>java.util.Map<java.lang.String,java.lang.String></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#asMap()">asMap</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html" title="class in org.apache.cassandra.db.compaction">CompactionInfo</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#forProgress(long,%20long)">forProgress</a></strong>(long complete,
long total)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#getCFMetaData()">getCFMetaData</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#getColumnFamily()">getColumnFamily</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#getCompleted()">getCompleted</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.UUID</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#getId()">getId</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#getKeyspace()">getKeyspace</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#getTaskType()">getTaskType</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#getTotal()">getTotal</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html#toString()">toString</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CompactionInfo(org.apache.cassandra.config.CFMetaData, org.apache.cassandra.db.compaction.OperationType, long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CompactionInfo</h4>
<pre>public CompactionInfo(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm,
<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a> tasktype,
long bytesComplete,
long totalBytes)</pre>
</li>
</ul>
<a name="CompactionInfo(org.apache.cassandra.db.compaction.OperationType, long, long, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CompactionInfo</h4>
<pre>public CompactionInfo(<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a> tasktype,
long completed,
long total,
java.lang.String unit)</pre>
</li>
</ul>
<a name="CompactionInfo(org.apache.cassandra.config.CFMetaData, org.apache.cassandra.db.compaction.OperationType, long, long, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CompactionInfo</h4>
<pre>public CompactionInfo(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm,
<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a> tasktype,
long completed,
long total,
java.lang.String unit)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="forProgress(long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forProgress</h4>
<pre>public <a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.html" title="class in org.apache.cassandra.db.compaction">CompactionInfo</a> forProgress(long complete,
long total)</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>A copy of this CompactionInfo with updated progress.</dd></dl>
</li>
</ul>
<a name="getId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>public java.util.UUID getId()</pre>
</li>
</ul>
<a name="getKeyspace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyspace</h4>
<pre>public java.lang.String getKeyspace()</pre>
</li>
</ul>
<a name="getColumnFamily()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnFamily</h4>
<pre>public java.lang.String getColumnFamily()</pre>
</li>
</ul>
<a name="getCFMetaData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCFMetaData</h4>
<pre>public <a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> getCFMetaData()</pre>
</li>
</ul>
<a name="getCompleted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompleted</h4>
<pre>public long getCompleted()</pre>
</li>
</ul>
<a name="getTotal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotal</h4>
<pre>public long getTotal()</pre>
</li>
</ul>
<a name="getTaskType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTaskType</h4>
<pre>public <a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a> getTaskType()</pre>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="asMap()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asMap</h4>
<pre>public java.util.Map<java.lang.String,java.lang.String> asMap()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/CompactionInfo.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/db/compaction/CompactionHistoryTabularData.html" title="class in org.apache.cassandra.db.compaction"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/db/compaction/CompactionInfo.html" target="_top">Frames</a></li>
<li><a href="CompactionInfo.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>