blob: b9c806c8dd619bd4b1e33cad33e88ae5d8080014 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Yandex.Metrika counter -->
<script type="text/javascript" >
(function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
(window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
ym(72949126, "init", {
clickmap:true,
trackLinks:true,
accurateTrackBounce:true,
webvisor:true
});
</script>
<noscript><div><img src="https://mc.yandex.ru/watch/72949126" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
<!-- /Yandex.Metrika counter -->
<script type='text/javascript'>
window.__lo_site_id = 284467;
(function() {
var wa = document.createElement('script'); wa.type = 'text/javascript'; wa.async = true;
wa.src = 'https://d10lpsik1i8c69.cloudfront.net/w.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wa, s);
})();
</script>
<link rel="canonical" href="https://ignite.apache.org/releases/latest/javadoc/org/apache/ignite/cache/CacheMetrics.html" />
<!-- Generated by javadoc (1.8.0_261) on Wed Dec 09 14:33:09 MSK 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CacheMetrics (Ignite 2.9.1)</title>
<meta name="date" content="2020-12-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CacheMetrics (Ignite 2.9.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":38,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":38,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":38,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":38,"i54":6,"i55":38,"i56":6,"i57":38,"i58":6,"i59":38,"i60":6,"i61":38,"i62":6,"i63":6,"i64":6,"i65":38,"i66":6,"i67":38,"i68":6,"i69":6,"i70":6,"i71":6,"i72":6,"i73":6,"i74":6,"i75":6,"i76":6,"i77":6,"i78":6,"i79":6,"i80":6,"i81":6,"i82":6,"i83":6,"i84":6,"i85":6,"i86":6,"i87":6,"i88":6,"i89":38};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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="class-use/CacheMetrics.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/ignite/cache/CacheManager.html" title="class in org.apache.ignite.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/cache/CacheMode.html" title="enum in org.apache.ignite.cache"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/cache/CacheMetrics.html" target="_top">Frames</a></li>
<li><a href="CacheMetrics.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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.ignite.cache</div>
<h2 title="Interface CacheMetrics" class="title">Interface CacheMetrics</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/ignite/mxbean/CacheMetricsMXBean.html" title="interface in org.apache.ignite.mxbean">CacheMetricsMXBean</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CacheMetrics</span></pre>
<div class="block">Cache metrics used to obtain statistics on cache itself.
Use <a href="../../../../org/apache/ignite/IgniteCache.html#metrics--"><code>IgniteCache.metrics()</code></a> to obtain metrics for a cache.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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/ignite/cache/CacheMetrics.html#estimateRebalancingFinishTime--">estimateRebalancingFinishTime</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getAverageGetTime--">getAverageGetTime</a></span>()</code>
<div class="block">The mean time to execute gets.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getAveragePutTime--">getAveragePutTime</a></span>()</code>
<div class="block">The mean time to execute puts.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getAverageRemoveTime--">getAverageRemoveTime</a></span>()</code>
<div class="block">The mean time to execute removes.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getAverageTxCommitTime--">getAverageTxCommitTime</a></span>()</code>
<div class="block">The mean time to execute tx commit.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getAverageTxRollbackTime--">getAverageTxRollbackTime</a></span>()</code>
<div class="block">The mean time to execute tx rollbacks.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheEvictions--">getCacheEvictions</a></span>()</code>
<div class="block">The total number of evictions from the cache.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheGets--">getCacheGets</a></span>()</code>
<div class="block">The total number of requests to the cache.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheHitPercentage--">getCacheHitPercentage</a></span>()</code>
<div class="block">This is a measure of cache efficiency.</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/ignite/cache/CacheMetrics.html#getCacheHits--">getCacheHits</a></span>()</code>
<div class="block">The number of get requests that were satisfied by the cache.</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/ignite/cache/CacheMetrics.html#getCacheMisses--">getCacheMisses</a></span>()</code>
<div class="block">A miss is a get request that is not satisfied.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheMissPercentage--">getCacheMissPercentage</a></span>()</code>
<div class="block">Returns the percentage of cache accesses that did not find a requested entry
in the cache.</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/ignite/cache/CacheMetrics.html#getCachePuts--">getCachePuts</a></span>()</code>
<div class="block">The total number of puts to the cache.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheRemovals--">getCacheRemovals</a></span>()</code>
<div class="block">The total number of removals from the cache.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheSize--">getCacheSize</a></span>()</code>
<div class="block">Cache size.</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/ignite/cache/CacheMetrics.html#getCacheTxCommits--">getCacheTxCommits</a></span>()</code>
<div class="block">Gets total number of transaction commits.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheTxRollbacks--">getCacheTxRollbacks</a></span>()</code>
<div class="block">Gets total number of transaction rollbacks.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getDhtEvictQueueCurrentSize--">getDhtEvictQueueCurrentSize</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorAverageInvocationTime--">getEntryProcessorAverageInvocationTime</a></span>()</code>
<div class="block">The mean time to execute cache invokes.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorHitPercentage--">getEntryProcessorHitPercentage</a></span>()</code>
<div class="block">The percentage of invocations on keys, which exist in cache.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorHits--">getEntryProcessorHits</a></span>()</code>
<div class="block">The total number of invocations on keys, which exist in cache.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorInvocations--">getEntryProcessorInvocations</a></span>()</code>
<div class="block">The total number of cache invocations.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorMaxInvocationTime--">getEntryProcessorMaxInvocationTime</a></span>()</code>
<div class="block">So far, the maximum time to execute cache invokes.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorMinInvocationTime--">getEntryProcessorMinInvocationTime</a></span>()</code>
<div class="block">So far, the minimum time to execute cache invokes.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorMisses--">getEntryProcessorMisses</a></span>()</code>
<div class="block">The total number of invocations on keys, which don't exist in cache.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorMissPercentage--">getEntryProcessorMissPercentage</a></span>()</code>
<div class="block">The percentage of invocations on keys, which don't exist in cache.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorPuts--">getEntryProcessorPuts</a></span>()</code>
<div class="block">The total number of cache invocations, caused update.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorReadOnlyInvocations--">getEntryProcessorReadOnlyInvocations</a></span>()</code>
<div class="block">The total number of cache invocations, caused no updates.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEntryProcessorRemovals--">getEntryProcessorRemovals</a></span>()</code>
<div class="block">The total number of cache invocations, caused removal.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEstimatedRebalancingFinishTime--">getEstimatedRebalancingFinishTime</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEstimatedRebalancingKeys--">getEstimatedRebalancingKeys</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getHeapEntriesCount--">getHeapEntriesCount</a></span>()</code>
<div class="block">Gets the number of cache entries in heap memory, including entries held by active transactions, entries in
onheap cache and near entries.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getKeySize--">getKeySize</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Can overflow. Use <a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheSize--"><code>getCacheSize()</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getKeysToRebalanceLeft--">getKeysToRebalanceLeft</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i34" 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/ignite/cache/CacheMetrics.html#getKeyType--">getKeyType</a></span>()</code>
<div class="block">Determines the required type of keys for this <code>Cache</code>, if any.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapAllocatedSize--">getOffHeapAllocatedSize</a></span>()</code>
<div class="block">Gets memory size allocated in off-heap.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapBackupEntriesCount--">getOffHeapBackupEntriesCount</a></span>()</code>
<div class="block">Gets number of backup entries stored in off-heap memory.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapEntriesCount--">getOffHeapEntriesCount</a></span>()</code>
<div class="block">Gets number of entries stored in off-heap memory.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapEvictions--">getOffHeapEvictions</a></span>()</code>
<div class="block">The total number of evictions from the off-heap memory.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapGets--">getOffHeapGets</a></span>()</code>
<div class="block">The total number of get requests to the off-heap memory.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapHitPercentage--">getOffHeapHitPercentage</a></span>()</code>
<div class="block">Gets the percentage of hits on off-heap memory.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapHits--">getOffHeapHits</a></span>()</code>
<div class="block">The number of get requests that were satisfied by the off-heap memory.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapMisses--">getOffHeapMisses</a></span>()</code>
<div class="block">A miss is a get request that is not satisfied by off-heap memory.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapMissPercentage--">getOffHeapMissPercentage</a></span>()</code>
<div class="block">Gets the percentage of misses on off-heap memory.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapPrimaryEntriesCount--">getOffHeapPrimaryEntriesCount</a></span>()</code>
<div class="block">Gets number of primary entries stored in off-heap memory.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapPuts--">getOffHeapPuts</a></span>()</code>
<div class="block">The total number of put requests to the off-heap memory.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getOffHeapRemovals--">getOffHeapRemovals</a></span>()</code>
<div class="block">The total number of removals from the off-heap memory.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getRebalanceClearingPartitionsLeft--">getRebalanceClearingPartitionsLeft</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getRebalancedKeys--">getRebalancedKeys</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getRebalancingBytesRate--">getRebalancingBytesRate</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getRebalancingKeysRate--">getRebalancingKeysRate</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getRebalancingPartitionsCount--">getRebalancingPartitionsCount</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getRebalancingStartTime--">getRebalancingStartTime</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getSize--">getSize</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Can overflow. Use <a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheSize--"><code>getCacheSize()</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTotalPartitionsCount--">getTotalPartitionsCount</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxCommitQueueSize--">getTxCommitQueueSize</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxCommittedVersionsSize--">getTxCommittedVersionsSize</a></span>()</code>
<div class="block">Gets number of cached committed transaction IDs.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxDhtCommitQueueSize--">getTxDhtCommitQueueSize</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxDhtCommittedVersionsSize--">getTxDhtCommittedVersionsSize</a></span>()</code>
<div class="block">Gets number of cached committed DHT transaction IDs.</div>
</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxDhtPrepareQueueSize--">getTxDhtPrepareQueueSize</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxDhtRolledbackVersionsSize--">getTxDhtRolledbackVersionsSize</a></span>()</code>
<div class="block">Gets number of cached rolled back DHT transaction IDs.</div>
</td>
</tr>
<tr id="i61" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxDhtStartVersionCountsSize--">getTxDhtStartVersionCountsSize</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i62" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxDhtThreadMapSize--">getTxDhtThreadMapSize</a></span>()</code>
<div class="block">Gets transaction DHT per-thread map size.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxDhtXidMapSize--">getTxDhtXidMapSize</a></span>()</code>
<div class="block">Gets transaction DHT per-Xid map size.</div>
</td>
</tr>
<tr id="i64" class="altColor">
<td class="colFirst"><code>@NotNull <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/ignite/cache/CacheMetrics.html#getTxKeyCollisions--">getTxKeyCollisions</a></span>()</code>
<div class="block">Checks if there were any tx key collisions last time.</div>
</td>
</tr>
<tr id="i65" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxPrepareQueueSize--">getTxPrepareQueueSize</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i66" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxRolledbackVersionsSize--">getTxRolledbackVersionsSize</a></span>()</code>
<div class="block">Gets number of cached rolled back transaction IDs.</div>
</td>
</tr>
<tr id="i67" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxStartVersionCountsSize--">getTxStartVersionCountsSize</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i68" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxThreadMapSize--">getTxThreadMapSize</a></span>()</code>
<div class="block">Gets transaction per-thread map size.</div>
</td>
</tr>
<tr id="i69" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getTxXidMapSize--">getTxXidMapSize</a></span>()</code>
<div class="block">Gets transaction per-Xid map size.</div>
</td>
</tr>
<tr id="i70" 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/ignite/cache/CacheMetrics.html#getValueType--">getValueType</a></span>()</code>
<div class="block">Determines the required type of values for this <code>Cache</code>, if any.</div>
</td>
</tr>
<tr id="i71" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getWriteBehindBufferSize--">getWriteBehindBufferSize</a></span>()</code>
<div class="block">Gets count of entries that were processed by the write-behind store and have not been
flushed to the underlying store yet.</div>
</td>
</tr>
<tr id="i72" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getWriteBehindCriticalOverflowCount--">getWriteBehindCriticalOverflowCount</a></span>()</code>
<div class="block">Gets count of write buffer overflow events in progress at the moment.</div>
</td>
</tr>
<tr id="i73" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getWriteBehindErrorRetryCount--">getWriteBehindErrorRetryCount</a></span>()</code>
<div class="block">Gets count of cache entries that are in a store-retry state.</div>
</td>
</tr>
<tr id="i74" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getWriteBehindFlushFrequency--">getWriteBehindFlushFrequency</a></span>()</code>
<div class="block">Gets the cache flush frequency.</div>
</td>
</tr>
<tr id="i75" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getWriteBehindFlushSize--">getWriteBehindFlushSize</a></span>()</code>
<div class="block">Gets the maximum size of the write-behind buffer.</div>
</td>
</tr>
<tr id="i76" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getWriteBehindFlushThreadCount--">getWriteBehindFlushThreadCount</a></span>()</code>
<div class="block">Gets the number of flush threads that will perform store update operations.</div>
</td>
</tr>
<tr id="i77" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getWriteBehindStoreBatchSize--">getWriteBehindStoreBatchSize</a></span>()</code>
<div class="block">Gets the maximum count of similar (put or remove) operations that can be grouped to a single batch.</div>
</td>
</tr>
<tr id="i78" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getWriteBehindTotalCriticalOverflowCount--">getWriteBehindTotalCriticalOverflowCount</a></span>()</code>
<div class="block">Gets count of write buffer overflow events since initialization.</div>
</td>
</tr>
<tr id="i79" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#isEmpty--">isEmpty</a></span>()</code>
<div class="block">Returns <code>true</code> if this cache is empty.</div>
</td>
</tr>
<tr id="i80" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#isManagementEnabled--">isManagementEnabled</a></span>()</code>
<div class="block">Checks whether management is enabled on this cache.</div>
</td>
</tr>
<tr id="i81" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#isReadThrough--">isReadThrough</a></span>()</code>
<div class="block">Determines if a <code>Cache</code> should operate in read-through mode.</div>
</td>
</tr>
<tr id="i82" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#isStatisticsEnabled--">isStatisticsEnabled</a></span>()</code>
<div class="block">Checks whether statistics collection is enabled in this cache.</div>
</td>
</tr>
<tr id="i83" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#isStoreByValue--">isStoreByValue</a></span>()</code>
<div class="block">Whether storeByValue <code>true</code> or storeByReference <code>false</code>.</div>
</td>
</tr>
<tr id="i84" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#isValidForReading--">isValidForReading</a></span>()</code>
<div class="block">Checks whether cache topology is valid for read operations.</div>
</td>
</tr>
<tr id="i85" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#isValidForWriting--">isValidForWriting</a></span>()</code>
<div class="block">Checks whether cache topology is valid for write operations.</div>
</td>
</tr>
<tr id="i86" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#isWriteBehindEnabled--">isWriteBehindEnabled</a></span>()</code>
<div class="block">Returns <code>true</code> if write-behind is enabled.</div>
</td>
</tr>
<tr id="i87" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#isWriteThrough--">isWriteThrough</a></span>()</code>
<div class="block">Determines if a <code>Cache</code> should operate in "write-through"
mode.</div>
</td>
</tr>
<tr id="i88" 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/ignite/cache/CacheMetrics.html#name--">name</a></span>()</code>
<div class="block">Gets name of this cache.</div>
</td>
</tr>
<tr id="i89" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/cache/CacheMetrics.html#rebalancingStartTime--">rebalancingStartTime</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</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="getCacheHits--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheHits</h4>
<pre>long&nbsp;getCacheHits()</pre>
<div class="block">The number of get requests that were satisfied by the cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of hits.</dd>
</dl>
</li>
</ul>
<a name="getCacheHitPercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheHitPercentage</h4>
<pre>float&nbsp;getCacheHitPercentage()</pre>
<div class="block">This is a measure of cache efficiency.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The percentage of successful hits, as a decimal e.g 75.</dd>
</dl>
</li>
</ul>
<a name="getCacheMisses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheMisses</h4>
<pre>long&nbsp;getCacheMisses()</pre>
<div class="block">A miss is a get request that is not satisfied.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of misses.</dd>
</dl>
</li>
</ul>
<a name="getCacheMissPercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheMissPercentage</h4>
<pre>float&nbsp;getCacheMissPercentage()</pre>
<div class="block">Returns the percentage of cache accesses that did not find a requested entry
in the cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The percentage of accesses that failed to find anything.</dd>
</dl>
</li>
</ul>
<a name="getCacheGets--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheGets</h4>
<pre>long&nbsp;getCacheGets()</pre>
<div class="block">The total number of requests to the cache. This will be equal to the sum of
the hits and misses.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of gets.</dd>
</dl>
</li>
</ul>
<a name="getCachePuts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCachePuts</h4>
<pre>long&nbsp;getCachePuts()</pre>
<div class="block">The total number of puts to the cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of puts.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorPuts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorPuts</h4>
<pre>long&nbsp;getEntryProcessorPuts()</pre>
<div class="block">The total number of cache invocations, caused update.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of invocation updates.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorRemovals--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorRemovals</h4>
<pre>long&nbsp;getEntryProcessorRemovals()</pre>
<div class="block">The total number of cache invocations, caused removal.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of invocation removals.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorReadOnlyInvocations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorReadOnlyInvocations</h4>
<pre>long&nbsp;getEntryProcessorReadOnlyInvocations()</pre>
<div class="block">The total number of cache invocations, caused no updates.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of read-only invocations.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorInvocations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorInvocations</h4>
<pre>long&nbsp;getEntryProcessorInvocations()</pre>
<div class="block">The total number of cache invocations.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of cache invocations.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorHits--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorHits</h4>
<pre>long&nbsp;getEntryProcessorHits()</pre>
<div class="block">The total number of invocations on keys, which exist in cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of cache invocation hits.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorHitPercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorHitPercentage</h4>
<pre>float&nbsp;getEntryProcessorHitPercentage()</pre>
<div class="block">The percentage of invocations on keys, which exist in cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The percentage of successful invocation hits.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorMisses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorMisses</h4>
<pre>long&nbsp;getEntryProcessorMisses()</pre>
<div class="block">The total number of invocations on keys, which don't exist in cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of cache invocation misses.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorMissPercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorMissPercentage</h4>
<pre>float&nbsp;getEntryProcessorMissPercentage()</pre>
<div class="block">The percentage of invocations on keys, which don't exist in cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The percentage of invocation misses.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorAverageInvocationTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorAverageInvocationTime</h4>
<pre>float&nbsp;getEntryProcessorAverageInvocationTime()</pre>
<div class="block">The mean time to execute cache invokes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The time in µs.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorMinInvocationTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorMinInvocationTime</h4>
<pre>float&nbsp;getEntryProcessorMinInvocationTime()</pre>
<div class="block">So far, the minimum time to execute cache invokes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The time in µs.</dd>
</dl>
</li>
</ul>
<a name="getEntryProcessorMaxInvocationTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryProcessorMaxInvocationTime</h4>
<pre>float&nbsp;getEntryProcessorMaxInvocationTime()</pre>
<div class="block">So far, the maximum time to execute cache invokes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The time in µs.</dd>
</dl>
</li>
</ul>
<a name="getCacheRemovals--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheRemovals</h4>
<pre>long&nbsp;getCacheRemovals()</pre>
<div class="block">The total number of removals from the cache. This does not include evictions,
where the cache itself initiates the removal to make space.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of removals.</dd>
</dl>
</li>
</ul>
<a name="getCacheEvictions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheEvictions</h4>
<pre>long&nbsp;getCacheEvictions()</pre>
<div class="block">The total number of evictions from the cache. An eviction is a removal
initiated by the cache itself to free up space. An eviction is not treated as
a removal and does not appear in the removal counts.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of evictions.</dd>
</dl>
</li>
</ul>
<a name="getAverageGetTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageGetTime</h4>
<pre>float&nbsp;getAverageGetTime()</pre>
<div class="block">The mean time to execute gets.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The time in µs.</dd>
</dl>
</li>
</ul>
<a name="getAveragePutTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAveragePutTime</h4>
<pre>float&nbsp;getAveragePutTime()</pre>
<div class="block">The mean time to execute puts.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The time in µs.</dd>
</dl>
</li>
</ul>
<a name="getAverageRemoveTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageRemoveTime</h4>
<pre>float&nbsp;getAverageRemoveTime()</pre>
<div class="block">The mean time to execute removes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The time in µs.</dd>
</dl>
</li>
</ul>
<a name="getAverageTxCommitTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageTxCommitTime</h4>
<pre>float&nbsp;getAverageTxCommitTime()</pre>
<div class="block">The mean time to execute tx commit.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The time in µs.</dd>
</dl>
</li>
</ul>
<a name="getAverageTxRollbackTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageTxRollbackTime</h4>
<pre>float&nbsp;getAverageTxRollbackTime()</pre>
<div class="block">The mean time to execute tx rollbacks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of transaction rollbacks.</dd>
</dl>
</li>
</ul>
<a name="getCacheTxCommits--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheTxCommits</h4>
<pre>long&nbsp;getCacheTxCommits()</pre>
<div class="block">Gets total number of transaction commits.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of transaction commits.</dd>
</dl>
</li>
</ul>
<a name="getCacheTxRollbacks--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheTxRollbacks</h4>
<pre>long&nbsp;getCacheTxRollbacks()</pre>
<div class="block">Gets total number of transaction rollbacks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of transaction rollbacks.</dd>
</dl>
</li>
</ul>
<a name="name--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre><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>&nbsp;name()</pre>
<div class="block">Gets name of this cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Cache name.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapGets--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapGets</h4>
<pre>long&nbsp;getOffHeapGets()</pre>
<div class="block">The total number of get requests to the off-heap memory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of gets.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapPuts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapPuts</h4>
<pre>long&nbsp;getOffHeapPuts()</pre>
<div class="block">The total number of put requests to the off-heap memory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of puts.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapRemovals--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapRemovals</h4>
<pre>long&nbsp;getOffHeapRemovals()</pre>
<div class="block">The total number of removals from the off-heap memory. This does not include evictions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of removals.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapEvictions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapEvictions</h4>
<pre>long&nbsp;getOffHeapEvictions()</pre>
<div class="block">The total number of evictions from the off-heap memory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of evictions.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapHits--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapHits</h4>
<pre>long&nbsp;getOffHeapHits()</pre>
<div class="block">The number of get requests that were satisfied by the off-heap memory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The off-heap hits number.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapHitPercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapHitPercentage</h4>
<pre>float&nbsp;getOffHeapHitPercentage()</pre>
<div class="block">Gets the percentage of hits on off-heap memory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The percentage of hits on off-heap memory.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapMisses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapMisses</h4>
<pre>long&nbsp;getOffHeapMisses()</pre>
<div class="block">A miss is a get request that is not satisfied by off-heap memory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The off-heap misses number.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapMissPercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapMissPercentage</h4>
<pre>float&nbsp;getOffHeapMissPercentage()</pre>
<div class="block">Gets the percentage of misses on off-heap memory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The percentage of misses on off-heap memory.</dd>
</dl>
</li>
</ul>
<a name="getHeapEntriesCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeapEntriesCount</h4>
<pre>long&nbsp;getHeapEntriesCount()</pre>
<div class="block">Gets the number of cache entries in heap memory, including entries held by active transactions, entries in
onheap cache and near entries.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of entries in heap memory.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapEntriesCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapEntriesCount</h4>
<pre>long&nbsp;getOffHeapEntriesCount()</pre>
<div class="block">Gets number of entries stored in off-heap memory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of entries stored in off-heap memory.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapPrimaryEntriesCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapPrimaryEntriesCount</h4>
<pre>long&nbsp;getOffHeapPrimaryEntriesCount()</pre>
<div class="block">Gets number of primary entries stored in off-heap memory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of primary entries stored in off-heap memory.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapBackupEntriesCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapBackupEntriesCount</h4>
<pre>long&nbsp;getOffHeapBackupEntriesCount()</pre>
<div class="block">Gets number of backup entries stored in off-heap memory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of backup entries stored in off-heap memory.</dd>
</dl>
</li>
</ul>
<a name="getOffHeapAllocatedSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapAllocatedSize</h4>
<pre>long&nbsp;getOffHeapAllocatedSize()</pre>
<div class="block">Gets memory size allocated in off-heap.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Memory size allocated in off-heap.</dd>
</dl>
</li>
</ul>
<a name="getSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
int&nbsp;getSize()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Can overflow. Use <a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheSize--"><code>getCacheSize()</code></a> instead.</span></div>
<div class="block">Gets number of non-<code>null</code> values in the cache.
Note this method will always return <code>0</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of non-<code>null</code> values in the cache.</dd>
</dl>
</li>
</ul>
<a name="getCacheSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheSize</h4>
<pre>long&nbsp;getCacheSize()</pre>
<div class="block">Cache size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Cache size.</dd>
</dl>
</li>
</ul>
<a name="getKeySize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeySize</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
int&nbsp;getKeySize()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Can overflow. Use <a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getCacheSize--"><code>getCacheSize()</code></a> instead.</span></div>
<div class="block">Gets number of keys in the cache, possibly with <code>null</code> values.
Note this method will always return <code>0</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of keys in the cache.</dd>
</dl>
</li>
</ul>
<a name="isEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>boolean&nbsp;isEmpty()</pre>
<div class="block">Returns <code>true</code> if this cache is empty.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> if this cache is empty.</dd>
</dl>
</li>
</ul>
<a name="getDhtEvictQueueCurrentSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDhtEvictQueueCurrentSize</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
int&nbsp;getDhtEvictQueueCurrentSize()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Gets current size of evict queue used to batch up evictions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Current size of evict queue.</dd>
</dl>
</li>
</ul>
<a name="getTxThreadMapSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxThreadMapSize</h4>
<pre>int&nbsp;getTxThreadMapSize()</pre>
<div class="block">Gets transaction per-thread map size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Thread map size.</dd>
</dl>
</li>
</ul>
<a name="getTxXidMapSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxXidMapSize</h4>
<pre>int&nbsp;getTxXidMapSize()</pre>
<div class="block">Gets transaction per-Xid map size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Transaction per-Xid map size.</dd>
</dl>
</li>
</ul>
<a name="getTxCommitQueueSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxCommitQueueSize</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
int&nbsp;getTxCommitQueueSize()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Gets committed transaction queue size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Committed transaction queue size.</dd>
</dl>
</li>
</ul>
<a name="getTxPrepareQueueSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxPrepareQueueSize</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
int&nbsp;getTxPrepareQueueSize()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Gets prepared transaction queue size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Prepared transaction queue size.</dd>
</dl>
</li>
</ul>
<a name="getTxStartVersionCountsSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxStartVersionCountsSize</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
int&nbsp;getTxStartVersionCountsSize()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Gets start version counts map size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Start version counts map size.</dd>
</dl>
</li>
</ul>
<a name="getTxCommittedVersionsSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxCommittedVersionsSize</h4>
<pre>int&nbsp;getTxCommittedVersionsSize()</pre>
<div class="block">Gets number of cached committed transaction IDs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of cached committed transaction IDs.</dd>
</dl>
</li>
</ul>
<a name="getTxRolledbackVersionsSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxRolledbackVersionsSize</h4>
<pre>int&nbsp;getTxRolledbackVersionsSize()</pre>
<div class="block">Gets number of cached rolled back transaction IDs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of cached rolled back transaction IDs.</dd>
</dl>
</li>
</ul>
<a name="getTxDhtThreadMapSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxDhtThreadMapSize</h4>
<pre>int&nbsp;getTxDhtThreadMapSize()</pre>
<div class="block">Gets transaction DHT per-thread map size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>DHT thread map size.</dd>
</dl>
</li>
</ul>
<a name="getTxDhtXidMapSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxDhtXidMapSize</h4>
<pre>int&nbsp;getTxDhtXidMapSize()</pre>
<div class="block">Gets transaction DHT per-Xid map size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Transaction DHT per-Xid map size.</dd>
</dl>
</li>
</ul>
<a name="getTxDhtCommitQueueSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxDhtCommitQueueSize</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
int&nbsp;getTxDhtCommitQueueSize()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Gets committed DHT transaction queue size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Committed DHT transaction queue size.</dd>
</dl>
</li>
</ul>
<a name="getTxDhtPrepareQueueSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxDhtPrepareQueueSize</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
int&nbsp;getTxDhtPrepareQueueSize()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Gets prepared DHT transaction queue size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Prepared DHT transaction queue size.</dd>
</dl>
</li>
</ul>
<a name="getTxDhtStartVersionCountsSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxDhtStartVersionCountsSize</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
int&nbsp;getTxDhtStartVersionCountsSize()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Gets DHT start version counts map size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>DHT start version counts map size.</dd>
</dl>
</li>
</ul>
<a name="getTxDhtCommittedVersionsSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxDhtCommittedVersionsSize</h4>
<pre>int&nbsp;getTxDhtCommittedVersionsSize()</pre>
<div class="block">Gets number of cached committed DHT transaction IDs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of cached committed DHT transaction IDs.</dd>
</dl>
</li>
</ul>
<a name="getTxDhtRolledbackVersionsSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTxDhtRolledbackVersionsSize</h4>
<pre>int&nbsp;getTxDhtRolledbackVersionsSize()</pre>
<div class="block">Gets number of cached rolled back DHT transaction IDs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of cached rolled back DHT transaction IDs.</dd>
</dl>
</li>
</ul>
<a name="isWriteBehindEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWriteBehindEnabled</h4>
<pre>boolean&nbsp;isWriteBehindEnabled()</pre>
<div class="block">Returns <code>true</code> if write-behind is enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> if write-behind is enabled.</dd>
</dl>
</li>
</ul>
<a name="getWriteBehindFlushSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteBehindFlushSize</h4>
<pre>int&nbsp;getWriteBehindFlushSize()</pre>
<div class="block">Gets the maximum size of the write-behind buffer. When the count of unique keys
in write buffer exceeds this value, the buffer is scheduled for write to the underlying store.
<p/>
If this value is <code>0</code>, then flush is performed only on time-elapsing basis. However,
when this value is <code>0</code>, the cache critical size is set to
<a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html#DFLT_WRITE_BEHIND_CRITICAL_SIZE"><code>CacheConfiguration.DFLT_WRITE_BEHIND_CRITICAL_SIZE</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Buffer size that triggers flush procedure.</dd>
</dl>
</li>
</ul>
<a name="getWriteBehindFlushThreadCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteBehindFlushThreadCount</h4>
<pre>int&nbsp;getWriteBehindFlushThreadCount()</pre>
<div class="block">Gets the number of flush threads that will perform store update operations.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Count of worker threads.</dd>
</dl>
</li>
</ul>
<a name="getWriteBehindFlushFrequency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteBehindFlushFrequency</h4>
<pre>long&nbsp;getWriteBehindFlushFrequency()</pre>
<div class="block">Gets the cache flush frequency. All pending operations on the underlying store will be performed
within time interval not less then this value.
<p/>
If this value is <code>0</code>, then flush is performed only when buffer size exceeds flush size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Flush frequency in milliseconds.</dd>
</dl>
</li>
</ul>
<a name="getWriteBehindStoreBatchSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteBehindStoreBatchSize</h4>
<pre>int&nbsp;getWriteBehindStoreBatchSize()</pre>
<div class="block">Gets the maximum count of similar (put or remove) operations that can be grouped to a single batch.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Maximum size of batch.</dd>
</dl>
</li>
</ul>
<a name="getWriteBehindTotalCriticalOverflowCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteBehindTotalCriticalOverflowCount</h4>
<pre>int&nbsp;getWriteBehindTotalCriticalOverflowCount()</pre>
<div class="block">Gets count of write buffer overflow events since initialization. Each overflow event causes
the ongoing flush operation to be performed synchronously.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Count of cache overflow events since start.</dd>
</dl>
</li>
</ul>
<a name="getWriteBehindCriticalOverflowCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteBehindCriticalOverflowCount</h4>
<pre>int&nbsp;getWriteBehindCriticalOverflowCount()</pre>
<div class="block">Gets count of write buffer overflow events in progress at the moment. Each overflow event causes
the ongoing flush operation to be performed synchronously.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Count of cache overflow events since start.</dd>
</dl>
</li>
</ul>
<a name="getWriteBehindErrorRetryCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteBehindErrorRetryCount</h4>
<pre>int&nbsp;getWriteBehindErrorRetryCount()</pre>
<div class="block">Gets count of cache entries that are in a store-retry state. An entry is assigned a store-retry state
when underlying store failed due some reason and cache has enough space to retain this entry till
the next try.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Count of entries in store-retry state.</dd>
</dl>
</li>
</ul>
<a name="getWriteBehindBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteBehindBufferSize</h4>
<pre>int&nbsp;getWriteBehindBufferSize()</pre>
<div class="block">Gets count of entries that were processed by the write-behind store and have not been
flushed to the underlying store yet.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Total count of entries in cache store internal buffer.</dd>
</dl>
</li>
</ul>
<a name="getKeyType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyType</h4>
<pre><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>&nbsp;getKeyType()</pre>
<div class="block">Determines the required type of keys for this <code>Cache</code>, if any.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The fully qualified class name of the key type,
or <code>"java.lang.Object"</code> if the type is undefined.</dd>
</dl>
</li>
</ul>
<a name="getValueType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueType</h4>
<pre><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>&nbsp;getValueType()</pre>
<div class="block">Determines the required type of values for this <code>Cache</code>, if any.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The fully qualified class name of the value type,
or <code>"java.lang.Object"</code> if the type is undefined.</dd>
</dl>
</li>
</ul>
<a name="isStoreByValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStoreByValue</h4>
<pre>boolean&nbsp;isStoreByValue()</pre>
<div class="block">Whether storeByValue <code>true</code> or storeByReference <code>false</code>.
When <code>true</code>, both keys and values are stored by value.
<p>
When <code>false</code>, both keys and values are stored by reference.
Caches stored by reference are capable of mutation by any threads holding
the reference. The effects are:
<ul>
<li>if the key is mutated, then the key may not be retrievable or
removable</li>
<li>if the value is mutated, then all threads in the JVM can potentially
observe those mutations, subject to the normal Java Memory Model rules.</li>
</ul>
Storage by reference only applies to the local heap. If an entry is moved off
heap it will need to be transformed into a representation. Any mutations that
occur after transformation may not be reflected in the cache.
<p>
When a cache is storeByValue, any mutation to the key or value does not affect
the key of value stored in the cache.
<p>
The default value is <code>true</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> if the cache is store by value.</dd>
</dl>
</li>
</ul>
<a name="getTotalPartitionsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalPartitionsCount</h4>
<pre>int&nbsp;getTotalPartitionsCount()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Total number of partitions on current node.</dd>
</dl>
</li>
</ul>
<a name="getRebalancingPartitionsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRebalancingPartitionsCount</h4>
<pre>int&nbsp;getRebalancingPartitionsCount()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of currently rebalancing partitions on current node.</dd>
</dl>
</li>
</ul>
<a name="getRebalancedKeys--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRebalancedKeys</h4>
<pre>long&nbsp;getRebalancedKeys()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of already rebalanced keys.</dd>
</dl>
</li>
</ul>
<a name="getEstimatedRebalancingKeys--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEstimatedRebalancingKeys</h4>
<pre>long&nbsp;getEstimatedRebalancingKeys()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number estimated to rebalance keys.</dd>
</dl>
</li>
</ul>
<a name="getKeysToRebalanceLeft--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeysToRebalanceLeft</h4>
<pre>long&nbsp;getKeysToRebalanceLeft()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Estimated number of keys to be rebalanced on current node.</dd>
</dl>
</li>
</ul>
<a name="getRebalancingKeysRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRebalancingKeysRate</h4>
<pre>long&nbsp;getRebalancingKeysRate()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Estimated rebalancing speed in keys.</dd>
</dl>
</li>
</ul>
<a name="getRebalancingBytesRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRebalancingBytesRate</h4>
<pre>long&nbsp;getRebalancingBytesRate()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Estimated rebalancing speed in bytes.</dd>
</dl>
</li>
</ul>
<a name="estimateRebalancingFinishTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>estimateRebalancingFinishTime</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
long&nbsp;estimateRebalancingFinishTime()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">This method is deprecated and will be deleted in future major release.
Use <a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getEstimatedRebalancingFinishTime--"><code>getEstimatedRebalancingFinishTime()</code></a> instead.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Estimated rebalancing finished time.</dd>
</dl>
</li>
</ul>
<a name="rebalancingStartTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rebalancingStartTime</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
long&nbsp;rebalancingStartTime()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">This method is deprecated and will be deleted in future major release.
Use <a href="../../../../org/apache/ignite/cache/CacheMetrics.html#getRebalancingStartTime--"><code>getRebalancingStartTime()</code></a> instead.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Rebalancing start time.</dd>
</dl>
</li>
</ul>
<a name="getEstimatedRebalancingFinishTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEstimatedRebalancingFinishTime</h4>
<pre>long&nbsp;getEstimatedRebalancingFinishTime()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Estimated rebalancing finish time.</dd>
</dl>
</li>
</ul>
<a name="getRebalancingStartTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRebalancingStartTime</h4>
<pre>long&nbsp;getRebalancingStartTime()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Rebalancing start time.</dd>
</dl>
</li>
</ul>
<a name="getRebalanceClearingPartitionsLeft--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRebalanceClearingPartitionsLeft</h4>
<pre>long&nbsp;getRebalanceClearingPartitionsLeft()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of partitions need to be cleared before actual rebalance start.</dd>
</dl>
</li>
</ul>
<a name="isStatisticsEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStatisticsEnabled</h4>
<pre>boolean&nbsp;isStatisticsEnabled()</pre>
<div class="block">Checks whether statistics collection is enabled in this cache.
<p>
The default value is <code>false</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> if statistics collection is enabled.</dd>
</dl>
</li>
</ul>
<a name="isManagementEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isManagementEnabled</h4>
<pre>boolean&nbsp;isManagementEnabled()</pre>
<div class="block">Checks whether management is enabled on this cache.
<p>
The default value is <code>false</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if management is enabled.</dd>
</dl>
</li>
</ul>
<a name="isReadThrough--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadThrough</h4>
<pre>boolean&nbsp;isReadThrough()</pre>
<div class="block">Determines if a <code>Cache</code> should operate in read-through mode.
<p>
The default value is <code>false</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> when a <code>Cache</code> is in
"read-through" mode.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>CacheLoader</code></dd>
</dl>
</li>
</ul>
<a name="isWriteThrough--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWriteThrough</h4>
<pre>boolean&nbsp;isWriteThrough()</pre>
<div class="block">Determines if a <code>Cache</code> should operate in "write-through"
mode.
<p>
will appropriately cause the configured <code>CacheWriter</code> to be invoked.
<p>
The default value is <code>false</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> when a <code>Cache</code> is in "write-through" mode.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>CacheWriter</code></dd>
</dl>
</li>
</ul>
<a name="isValidForReading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidForReading</h4>
<pre>boolean&nbsp;isValidForReading()</pre>
<div class="block">Checks whether cache topology is valid for read operations.
<p>
Note: the method will return <code>false</code> if any partition was lost despite the fact others can be awailable
for reading.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> when cache topology is valid for reading.</dd>
</dl>
</li>
</ul>
<a name="isValidForWriting--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidForWriting</h4>
<pre>boolean&nbsp;isValidForWriting()</pre>
<div class="block">Checks whether cache topology is valid for write operations.
<p>
Note: the method will return <code>false</code> if any partition was lost despite the fact others can be awailable
for writing according to configured partition loss policy.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> when cache topology is valid for writing.</dd>
</dl>
</li>
</ul>
<a name="getTxKeyCollisions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTxKeyCollisions</h4>
<pre>@NotNull
@NotNull <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>&nbsp;getTxKeyCollisions()</pre>
<div class="block">Checks if there were any tx key collisions last time.
Interval for check specified throught: <a href="../../../../org/apache/ignite/IgniteSystemProperties.html#IGNITE_DUMP_TX_COLLISIONS_INTERVAL"><code>IgniteSystemProperties.IGNITE_DUMP_TX_COLLISIONS_INTERVAL</code></a> or
<a href="../../../../org/apache/ignite/mxbean/TransactionsMXBean.html#setTxKeyCollisionsInterval-int-"><code>TransactionsMXBean.setTxKeyCollisionsInterval(int)</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Key collisions and appropriate queue size string representation.</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="class-use/CacheMetrics.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/ignite/cache/CacheManager.html" title="class in org.apache.ignite.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/cache/CacheMode.html" title="enum in org.apache.ignite.cache"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/cache/CacheMetrics.html" target="_top">Frames</a></li>
<li><a href="CacheMetrics.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&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.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2020 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.9.1</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; December 9 2020 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>