| <!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_272) on Thu Nov 12 16:27:23 PST 2020 --> |
| <title>RegionAttributes (Apache Geode 1.13.1)</title> |
| <meta name="date" content="2020-11-12"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RegionAttributes (Apache Geode 1.13.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":38,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":38,"i13":38,"i14":6,"i15":38,"i16":38,"i17":6,"i18":38,"i19":38,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":38,"i31":38,"i32":6,"i33":6,"i34":6,"i35":38,"i36":6,"i37":38,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6}; |
| 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="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/cache/RegionAccessException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/RegionDestroyedException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/cache/RegionAttributes.html" target="_top">Frames</a></li> |
| <li><a href="RegionAttributes.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.geode.cache</div> |
| <h2 title="Interface RegionAttributes" class="title">Interface RegionAttributes<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RegionAttributes<K,V></span></pre> |
| <div class="block">Defines attributes for configuring a region. These are <code>EvictionAttributes</code>, |
| <code>CacheListener</code>, <code>CacheLoader</code>, <code>CacheWriter</code>, scope, data |
| policy, and expiration attributes for the region itself, expiration attributes for the region |
| entries, and whether statistics are enabled for the region and its entries. |
| |
| To create an instance of this interface use <a href="../../../../org/apache/geode/cache/AttributesFactory.html#createRegionAttributes--"><code>AttributesFactory.createRegionAttributes()</code></a>. |
| |
| For compatibility rules and default values, see <a href="../../../../org/apache/geode/cache/AttributesFactory.html" title="class in org.apache.geode.cache"><code>AttributesFactory</code></a>. |
| |
| <p> |
| Note that the <code>RegionAttributes</code> are not distributed with the region.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html" title="class in org.apache.geode.cache"><code>AttributesFactory</code></a>, |
| <a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="interface in org.apache.geode.cache"><code>AttributesMutator</code></a>, |
| <a href="../../../../org/apache/geode/cache/Region.html#getAttributes--"><code>Region.getAttributes()</code></a>, |
| <a href="../../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache"><code>EvictionAttributes</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<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/geode/cache/RegionAttributes.html#getAsyncEventQueueIds--">getAsyncEventQueueIds</a></span>()</code> |
| <div class="block">Returns a set of AsyncEventQueueIds added to the region</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCacheListener--">getCacheListener</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCacheListeners--"><code>getCacheListeners()</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCacheListeners--">getCacheListeners</a></span>()</code> |
| <div class="block">Returns an array of all the cache listeners on this attributes.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache">CacheLoader</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCacheLoader--">getCacheLoader</a></span>()</code> |
| <div class="block">Returns the cache loader associated with this region.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCacheWriter--">getCacheWriter</a></span>()</code> |
| <div class="block">Returns the cache writer associated with this region.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCloningEnabled--">getCloningEnabled</a></span>()</code> |
| <div class="block">Returns whether or not cloning is enabled on region.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/compression/Compressor.html" title="interface in org.apache.geode.compression">Compressor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCompressor--">getCompressor</a></span>()</code> |
| <div class="block">Returns the compressor used by this region's entry values.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getConcurrencyChecksEnabled--">getConcurrencyChecksEnabled</a></span>()</code> |
| <div class="block">Returns true if concurrent update checks are turned on for this region.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getConcurrencyLevel--">getConcurrencyLevel</a></span>()</code> |
| <div class="block">Returns the concurrencyLevel of the entries map.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCustomEntryIdleTimeout--">getCustomEntryIdleTimeout</a></span>()</code> |
| <div class="block">Gets the <code>idleTimeout</code> <code>CustomExpiry</code>, if any for entries in this region</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCustomEntryTimeToLive--">getCustomEntryTimeToLive</a></span>()</code> |
| <div class="block">Gets the <code>entryTimeToLive</code> <code>CustomExpiry</code>, if any for entries in this |
| region</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getDataPolicy--">getDataPolicy</a></span>()</code> |
| <div class="block">Returns the data policy for this region.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getDiskDirs--">getDiskDirs</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html#getDiskDirs--"><code>DiskStore.getDiskDirs()</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getDiskDirSizes--">getDiskDirSizes</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html#getDiskDirSizes--"><code>DiskStore.getDiskDirSizes()</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i14" 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/geode/cache/RegionAttributes.html#getDiskStoreName--">getDiskStoreName</a></span>()</code> |
| <div class="block">Returns the name of the <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a> that this region belongs to, if any.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskWriteAttributes.html" title="interface in org.apache.geode.cache">DiskWriteAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getDiskWriteAttributes--">getDiskWriteAttributes</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#getDiskStoreName--"><code>getDiskStoreName()</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEarlyAck--">getEarlyAck</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Setting early ack no longer has any effect.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEnableAsyncConflation--">getEnableAsyncConflation</a></span>()</code> |
| <div class="block">Returns whether or not async conflation is enabled for sending messages to async peers.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEnableBridgeConflation--">getEnableBridgeConflation</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEnableSubscriptionConflation--"><code>getEnableSubscriptionConflation()</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEnableConflation--">getEnableConflation</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEnableSubscriptionConflation--"><code>getEnableSubscriptionConflation()</code></a> instead #</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEnableSubscriptionConflation--">getEnableSubscriptionConflation</a></span>()</code> |
| <div class="block">Returns whether or not conflation is enabled for sending messages from a cache server to its |
| clients.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEntryIdleTimeout--">getEntryIdleTimeout</a></span>()</code> |
| <div class="block">Gets the <code>idleTimeout</code> expiration attributes for entries in this region.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEntryTimeToLive--">getEntryTimeToLive</a></span>()</code> |
| <div class="block">Gets the <code>timeToLive</code> expiration attributes for entries in this region.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache">EvictionAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEvictionAttributes--">getEvictionAttributes</a></span>()</code> |
| <div class="block">Attributes that control the size of the <code>Region</code> using an <a href="../../../../org/apache/geode/cache/EvictionAlgorithm.html" title="class in org.apache.geode.cache"><code>EvictionAlgorithm</code></a> |
| and a <a href="../../../../org/apache/geode/cache/EvictionAction.html" title="class in org.apache.geode.cache"><code>EvictionAction</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<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/geode/cache/RegionAttributes.html#getGatewaySenderIds--">getGatewaySenderIds</a></span>()</code> |
| <div class="block">Returns a set of gatewaysenderIds</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getIgnoreJTA--">getIgnoreJTA</a></span>()</code> |
| <div class="block">Gets the flag telling a region to ignore JTA transactions.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getIndexMaintenanceSynchronous--">getIndexMaintenanceSynchronous</a></span>()</code> |
| <div class="block">Returns the value of <code>IndexMaintenanceSynchronous</code> which specifies whether the |
| region indexes are updated synchronously when a region is modified or asynchronously in a |
| background thread.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getInitialCapacity--">getInitialCapacity</a></span>()</code> |
| <div class="block">Returns the initial capacity of the entries map.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getKeyConstraint--">getKeyConstraint</a></span>()</code> |
| <div class="block">Returns the class that the keys in this region are constrained to.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getLoadFactor--">getLoadFactor</a></span>()</code> |
| <div class="block">Returns the load factor of the entries map.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/MembershipAttributes.html" title="class in org.apache.geode.cache">MembershipAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getMembershipAttributes--">getMembershipAttributes</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">this API is scheduled to be removed</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/MirrorType.html" title="class in org.apache.geode.cache">MirrorType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getMirrorType--">getMirrorType</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#getDataPolicy--"><code>getDataPolicy()</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getMulticastEnabled--">getMulticastEnabled</a></span>()</code> |
| <div class="block">Returns true if multicast communications are enabled for this region.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getOffHeap--">getOffHeap</a></span>()</code> |
| <div class="block">Returns whether or not this region uses off-heap memory.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache">PartitionAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getPartitionAttributes--">getPartitionAttributes</a></span>()</code> |
| <div class="block">Returns the <code>PartitionAttributes</code> that configure how the region is partitioned.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getPersistBackup--">getPersistBackup</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>DataPolicy.PERSISTENT_REPLICATE</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i36" 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/geode/cache/RegionAttributes.html#getPoolName--">getPoolName</a></span>()</code> |
| <div class="block">Returns the name of the <a href="../../../../org/apache/geode/cache/client/Pool.html" title="interface in org.apache.geode.cache.client"><code>Pool</code></a> that this region will use to communicate with servers, if |
| any.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getPublisher--">getPublisher</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getRegionIdleTimeout--">getRegionIdleTimeout</a></span>()</code> |
| <div class="block">Gets the idleTimeout expiration attributes for the region as a whole.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getRegionTimeToLive--">getRegionTimeToLive</a></span>()</code> |
| <div class="block">Gets the <code>timeToLive</code> expiration attributes for the region as a whole.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/Scope.html" title="class in org.apache.geode.cache">Scope</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getScope--">getScope</a></span>()</code> |
| <div class="block">Returns the scope of the region.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getStatisticsEnabled--">getStatisticsEnabled</a></span>()</code> |
| <div class="block">Returns whether the statistics are enabled for this region and its entries.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/SubscriptionAttributes.html" title="class in org.apache.geode.cache">SubscriptionAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getSubscriptionAttributes--">getSubscriptionAttributes</a></span>()</code> |
| <div class="block">Returns the <code>SubscriptionAttributes</code> that configure how this region behaves as a |
| subscriber to remote caches.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#getValueConstraint--">getValueConstraint</a></span>()</code> |
| <div class="block">Returns the class that the values in this region are constrained to.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#isDiskSynchronous--">isDiskSynchronous</a></span>()</code> |
| <div class="block">Returns true if configured synchronous disk writes.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionAttributes.html#isLockGrantor--">isLockGrantor</a></span>()</code> |
| <div class="block">Returns true if this member is configured to be lock grantor for the region.</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="getCacheLoader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheLoader</h4> |
| <pre><a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache">CacheLoader</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>> getCacheLoader()</pre> |
| <div class="block">Returns the cache loader associated with this region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the cache loader</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheWriter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheWriter</h4> |
| <pre><a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>> getCacheWriter()</pre> |
| <div class="block">Returns the cache writer associated with this region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the cache writer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getKeyConstraint--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyConstraint</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>> getKeyConstraint()</pre> |
| <div class="block">Returns the class that the keys in this region are constrained to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Class</code> the keys must be an <code>instanceof</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueConstraint--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueConstraint</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>> getValueConstraint()</pre> |
| <div class="block">Returns the class that the values in this region are constrained to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Class</code> the values must be an <code>instanceof</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegionTimeToLive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionTimeToLive</h4> |
| <pre><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> getRegionTimeToLive()</pre> |
| <div class="block">Gets the <code>timeToLive</code> expiration attributes for the region as a whole. Default is 0 |
| which indicates that no expiration of this type will happen.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the timeToLive expiration attributes for this region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegionIdleTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionIdleTimeout</h4> |
| <pre><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> getRegionIdleTimeout()</pre> |
| <div class="block">Gets the idleTimeout expiration attributes for the region as a whole. Default is 0 which |
| indicates that no expiration of this type will happen. Note that the XML element that |
| corresponds to this method "region-idle-time", does not include "out" in its name.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the IdleTimeout expiration attributes for this region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEntryTimeToLive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntryTimeToLive</h4> |
| <pre><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> getEntryTimeToLive()</pre> |
| <div class="block">Gets the <code>timeToLive</code> expiration attributes for entries in this region. Default is 0 |
| which indicates that no expiration of this type is set.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the timeToLive expiration attributes for entries in this region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEntryIdleTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntryIdleTimeout</h4> |
| <pre><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> getEntryIdleTimeout()</pre> |
| <div class="block">Gets the <code>idleTimeout</code> expiration attributes for entries in this region. Default is |
| 0 which indicates that no expiration of this type is set. Note that the XML element that |
| corresponds to this method "entry-idle-time", does not include "out" in its name.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the idleTimeout expiration attributes for entries in this region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCustomEntryTimeToLive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCustomEntryTimeToLive</h4> |
| <pre><a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>> getCustomEntryTimeToLive()</pre> |
| <div class="block">Gets the <code>entryTimeToLive</code> <code>CustomExpiry</code>, if any for entries in this |
| region</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the entryTimeToLive CustomExpiry for entries in this region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCustomEntryIdleTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCustomEntryIdleTimeout</h4> |
| <pre><a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>> getCustomEntryIdleTimeout()</pre> |
| <div class="block">Gets the <code>idleTimeout</code> <code>CustomExpiry</code>, if any for entries in this region</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the idleTimeout CustomExpiry for entries in this region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIgnoreJTA--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIgnoreJTA</h4> |
| <pre>boolean getIgnoreJTA()</pre> |
| <div class="block">Gets the flag telling a region to ignore JTA transactions. Default value is set to false.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMirrorType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMirrorType</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> |
| <a href="../../../../org/apache/geode/cache/MirrorType.html" title="class in org.apache.geode.cache">MirrorType</a> getMirrorType()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#getDataPolicy--"><code>getDataPolicy()</code></a> instead.</span></div> |
| <div class="block">Returns the type of mirroring for this region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the region's <code>MirrorType</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataPolicy</h4> |
| <pre><a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> getDataPolicy()</pre> |
| <div class="block">Returns the data policy for this region. Default value of DataPolicy is set to 'Normal'. Please |
| refer the gemfire documentation for more details on this.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the region's <code>DataPolicy</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getScope--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScope</h4> |
| <pre><a href="../../../../org/apache/geode/cache/Scope.html" title="class in org.apache.geode.cache">Scope</a> getScope()</pre> |
| <div class="block">Returns the scope of the region. Default scope is DISTRIBUTED_NO_ACK. Please refer the gemfire |
| documentation for more details on this.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the region's <code>Scope</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEvictionAttributes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEvictionAttributes</h4> |
| <pre><a href="../../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache">EvictionAttributes</a> getEvictionAttributes()</pre> |
| <div class="block">Attributes that control the size of the <code>Region</code> using an <a href="../../../../org/apache/geode/cache/EvictionAlgorithm.html" title="class in org.apache.geode.cache"><code>EvictionAlgorithm</code></a> |
| and a <a href="../../../../org/apache/geode/cache/EvictionAction.html" title="class in org.apache.geode.cache"><code>EvictionAction</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the region's EvictionAttributes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheListener--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheListener</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> |
| <a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>> getCacheListener()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCacheListeners--"><code>getCacheListeners()</code></a> instead</span></div> |
| <div class="block">Returns the cache listener for the region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the region's <code>CacheListener</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if more than one cache listener exists on this attributes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheListeners--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheListeners</h4> |
| <pre><a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">K</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="type parameter in RegionAttributes">V</a>>[] getCacheListeners()</pre> |
| <div class="block">Returns an array of all the cache listeners on this attributes. Modifications to the returned |
| array will not effect the attributes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the region's <code>CacheListener</code>s; an empty array if no listeners</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitialCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialCapacity</h4> |
| <pre>int getInitialCapacity()</pre> |
| <div class="block">Returns the initial capacity of the entries map. Default is 16.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the initial capacity of the entries map</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util"><code>HashMap</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLoadFactor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLoadFactor</h4> |
| <pre>float getLoadFactor()</pre> |
| <div class="block">Returns the load factor of the entries map. Default is 0.75.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the load factor of the entries map</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util"><code>HashMap</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLockGrantor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLockGrantor</h4> |
| <pre>boolean isLockGrantor()</pre> |
| <div class="block">Returns true if this member is configured to be lock grantor for the region. Result will always |
| be false if the scope is not <code>Scope.GLOBAL</code>. |
| <p> |
| This attribute does not indicate whether or not this member is currently lock grantor. It only |
| indicates that at the time of region creation, this member should attempt to become lock |
| grantor. Default value is false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this member is configured to be lock grantor for the region</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html" title="class in org.apache.geode.cache"><code>AttributesFactory</code></a>, |
| <a href="../../../../org/apache/geode/cache/Region.html#becomeLockGrantor--"><code>Region.becomeLockGrantor()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMulticastEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMulticastEnabled</h4> |
| <pre>boolean getMulticastEnabled()</pre> |
| <div class="block">Returns true if multicast communications are enabled for this region. Multicast must also be |
| enabled in the DistributedSystem. Default value is set to false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this region is configured to allow use of multicast for distributed messaging</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setMulticastEnabled-boolean-"><code>AttributesFactory.setMulticastEnabled(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConcurrencyLevel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConcurrencyLevel</h4> |
| <pre>int getConcurrencyLevel()</pre> |
| <div class="block">Returns the concurrencyLevel of the entries map. Default is 16.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the concurrencyLevel</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html" title="class in org.apache.geode.cache"><code>AttributesFactory</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPersistBackup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistBackup</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> |
| boolean getPersistBackup()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>DataPolicy.PERSISTENT_REPLICATE</code></a> instead</span></div> |
| <div class="block">Returns whether or not a persistent backup should be made of the region (as opposed to just |
| writing the overflow data to disk).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 3.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDiskWriteAttributes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiskWriteAttributes</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> |
| <a href="../../../../org/apache/geode/cache/DiskWriteAttributes.html" title="interface in org.apache.geode.cache">DiskWriteAttributes</a> getDiskWriteAttributes()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#getDiskStoreName--"><code>getDiskStoreName()</code></a> instead.</span></div> |
| <div class="block">Returns the <code>DiskWriteAttributes</code> that configure how the region is written to disk.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 3.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDiskDirs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiskDirs</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> |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>[] getDiskDirs()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html#getDiskDirs--"><code>DiskStore.getDiskDirs()</code></a> instead.</span></div> |
| <div class="block">Returns the directories to which the region's data are written. If multiple directories are |
| used, GemFire will attempt to distribute the data evenly amongst them.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 3.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIndexMaintenanceSynchronous--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndexMaintenanceSynchronous</h4> |
| <pre>boolean getIndexMaintenanceSynchronous()</pre> |
| <div class="block">Returns the value of <code>IndexMaintenanceSynchronous</code> which specifies whether the |
| region indexes are updated synchronously when a region is modified or asynchronously in a |
| background thread. Default value is true.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPartitionAttributes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartitionAttributes</h4> |
| <pre><a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache">PartitionAttributes</a> getPartitionAttributes()</pre> |
| <div class="block">Returns the <code>PartitionAttributes</code> that configure how the region is partitioned.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMembershipAttributes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMembershipAttributes</h4> |
| <pre><a href="../../../../org/apache/geode/cache/MembershipAttributes.html" title="class in org.apache.geode.cache">MembershipAttributes</a> getMembershipAttributes()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">this API is scheduled to be removed</span></div> |
| <div class="block">Returns the <code>MembershipAttributes</code> that configure required roles for reliable access |
| to the region.</div> |
| </li> |
| </ul> |
| <a name="getSubscriptionAttributes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubscriptionAttributes</h4> |
| <pre><a href="../../../../org/apache/geode/cache/SubscriptionAttributes.html" title="class in org.apache.geode.cache">SubscriptionAttributes</a> getSubscriptionAttributes()</pre> |
| <div class="block">Returns the <code>SubscriptionAttributes</code> that configure how this region behaves as a |
| subscriber to remote caches.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStatisticsEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatisticsEnabled</h4> |
| <pre>boolean getStatisticsEnabled()</pre> |
| <div class="block">Returns whether the statistics are enabled for this region and its entries. Default is false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if statistics are enabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEarlyAck--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEarlyAck</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> |
| boolean getEarlyAck()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Setting early ack no longer has any effect.</span></div> |
| <div class="block">Returns whether or not acks are sent after an update is processed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if acks are sent after updates are processed; false if acks are sent before |
| updates are processed.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 4.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPublisher--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPublisher</h4> |
| <pre>boolean getPublisher()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5</span></div> |
| <div class="block">Returns whether or not this region is a publisher. Publishers are regions on which distributed |
| write operations are done.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if a publisher; false if not (default).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 4.2.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEnableConflation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnableConflation</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> |
| boolean getEnableConflation()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEnableSubscriptionConflation--"><code>getEnableSubscriptionConflation()</code></a> instead #</span></div> |
| <div class="block">Returns whether or not conflation is enabled for sending messages from a cache server to its |
| clients. |
| |
| Note: This parameter is only valid for cache server to client communication. It has no effect |
| in peer to peer communication.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if conflation is enabled; false conflation is not enabled (default).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 4.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEnableBridgeConflation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnableBridgeConflation</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> |
| boolean getEnableBridgeConflation()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#getEnableSubscriptionConflation--"><code>getEnableSubscriptionConflation()</code></a> instead</span></div> |
| <div class="block">Returns whether or not conflation is enabled for sending messages from a cache server to its |
| clients. |
| |
| Note: This parameter is only valid for cache server to client communication. It has no effect |
| in peer to peer communication.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if conflation is enabled; false conflation is not enabled (default).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEnableSubscriptionConflation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnableSubscriptionConflation</h4> |
| <pre>boolean getEnableSubscriptionConflation()</pre> |
| <div class="block">Returns whether or not conflation is enabled for sending messages from a cache server to its |
| clients. |
| |
| Note: This parameter is only valid for cache server to client communication. It has no effect |
| in peer to peer communication. |
| |
| Default is false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if conflation is enabled; false conflation is not enabled (default).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEnableAsyncConflation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnableAsyncConflation</h4> |
| <pre>boolean getEnableAsyncConflation()</pre> |
| <div class="block">Returns whether or not async conflation is enabled for sending messages to async peers. |
| |
| Default is false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if async conflation is enabled; false async conflation is not enabled (default).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 4.2.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDiskDirSizes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiskDirSizes</h4> |
| <pre>int[] getDiskDirSizes()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html#getDiskDirSizes--"><code>DiskStore.getDiskDirSizes()</code></a> instead.</span></div> |
| <div class="block">Returns the sizes of the disk directories in megabytes</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>int[] sizes of the disk directories</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPoolName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPoolName</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> getPoolName()</pre> |
| <div class="block">Returns the name of the <a href="../../../../org/apache/geode/cache/client/Pool.html" title="interface in org.apache.geode.cache.client"><code>Pool</code></a> that this region will use to communicate with servers, if |
| any. Returns <code>null</code> if this region communicates with peers.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the client-server <a href="../../../../org/apache/geode/cache/client/Pool.html" title="interface in org.apache.geode.cache.client"><code>Pool</code></a> this region will use for server |
| communication; <code>null</code> is returned if the region communicates with peers.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCloningEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCloningEnabled</h4> |
| <pre>boolean getCloningEnabled()</pre> |
| <div class="block">Returns whether or not cloning is enabled on region. Default is false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if cloning is enabled; false cloning is not enabled (default).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDiskStoreName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiskStoreName</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> getDiskStoreName()</pre> |
| <div class="block">Returns the name of the <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a> that this region belongs to, if any. Returns |
| <code>null</code> if this region belongs to default <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a> of this region; <code>null</code> is returned if this |
| region belongs to default <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDiskSynchronous--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDiskSynchronous</h4> |
| <pre>boolean isDiskSynchronous()</pre> |
| <div class="block">Returns true if configured synchronous disk writes. Default is set to true.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns true if writes to disk are synchronous and false otherwise</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGatewaySenderIds--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGatewaySenderIds</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<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>> getGatewaySenderIds()</pre> |
| <div class="block">Returns a set of gatewaysenderIds</div> |
| </li> |
| </ul> |
| <a name="getAsyncEventQueueIds--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAsyncEventQueueIds</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<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>> getAsyncEventQueueIds()</pre> |
| <div class="block">Returns a set of AsyncEventQueueIds added to the region</div> |
| </li> |
| </ul> |
| <a name="getConcurrencyChecksEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConcurrencyChecksEnabled</h4> |
| <pre>boolean getConcurrencyChecksEnabled()</pre> |
| <div class="block">Returns true if concurrent update checks are turned on for this region. |
| <p> |
| When this is enabled, concurrent updates will be conflated if they are applied out of order. |
| <p> |
| All members must set this attribute the same. |
| |
| Default is set to true.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if concurrent update checks are turned on</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCompressor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompressor</h4> |
| <pre><a href="../../../../org/apache/geode/compression/Compressor.html" title="interface in org.apache.geode.compression">Compressor</a> getCompressor()</pre> |
| <div class="block">Returns the compressor used by this region's entry values.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>null if the region does not have compression enabled.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOffHeap--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getOffHeap</h4> |
| <pre>boolean getOffHeap()</pre> |
| <div class="block">Returns whether or not this region uses off-heap memory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if a usage of off-heap memory is enabled; false if usage of off-heap memory is |
| disabled (default).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/cache/RegionAccessException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/RegionDestroyedException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/cache/RegionAttributes.html" target="_top">Frames</a></li> |
| <li><a href="RegionAttributes.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |