blob: 6e62c364ecef40cc659640e80defc47d58a50c5f [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>
<!-- Generated by javadoc (1.8.0_291) on Mon Jan 10 11:05:26 MSK 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DataRegionConfiguration (Ignite 2.12.0)</title>
<meta name="date" content="2022-01-10">
<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'/>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DataRegionConfiguration (Ignite 2.12.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":42,"i6":42,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":42,"i23":42,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DataRegionConfiguration.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/configuration/DataPageEvictionMode.html" title="enum in org.apache.ignite.configuration"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/configuration/DataStorageConfiguration.html" title="class in org.apache.ignite.configuration"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/configuration/DataRegionConfiguration.html" target="_top">Frames</a></li>
<li><a href="DataRegionConfiguration.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.configuration</div>
<h2 title="Class DataRegionConfiguration" class="title">Class DataRegionConfiguration</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.ignite.configuration.DataRegionConfiguration</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">DataRegionConfiguration</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">This class allows defining custom data regions' configurations with various parameters for Apache Ignite
page memory (see <a href="../../../../org/apache/ignite/configuration/DataStorageConfiguration.html" title="class in org.apache.ignite.configuration"><code>DataStorageConfiguration</code></a>. For each configured data region Apache Ignite instantiates
respective memory regions with different parameters like maximum size, eviction policy, swapping options,
persistent mode flag, etc.
An Apache Ignite cache can be mapped to a particular region using
<a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html#setDataRegionName-java.lang.String-"><code>CacheConfiguration.setDataRegionName(String)</code></a> method.
<p>Sample configuration below shows how to configure several data regions:</p>
<pre>
<code>
<span class='angle_bracket'>&lt;</span>property name="memoryConfiguration"<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>bean class="org.apache.ignite.configuration.DataStorageConfiguration"<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="defaultRegionConfiguration"<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>bean class="org.apache.ignite.configuration.DataRegionConfiguration"<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="name" value="Default_Region"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="initialSize" value="#{100L * 1024 * 1024}"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="maxSize" value="#{5L * 1024 * 1024 * 1024}"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>/bean<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>/property<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="pageSize" value="4096"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="dataRegions"<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>list<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>bean class="org.apache.ignite.configuration.DataRegionConfiguration"<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="name" value="20MB_Region_Eviction"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="initialSize" value="#{20L * 1024 * 1024}"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="pageEvictionMode" value="RANDOM_2_LRU"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>/bean<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>bean class="org.apache.ignite.configuration.DataRegionConfiguration"<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="name" value="25MB_Region_Swapping"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="initialSize" value="#{25L * 1024 * 1024}"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="maxSize" value="#{100L * 1024 * 1024}"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>property name="swapPath" value="db/swap"/<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>/bean<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>/list<span class='angle_bracket'>&gt;</span>
<span class='angle_bracket'>&lt;</span>/property<span class='angle_bracket'>&gt;</span>
</code>
</pre></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.ignite.configuration.DataRegionConfiguration">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#DFLT_METRICS_ENABLED">DFLT_METRICS_ENABLED</a></span></code>
<div class="block">Default metrics enabled flag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/ignite/configuration/PageReplacementMode.html" title="enum in org.apache.ignite.configuration">PageReplacementMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#DFLT_PAGE_REPLACEMENT_MODE">DFLT_PAGE_REPLACEMENT_MODE</a></span></code>
<div class="block">Default page replacement mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#DFLT_RATE_TIME_INTERVAL_MILLIS">DFLT_RATE_TIME_INTERVAL_MILLIS</a></span></code>
<div class="block">Default length of interval over which <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a> metric is calculated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#DFLT_SUB_INTERVALS">DFLT_SUB_INTERVALS</a></span></code>
<div class="block">Default amount of sub intervals to calculate <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a> metric.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#DataRegionConfiguration--">DataRegionConfiguration</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/configuration/DataRegionConfiguration.html#getCheckpointPageBufferSize--">getCheckpointPageBufferSize</a></span>()</code>
<div class="block">Gets amount of memory allocated for a checkpoint temporary buffer.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getEmptyPagesPoolSize--">getEmptyPagesPoolSize</a></span>()</code>
<div class="block">Specifies the minimal number of empty pages to be present in reuse lists for this data region.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getEvictionThreshold--">getEvictionThreshold</a></span>()</code>
<div class="block">Gets a threshold for memory pages eviction initiation.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getInitialSize--">getInitialSize</a></span>()</code>
<div class="block">Gets initial memory region size defined by this data region.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getMaxSize--">getMaxSize</a></span>()</code>
<div class="block">Maximum memory region size defined by this data region.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getMetricsRateTimeInterval--">getMetricsRateTimeInterval</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/ignite/mxbean/MetricsMxBean.html#configureHitRateMetric-java.lang.String-long-"><code>MetricsMxBean.configureHitRateMetric(String, long)</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getMetricsSubIntervalCount--">getMetricsSubIntervalCount</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/ignite/mxbean/MetricsMxBean.html#configureHitRateMetric-java.lang.String-long-"><code>MetricsMxBean.configureHitRateMetric(String, long)</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getName--">getName</a></span>()</code>
<div class="block">Gets data region name.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html" title="enum in org.apache.ignite.configuration">DataPageEvictionMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getPageEvictionMode--">getPageEvictionMode</a></span>()</code>
<div class="block">Gets memory pages eviction mode.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/PageReplacementMode.html" title="enum in org.apache.ignite.configuration">PageReplacementMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getPageReplacementMode--">getPageReplacementMode</a></span>()</code>
<div class="block">Gets memory pages replacement mode.</div>
</td>
</tr>
<tr id="i10" 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/configuration/DataRegionConfiguration.html#getSwapPath--">getSwapPath</a></span>()</code>
<div class="block">A path to the memory-mapped files the memory region defined by this data region will be mapped to.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>@Nullable <a href="../../../../org/apache/ignite/configuration/WarmUpConfiguration.html" title="interface in org.apache.ignite.configuration">WarmUpConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getWarmUpConfiguration--">getWarmUpConfiguration</a></span>()</code>
<div class="block">Gets warm-up configuration.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#isLazyMemoryAllocation--">isLazyMemoryAllocation</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#isMetricsEnabled--">isMetricsEnabled</a></span>()</code>
<div class="block">Gets whether memory metrics are enabled by default on node startup.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#isPersistenceEnabled--">isPersistenceEnabled</a></span>()</code>
<div class="block">Gets whether persistence is enabled for this data region.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setCheckpointPageBufferSize-long-">setCheckpointPageBufferSize</a></span>(long&nbsp;checkpointPageBufSize)</code>
<div class="block">Sets amount of memory allocated for the checkpoint temporary buffer.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setEmptyPagesPoolSize-int-">setEmptyPagesPoolSize</a></span>(int&nbsp;emptyPagesPoolSize)</code>
<div class="block">Specifies the minimal number of empty pages to be present in reuse lists for this data region.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setEvictionThreshold-double-">setEvictionThreshold</a></span>(double&nbsp;evictionThreshold)</code>
<div class="block">Sets memory pages eviction threshold.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setInitialSize-long-">setInitialSize</a></span>(long&nbsp;initSize)</code>
<div class="block">Sets initial memory region size defined by this data region.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setLazyMemoryAllocation-boolean-">setLazyMemoryAllocation</a></span>(boolean&nbsp;lazyMemoryAllocation)</code>
<div class="block">Sets <code>lazyMemoryAllocation</code> flag value.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setMaxSize-long-">setMaxSize</a></span>(long&nbsp;maxSize)</code>
<div class="block">Sets maximum memory region size defined by this data region.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setMetricsEnabled-boolean-">setMetricsEnabled</a></span>(boolean&nbsp;metricsEnabled)</code>
<div class="block">Sets memory metrics enabled flag.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setMetricsRateTimeInterval-long-">setMetricsRateTimeInterval</a></span>(long&nbsp;metricsRateTimeInterval)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/ignite/mxbean/MetricsMxBean.html#configureHitRateMetric-java.lang.String-long-"><code>MetricsMxBean.configureHitRateMetric(String, long)</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setMetricsSubIntervalCount-int-">setMetricsSubIntervalCount</a></span>(int&nbsp;metricsSubIntervalCnt)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/ignite/mxbean/MetricsMxBean.html#configureHitRateMetric-java.lang.String-long-"><code>MetricsMxBean.configureHitRateMetric(String, long)</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setName-java.lang.String-">setName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Sets data region name.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setPageEvictionMode-org.apache.ignite.configuration.DataPageEvictionMode-">setPageEvictionMode</a></span>(<a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html" title="enum in org.apache.ignite.configuration">DataPageEvictionMode</a>&nbsp;evictionMode)</code>
<div class="block">Sets memory pages eviction mode.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setPageReplacementMode-org.apache.ignite.configuration.PageReplacementMode-">setPageReplacementMode</a></span>(<a href="../../../../org/apache/ignite/configuration/PageReplacementMode.html" title="enum in org.apache.ignite.configuration">PageReplacementMode</a>&nbsp;replacementMode)</code>
<div class="block">Sets memory pages replacement mode.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setPersistenceEnabled-boolean-">setPersistenceEnabled</a></span>(boolean&nbsp;persistenceEnabled)</code>
<div class="block">Sets persistence enabled flag.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setSwapPath-java.lang.String-">setSwapPath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;swapPath)</code>
<div class="block">Sets a path to the memory-mapped files.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setWarmUpConfiguration-org.apache.ignite.configuration.WarmUpConfiguration-">setWarmUpConfiguration</a></span>(@Nullable <a href="../../../../org/apache/ignite/configuration/WarmUpConfiguration.html" title="interface in org.apache.ignite.configuration">WarmUpConfiguration</a>&nbsp;warmUpCfg)</code>
<div class="block">Sets warm-up configuration.</div>
</td>
</tr>
<tr id="i30" 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/configuration/DataRegionConfiguration.html#toString--">toString</a></span>()</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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DFLT_METRICS_ENABLED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DFLT_METRICS_ENABLED</h4>
<pre>public static final&nbsp;boolean DFLT_METRICS_ENABLED</pre>
<div class="block">Default metrics enabled flag.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.ignite.configuration.DataRegionConfiguration.DFLT_METRICS_ENABLED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DFLT_SUB_INTERVALS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DFLT_SUB_INTERVALS</h4>
<pre>public static final&nbsp;int DFLT_SUB_INTERVALS</pre>
<div class="block">Default amount of sub intervals to calculate <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a> metric.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.ignite.configuration.DataRegionConfiguration.DFLT_SUB_INTERVALS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DFLT_RATE_TIME_INTERVAL_MILLIS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DFLT_RATE_TIME_INTERVAL_MILLIS</h4>
<pre>public static final&nbsp;int DFLT_RATE_TIME_INTERVAL_MILLIS</pre>
<div class="block">Default length of interval over which <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a> metric is calculated.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.ignite.configuration.DataRegionConfiguration.DFLT_RATE_TIME_INTERVAL_MILLIS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DFLT_PAGE_REPLACEMENT_MODE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DFLT_PAGE_REPLACEMENT_MODE</h4>
<pre>public static final&nbsp;<a href="../../../../org/apache/ignite/configuration/PageReplacementMode.html" title="enum in org.apache.ignite.configuration">PageReplacementMode</a> DFLT_PAGE_REPLACEMENT_MODE</pre>
<div class="block">Default page replacement mode.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DataRegionConfiguration--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DataRegionConfiguration</h4>
<pre>public&nbsp;DataRegionConfiguration()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<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;getName()</pre>
<div class="block">Gets data region name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Data region name.</dd>
</dl>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setName(<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">Sets data region name. The name must be non empty and must not be equal to the reserved 'sysMemPlc' one.
If not specified, <a href="../../../../org/apache/ignite/configuration/DataStorageConfiguration.html#DFLT_DATA_REG_DEFAULT_NAME"><code>DataStorageConfiguration.DFLT_DATA_REG_DEFAULT_NAME</code></a> value is used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Data region name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getMaxSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxSize</h4>
<pre>public&nbsp;long&nbsp;getMaxSize()</pre>
<div class="block">Maximum memory region size defined by this data region. If the whole data can not fit into the memory region
an out of memory exception will be thrown.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Size in bytes.</dd>
</dl>
</li>
</ul>
<a name="setMaxSize-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxSize</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setMaxSize(long&nbsp;maxSize)</pre>
<div class="block">Sets maximum memory region size defined by this data region. The total size should not be less than 10 MB
due to the internal data structures overhead.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxSize</code> - Maximum data region size in bytes.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getInitialSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialSize</h4>
<pre>public&nbsp;long&nbsp;getInitialSize()</pre>
<div class="block">Gets initial memory region size defined by this data region. When the used memory size exceeds this value,
new chunks of memory will be allocated.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Data region start size.</dd>
</dl>
</li>
</ul>
<a name="setInitialSize-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitialSize</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setInitialSize(long&nbsp;initSize)</pre>
<div class="block">Sets initial memory region size defined by this data region. When the used memory size exceeds this value,
new chunks of memory will be allocated.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>initSize</code> - Data region initial size.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getSwapPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSwapPath</h4>
<pre>public&nbsp;<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;getSwapPath()</pre>
<div class="block">A path to the memory-mapped files the memory region defined by this data region will be mapped to. Having
the path set, allows relying on swapping capabilities of an underlying operating system for the memory region.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A path to the memory-mapped files or <code>null</code> if this feature is not used for the memory region
defined by this data region.</dd>
</dl>
</li>
</ul>
<a name="setSwapPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSwapPath</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setSwapPath(<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;swapPath)</pre>
<div class="block">Sets a path to the memory-mapped files.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>swapPath</code> - A Path to the memory mapped file.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getPageEvictionMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageEvictionMode</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html" title="enum in org.apache.ignite.configuration">DataPageEvictionMode</a>&nbsp;getPageEvictionMode()</pre>
<div class="block">Gets memory pages eviction mode. If <a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html#DISABLED"><code>DataPageEvictionMode.DISABLED</code></a> is used (default) then an out of
memory exception will be thrown if the memory region usage, defined by this data region, goes beyond its
capacity which is <a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getMaxSize--"><code>getMaxSize()</code></a>.
Note: Page eviction is used only when persistence is disabled for data region. For persistent data regions see
page replacement mode (<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getPageReplacementMode--"><code>getPageReplacementMode()</code></a>).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Memory pages eviction algorithm. <a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html#DISABLED"><code>DataPageEvictionMode.DISABLED</code></a> used by default.</dd>
</dl>
</li>
</ul>
<a name="setPageEvictionMode-org.apache.ignite.configuration.DataPageEvictionMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageEvictionMode</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setPageEvictionMode(<a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html" title="enum in org.apache.ignite.configuration">DataPageEvictionMode</a>&nbsp;evictionMode)</pre>
<div class="block">Sets memory pages eviction mode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>evictionMode</code> - Eviction mode.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getPageReplacementMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageReplacementMode</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/PageReplacementMode.html" title="enum in org.apache.ignite.configuration">PageReplacementMode</a>&nbsp;getPageReplacementMode()</pre>
<div class="block">Gets memory pages replacement mode. If persistence is enabled and Ignite store on disk more data then available
data region memory (<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getMaxSize--"><code>getMaxSize()</code></a>) page replacement can be started to rotate memory pages with the disk.
This parameter defines the algorithm to find pages to replace.
Note: For not persistent data regions see page eviction mode (<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#getPageEvictionMode--"><code>getPageEvictionMode()</code></a>).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Memory pages replacement algorithm. <a href="../../../../org/apache/ignite/configuration/PageReplacementMode.html#CLOCK"><code>PageReplacementMode.CLOCK</code></a> used by default.</dd>
</dl>
</li>
</ul>
<a name="setPageReplacementMode-org.apache.ignite.configuration.PageReplacementMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageReplacementMode</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setPageReplacementMode(<a href="../../../../org/apache/ignite/configuration/PageReplacementMode.html" title="enum in org.apache.ignite.configuration">PageReplacementMode</a>&nbsp;replacementMode)</pre>
<div class="block">Sets memory pages replacement mode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>replacementMode</code> - Page replacement mode.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getEvictionThreshold--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEvictionThreshold</h4>
<pre>public&nbsp;double&nbsp;getEvictionThreshold()</pre>
<div class="block">Gets a threshold for memory pages eviction initiation. For instance, if the threshold is 0.9 it means that the
page memory will start the eviction only after 90% of the data region is occupied.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Memory pages eviction threshold.</dd>
</dl>
</li>
</ul>
<a name="setEvictionThreshold-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEvictionThreshold</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setEvictionThreshold(double&nbsp;evictionThreshold)</pre>
<div class="block">Sets memory pages eviction threshold.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>evictionThreshold</code> - Eviction threshold.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getEmptyPagesPoolSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEmptyPagesPoolSize</h4>
<pre>public&nbsp;int&nbsp;getEmptyPagesPoolSize()</pre>
<div class="block">Specifies the minimal number of empty pages to be present in reuse lists for this data region.
This parameter ensures that Ignite will be able to successfully evict old data entries when the size of
(key, value) pair is slightly larger than page size / 2.
Increase this parameter if cache can contain very big entries (total size of pages in this pool should be enough
to contain largest cache entry).
Increase this parameter if <code>IgniteOutOfMemoryException</code> occurred with enabled page eviction.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Minimum number of empty pages in reuse list.</dd>
</dl>
</li>
</ul>
<a name="setEmptyPagesPoolSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEmptyPagesPoolSize</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setEmptyPagesPoolSize(int&nbsp;emptyPagesPoolSize)</pre>
<div class="block">Specifies the minimal number of empty pages to be present in reuse lists for this data region.
This parameter ensures that Ignite will be able to successfully evict old data entries when the size of
(key, value) pair is slightly larger than page size / 2.
Increase this parameter if cache can contain very big entries (total size of pages in this pool should be enough
to contain largest cache entry).
Increase this parameter if <code>IgniteOutOfMemoryException</code> occurred with enabled page eviction.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>emptyPagesPoolSize</code> - Empty pages pool size.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="isMetricsEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMetricsEnabled</h4>
<pre>public&nbsp;boolean&nbsp;isMetricsEnabled()</pre>
<div class="block">Gets whether memory metrics are enabled by default on node startup. Memory metrics can be enabled and disabled
at runtime via memory metrics <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><code>MX bean</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Metrics enabled flag.</dd>
</dl>
</li>
</ul>
<a name="setMetricsEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetricsEnabled</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setMetricsEnabled(boolean&nbsp;metricsEnabled)</pre>
<div class="block">Sets memory metrics enabled flag. If this flag is <code>true</code>, metrics will be enabled on node startup.
Memory metrics can be enabled and disabled at runtime via memory metrics <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><code>MX bean</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>metricsEnabled</code> - Metrics enabled flag.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="isPersistenceEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPersistenceEnabled</h4>
<pre>public&nbsp;boolean&nbsp;isPersistenceEnabled()</pre>
<div class="block">Gets whether persistence is enabled for this data region. All caches residing in this region will be persistent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Persistence enabled flag.</dd>
</dl>
</li>
</ul>
<a name="setPersistenceEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPersistenceEnabled</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setPersistenceEnabled(boolean&nbsp;persistenceEnabled)</pre>
<div class="block">Sets persistence enabled flag.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>persistenceEnabled</code> - Persistence enabled flag.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getMetricsRateTimeInterval--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricsRateTimeInterval</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>
public&nbsp;long&nbsp;getMetricsRateTimeInterval()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../org/apache/ignite/mxbean/MetricsMxBean.html#configureHitRateMetric-java.lang.String-long-"><code>MetricsMxBean.configureHitRateMetric(String, long)</code></a> instead.</span></div>
<div class="block">Gets time interval for <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a>
and <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getEvictionRate--"><code>DataRegionMetrics.getEvictionRate()</code></a> monitoring purposes.
<p>
For instance, after setting the interval to 60_000 milliseconds,
subsequent calls to <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a>
will return average allocation rate (pages per second) for the last minute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Time interval over which allocation rate is calculated.</dd>
</dl>
</li>
</ul>
<a name="setMetricsRateTimeInterval-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetricsRateTimeInterval</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>
public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setMetricsRateTimeInterval(long&nbsp;metricsRateTimeInterval)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../org/apache/ignite/mxbean/MetricsMxBean.html#configureHitRateMetric-java.lang.String-long-"><code>MetricsMxBean.configureHitRateMetric(String, long)</code></a> instead.</span></div>
<div class="block">Sets time interval for <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a>
and <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getEvictionRate--"><code>DataRegionMetrics.getEvictionRate()</code></a> monitoring purposes.
<p>
For instance, after setting the interval to 60 seconds,
subsequent calls to <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a>
will return average allocation rate (pages per second) for the last minute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>metricsRateTimeInterval</code> - Time interval used for allocation and eviction rates calculations.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getMetricsSubIntervalCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricsSubIntervalCount</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>
public&nbsp;int&nbsp;getMetricsSubIntervalCount()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../org/apache/ignite/mxbean/MetricsMxBean.html#configureHitRateMetric-java.lang.String-long-"><code>MetricsMxBean.configureHitRateMetric(String, long)</code></a> instead.</span></div>
<div class="block">Gets a number of sub-intervals the whole <a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setMetricsRateTimeInterval-long-"><code>setMetricsRateTimeInterval(long)</code></a>
will be split into to calculate <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a>
and <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getEvictionRate--"><code>DataRegionMetrics.getEvictionRate()</code></a> rates (5 by default).
<p>
Setting it to a bigger value will result in more precise calculation and smaller drops of
<a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a> metric when next sub-interval has to be recycled but introduces bigger
calculation overhead.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of sub intervals.</dd>
</dl>
</li>
</ul>
<a name="setMetricsSubIntervalCount-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetricsSubIntervalCount</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>
public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setMetricsSubIntervalCount(int&nbsp;metricsSubIntervalCnt)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../org/apache/ignite/mxbean/MetricsMxBean.html#configureHitRateMetric-java.lang.String-long-"><code>MetricsMxBean.configureHitRateMetric(String, long)</code></a> instead.</span></div>
<div class="block">Sets a number of sub-intervals the whole <a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html#setMetricsRateTimeInterval-long-"><code>setMetricsRateTimeInterval(long)</code></a> will be split into to calculate
<a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getEvictionRate--"><code>DataRegionMetrics.getEvictionRate()</code></a> rates (5 by default).
<p>
Setting it to a bigger value will result in more precise calculation and smaller drops of
<a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate--"><code>DataRegionMetrics.getAllocationRate()</code></a> metric when next sub-interval has to be recycled but introduces bigger
calculation overhead.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>metricsSubIntervalCnt</code> - A number of sub-intervals.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getCheckpointPageBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCheckpointPageBufferSize</h4>
<pre>public&nbsp;long&nbsp;getCheckpointPageBufferSize()</pre>
<div class="block">Gets amount of memory allocated for a checkpoint temporary buffer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Checkpoint page buffer size in bytes or <code>0</code> for Ignite
to choose the buffer size automatically.</dd>
</dl>
</li>
</ul>
<a name="setCheckpointPageBufferSize-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCheckpointPageBufferSize</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setCheckpointPageBufferSize(long&nbsp;checkpointPageBufSize)</pre>
<div class="block">Sets amount of memory allocated for the checkpoint temporary buffer. The buffer is used to create temporary
copies of pages that are being written to disk and being update in parallel while the checkpoint is in
progress.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>checkpointPageBufSize</code> - Checkpoint page buffer size in bytes or <code>0</code> for Ignite to
choose the buffer size automatically.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="isLazyMemoryAllocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLazyMemoryAllocation</h4>
<pre>public&nbsp;boolean&nbsp;isLazyMemoryAllocation()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> if memory for <code>DataRegion</code> will be allocated only on the creation of the first cache
belonged to this <code>DataRegion</code>.</dd>
</dl>
</li>
</ul>
<a name="setLazyMemoryAllocation-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLazyMemoryAllocation</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setLazyMemoryAllocation(boolean&nbsp;lazyMemoryAllocation)</pre>
<div class="block">Sets <code>lazyMemoryAllocation</code> flag value.
If <code>true</code>, memory for <code>DataRegion</code> will be allocated only on the creation of the first cache
belonged to this <code>DataRegion</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lazyMemoryAllocation</code> - Flag value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="setWarmUpConfiguration-org.apache.ignite.configuration.WarmUpConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWarmUpConfiguration</h4>
<pre>public&nbsp;<a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration">DataRegionConfiguration</a>&nbsp;setWarmUpConfiguration(@Nullable
@Nullable <a href="../../../../org/apache/ignite/configuration/WarmUpConfiguration.html" title="interface in org.apache.ignite.configuration">WarmUpConfiguration</a>&nbsp;warmUpCfg)</pre>
<div class="block">Sets warm-up configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>warmUpCfg</code> - Warm-up configuration. Can be <code>null</code> (default
<a href="../../../../org/apache/ignite/configuration/DataStorageConfiguration.html#getDefaultWarmUpConfiguration--"><code>DataStorageConfiguration.getDefaultWarmUpConfiguration()</code></a> will be used).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="getWarmUpConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWarmUpConfiguration</h4>
<pre>@Nullable
public&nbsp;@Nullable <a href="../../../../org/apache/ignite/configuration/WarmUpConfiguration.html" title="interface in org.apache.ignite.configuration">WarmUpConfiguration</a>&nbsp;getWarmUpConfiguration()</pre>
<div class="block">Gets warm-up configuration.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Warm-up configuration.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<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;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</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/DataRegionConfiguration.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/configuration/DataPageEvictionMode.html" title="enum in org.apache.ignite.configuration"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/configuration/DataStorageConfiguration.html" title="class in org.apache.ignite.configuration"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/configuration/DataRegionConfiguration.html" target="_top">Frames</a></li>
<li><a href="DataRegionConfiguration.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>2022 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.12.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; January 10 2022 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>