| <!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 --> |
| <title>PartitionAttributesFactory (Apache Geode 1.15.1)</title> |
| <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="PartitionAttributesFactory (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":42,"i5":10,"i6":42,"i7":10,"i8":10,"i9":10,"i10":10,"i11":42,"i12":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="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/PartitionAttributes.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/PartitionedRegionDistributionException.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/PartitionAttributesFactory.html" target="_top">Frames</a></li> |
| <li><a href="PartitionAttributesFactory.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.geode.cache</div> |
| <h2 title="Class PartitionAttributesFactory" class="title">Class PartitionAttributesFactory<K,V></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.geode.cache.PartitionAttributesFactory<K,V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">PartitionAttributesFactory<K,V></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></pre> |
| <div class="block"><p> |
| A factory that creates instances of <a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache"><code>PartitionAttributes</code></a> which are used to create a |
| partitioned <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a>. The setter methods follow the self-return idiom so that they can be |
| "chained" together with the <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#create--"><code>create()</code></a> method to create <a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache"><code>PartitionAttributes</code></a>. For |
| example:<br> |
| |
| <pre> |
| PartitionAttributes pa = |
| new PartitionAttributesFactory().setRedundantCopies(1).setLocalMaxMemory(1240).create(); |
| |
| final Region myRegion = new RegionFactory().setPartitionAttributes(pa) |
| .setKeyConstraint(String.class).setValueConstraint(ArrayList.class).create("myRegion"); |
| </pre> |
| |
| <p> |
| <a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache"><code>PartitionAttributes</code></a> can also be defined in a declarative fashion using a |
| <a href="package-summary.html#declarative">cache.xml</a> file. Here is an example of how to |
| configure a Partitioned Region named "pRoot" whose <a href="../../../../org/apache/geode/cache/Scope.html" title="class in org.apache.geode.cache"><code>Scope</code></a> is |
| Distributed Ack, which maintains a <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setRedundantCopies-int-"><code>redundant copy</code></a> of any given |
| <a href="../../../../org/apache/geode/cache/Region.Entry.html" title="interface in org.apache.geode.cache"><code>Region.Entry</code></a>, configures a |
| <a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache"><code>CacheLoader</code></a> implementation, and sets |
| <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setGlobalProperties-java.util.Properties-"><code>global properties</code></a> as well as |
| <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>local max memory to use</code></a>. |
| |
| <pre> |
| <root-region name="pRoot"> |
| <region-attributes scope="distributed-ack" > |
| <partition-attributes redundant-copies="1", local-max-memory="1240"/> |
| </region-attributes> |
| </root-region> |
| </pre> |
| <p></div> |
| <dl> |
| <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/PartitionAttributes.html" title="interface in org.apache.geode.cache"><code>PartitionAttributes</code></a>, |
| <a href="../../../../org/apache/geode/cache/AttributesFactory.html#setPartitionAttributes-org.apache.geode.cache.PartitionAttributes-"><code>AttributesFactory.setPartitionAttributes(PartitionAttributes)</code></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"> </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 int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#GLOBAL_MAX_BUCKETS_DEFAULT">GLOBAL_MAX_BUCKETS_DEFAULT</a></span></code> |
| <div class="block">The default total number of buckets (113).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/PartitionAttributesFactory.html#GLOBAL_MAX_BUCKETS_PROPERTY">GLOBAL_MAX_BUCKETS_PROPERTY</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">- please use <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setTotalNumBuckets-int-"><code>setTotalNumBuckets(int)</code></a> instead. |
| <p> |
| <em>This setting must be the same in all processes using the Region.</em></span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#GLOBAL_MAX_MEMORY_DEFAULT">GLOBAL_MAX_MEMORY_DEFAULT</a></span></code> |
| <div class="block">Default maximum total size of the region across all processes, in megabytes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/PartitionAttributesFactory.html#GLOBAL_MAX_MEMORY_PROPERTY">GLOBAL_MAX_MEMORY_PROPERTY</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">- use <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setTotalMaxMemory-long-"><code>setTotalMaxMemory(long)</code></a> instead. |
| <p> |
| The <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setGlobalProperties-java.util.Properties-"><code>global property</code></a> name that defines the |
| total maximum size for the partitioned Region. |
| <p> |
| <em>This setting must be the same in all processes using the Region.</em></span></div> |
| </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/geode/cache/PartitionAttributesFactory.html#LOCAL_MAX_MEMORY_DEFAULT">LOCAL_MAX_MEMORY_DEFAULT</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <code>PartitionAttributesImpl.getLocalMaxMemoryDefault()</code> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/PartitionAttributesFactory.html#LOCAL_MAX_MEMORY_PROPERTY">LOCAL_MAX_MEMORY_PROPERTY</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">- please use the <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>setLocalMaxMemory(int)</code></a> method instead. |
| <p> |
| The <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setLocalProperties-java.util.Properties-"><code>local property</code></a> name that sets the |
| maximum heap storage a VM contributes to a partitioned Region. When set to zero, |
| the resulting Region reference allows access to the partitioned Region without any |
| consuming any heap storage.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#RECOVERY_DELAY_DEFAULT">RECOVERY_DELAY_DEFAULT</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#STARTUP_RECOVERY_DELAY_DEFAULT">STARTUP_RECOVERY_DELAY_DEFAULT</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#PartitionAttributesFactory--">PartitionAttributesFactory</a></span>()</code> |
| <div class="block">Creates a new instance of PartitionAttributesFactory ready to create a |
| <code>PartitionAttributes</code> with default settings.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#PartitionAttributesFactory-org.apache.geode.cache.PartitionAttributes-">PartitionAttributesFactory</a></span>(<a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache">PartitionAttributes</a> pa)</code> |
| <div class="block">Creates a new instance of PartitionAttributesFactory ready to create a |
| <a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache"><code>PartitionAttributes</code></a> with the same settings as those in the specified |
| <a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache"><code>PartitionAttributes</code></a></div> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#addFixedPartitionAttributes-org.apache.geode.cache.FixedPartitionAttributes-">addFixedPartitionAttributes</a></span>(<a href="../../../../org/apache/geode/cache/FixedPartitionAttributes.html" title="class in org.apache.geode.cache">FixedPartitionAttributes</a> fpa)</code> |
| <div class="block">FixedPartitionAttributes defined for this partitioned region is added to PR attributes.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#addPartitionListener-org.apache.geode.cache.partition.PartitionListener-">addPartitionListener</a></span>(<a href="../../../../org/apache/geode/cache/partition/PartitionListener.html" title="interface in org.apache.geode.cache.partition">PartitionListener</a> listener)</code> |
| <div class="block">adds a PartitionListener for the partitioned region.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache">PartitionAttributes</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#create--">create</a></span>()</code> |
| <div class="block">Creates a <code>PartitionAttributes</code> with the current settings.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setColocatedWith-java.lang.String-">setColocatedWith</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> colocatedRegionFullPath)</code> |
| <div class="block">Sets the name of the PartitionRegion with which this newly created partitioned region is |
| colocated</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setGlobalProperties-java.util.Properties-">setGlobalProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> globalProps)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setTotalMaxMemory-long-"><code>setTotalMaxMemory(long)</code></a> and <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setTotalNumBuckets-int-"><code>setTotalNumBuckets(int)</code></a> in |
| GemFire 5.1 and later releases</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-">setLocalMaxMemory</a></span>(int mb)</code> |
| <div class="block">Sets the maximum amount of memory, in megabytes, to be used by the region in this process.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setLocalProperties-java.util.Properties-">setLocalProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> localProps)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>setLocalMaxMemory(int)</code></a> in GemFire 5.1 and later releases</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setPartitionResolver-org.apache.geode.cache.PartitionResolver-">setPartitionResolver</a></span>(<a href="../../../../org/apache/geode/cache/PartitionResolver.html" title="interface in org.apache.geode.cache">PartitionResolver</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> resolver)</code> |
| <div class="block">Sets the <code>PartitionResolver</code> for the PartitionRegion.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setRecoveryDelay-long-">setRecoveryDelay</a></span>(long recoveryDelay)</code> |
| <div class="block">Sets the delay in milliseconds that existing members will wait before satisfying redundancy |
| after another member crashes.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setRedundantCopies-int-">setRedundantCopies</a></span>(int redundantCopies)</code> |
| <div class="block">Sets the number of extra copies of buckets desired.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setStartupRecoveryDelay-long-">setStartupRecoveryDelay</a></span>(long startupRecoveryDelay)</code> |
| <div class="block">Sets the delay in milliseconds that new members will wait before satisfying redundancy.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setTotalMaxMemory-long-">setTotalMaxMemory</a></span>(long mb)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">since Geode 1.3.0</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setTotalNumBuckets-int-">setTotalNumBuckets</a></span>(int numBuckets)</code> |
| <div class="block">Sets the total number of hash buckets to be used by the region in all processes.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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#toString--" title="class or interface in java.lang">toString</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="LOCAL_MAX_MEMORY_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOCAL_MAX_MEMORY_PROPERTY</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 static final <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> LOCAL_MAX_MEMORY_PROPERTY</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">- please use the <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>setLocalMaxMemory(int)</code></a> method instead. |
| <p> |
| The <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setLocalProperties-java.util.Properties-"><code>local property</code></a> name that sets the |
| maximum heap storage a VM contributes to a partitioned Region. When set to zero, |
| the resulting Region reference allows access to the partitioned Region without any |
| consuming any heap storage.</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.cache.PartitionAttributesFactory.LOCAL_MAX_MEMORY_PROPERTY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="LOCAL_MAX_MEMORY_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOCAL_MAX_MEMORY_DEFAULT</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 static final int LOCAL_MAX_MEMORY_DEFAULT</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <code>PartitionAttributesImpl.getLocalMaxMemoryDefault()</code> instead.</span></div> |
| <div class="block">The default maximum amount of memory to be used by this region in this process, in megabytes.</div> |
| </li> |
| </ul> |
| <a name="GLOBAL_MAX_MEMORY_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GLOBAL_MAX_MEMORY_PROPERTY</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 static final <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> GLOBAL_MAX_MEMORY_PROPERTY</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">- use <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setTotalMaxMemory-long-"><code>setTotalMaxMemory(long)</code></a> instead. |
| <p> |
| The <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setGlobalProperties-java.util.Properties-"><code>global property</code></a> name that defines the |
| total maximum size for the partitioned Region. |
| <p> |
| <em>This setting must be the same in all processes using the Region.</em></span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.cache.PartitionAttributesFactory.GLOBAL_MAX_MEMORY_PROPERTY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="GLOBAL_MAX_MEMORY_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GLOBAL_MAX_MEMORY_DEFAULT</h4> |
| <pre>public static final long GLOBAL_MAX_MEMORY_DEFAULT</pre> |
| <div class="block">Default maximum total size of the region across all processes, in megabytes.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.cache.PartitionAttributesFactory.GLOBAL_MAX_MEMORY_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="GLOBAL_MAX_BUCKETS_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GLOBAL_MAX_BUCKETS_PROPERTY</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 static final <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> GLOBAL_MAX_BUCKETS_PROPERTY</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">- please use <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setTotalNumBuckets-int-"><code>setTotalNumBuckets(int)</code></a> instead. |
| <p> |
| <em>This setting must be the same in all processes using the Region.</em></span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.cache.PartitionAttributesFactory.GLOBAL_MAX_BUCKETS_PROPERTY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="GLOBAL_MAX_BUCKETS_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GLOBAL_MAX_BUCKETS_DEFAULT</h4> |
| <pre>public static final int GLOBAL_MAX_BUCKETS_DEFAULT</pre> |
| <div class="block">The default total number of buckets (113).</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.cache.PartitionAttributesFactory.GLOBAL_MAX_BUCKETS_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RECOVERY_DELAY_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RECOVERY_DELAY_DEFAULT</h4> |
| <pre>public static final long RECOVERY_DELAY_DEFAULT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.cache.PartitionAttributesFactory.RECOVERY_DELAY_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="STARTUP_RECOVERY_DELAY_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>STARTUP_RECOVERY_DELAY_DEFAULT</h4> |
| <pre>public static final long STARTUP_RECOVERY_DELAY_DEFAULT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.cache.PartitionAttributesFactory.STARTUP_RECOVERY_DELAY_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="PartitionAttributesFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PartitionAttributesFactory</h4> |
| <pre>public PartitionAttributesFactory()</pre> |
| <div class="block">Creates a new instance of PartitionAttributesFactory ready to create a |
| <code>PartitionAttributes</code> with default settings.</div> |
| </li> |
| </ul> |
| <a name="PartitionAttributesFactory-org.apache.geode.cache.PartitionAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PartitionAttributesFactory</h4> |
| <pre>public PartitionAttributesFactory(<a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache">PartitionAttributes</a> pa)</pre> |
| <div class="block">Creates a new instance of PartitionAttributesFactory ready to create a |
| <a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache"><code>PartitionAttributes</code></a> with the same settings as those in the specified |
| <a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache"><code>PartitionAttributes</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pa</code> - the <code>PartitionAttributes</code> used to initialize this |
| PartitionAttributesFactory</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setRedundantCopies-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRedundantCopies</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> setRedundantCopies(int redundantCopies)</pre> |
| <div class="block">Sets the number of extra copies of buckets desired. Extra copies allow for both high |
| availability in the face of VM departure (intended or unintended) and and load balancing read |
| operations. |
| <p> |
| <em>This setting must be the same in all processes using the Region.</em> Default number of |
| redundant copies is 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>redundantCopies</code> - the number of redundant bucket copies, limited to values 0, 1, 2 and 3.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLocalMaxMemory-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocalMaxMemory</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> setLocalMaxMemory(int mb)</pre> |
| <div class="block">Sets the maximum amount of memory, in megabytes, to be used by the region in this process. If |
| not set, a default of 90% of available heap is used.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mb</code> - the maximum amount of memory, in megabytes, to be used by the region in this process</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTotalMaxMemory-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTotalMaxMemory</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 <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> setTotalMaxMemory(long mb)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since Geode 1.3.0</span></div> |
| <div class="block">Sets the maximum amount of memory, in megabytes, to be used by the region in all processes. |
| <p> |
| <em>This setting must be the same in all processes using the Region.</em> The default value is |
| Integer.MAX_VALUE.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mb</code> - the maximum amount of memory, in megabytes, to be used by the region in all processes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTotalNumBuckets-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTotalNumBuckets</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> setTotalNumBuckets(int numBuckets)</pre> |
| <div class="block">Sets the total number of hash buckets to be used by the region in all processes. |
| <p> |
| <em>This setting must be the same in all processes using the Region.</em> |
| <p> |
| A bucket is the smallest unit of data management in a partitioned region. |
| <a href="../../../../org/apache/geode/cache/Region.Entry.html" title="interface in org.apache.geode.cache"><code>Entries</code></a> are stored in buckets and buckets may move |
| from one VM to another. Buckets may also have copies, depending on |
| <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setRedundantCopies-int-"><code>redundancy</code></a> to provide high availability in the face of VM |
| failure. |
| <p> |
| The number of buckets should be prime and as a rough guide at the least four times the number |
| of partition VMs. However, there is significant overhead to managing a bucket, particularly for |
| higher values of <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setRedundantCopies-int-"><code>redundancy</code></a>. |
| <p> |
| The default number of buckets for a PartitionedRegion is 113.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numBuckets</code> - the total number of hash buckets to be used by the region in all processes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPartitionResolver-org.apache.geode.cache.PartitionResolver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPartitionResolver</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> setPartitionResolver(<a href="../../../../org/apache/geode/cache/PartitionResolver.html" title="interface in org.apache.geode.cache">PartitionResolver</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> resolver)</pre> |
| <div class="block">Sets the <code>PartitionResolver</code> for the PartitionRegion.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resolver</code> - the <code>PartitionResolver</code> for the PartitionRegion</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setColocatedWith-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColocatedWith</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> setColocatedWith(<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> colocatedRegionFullPath)</pre> |
| <div class="block">Sets the name of the PartitionRegion with which this newly created partitioned region is |
| colocated</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>colocatedRegionFullPath</code> - the name of the PartitionRegion with which this newly created |
| partitioned region is colocated</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRecoveryDelay-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRecoveryDelay</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> setRecoveryDelay(long recoveryDelay)</pre> |
| <div class="block">Sets the delay in milliseconds that existing members will wait before satisfying redundancy |
| after another member crashes. Default value is set to -1 which indicates that redundancy will |
| not be recovered after a failure.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>recoveryDelay</code> - the delay in milliseconds that existing members will wait before |
| satisfying redundancy after another member crashes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStartupRecoveryDelay-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStartupRecoveryDelay</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> setStartupRecoveryDelay(long startupRecoveryDelay)</pre> |
| <div class="block">Sets the delay in milliseconds that new members will wait before satisfying redundancy. -1 |
| indicates that adding new members will not trigger redundancy recovery. The default (set to 0) |
| is to recover redundancy immediately when a new member is added.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startupRecoveryDelay</code> - the delay in milliseconds that new members will wait before |
| satisfying redundancy</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addPartitionListener-org.apache.geode.cache.partition.PartitionListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPartitionListener</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> addPartitionListener(<a href="../../../../org/apache/geode/cache/partition/PartitionListener.html" title="interface in org.apache.geode.cache.partition">PartitionListener</a> listener)</pre> |
| <div class="block">adds a PartitionListener for the partitioned region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the PartitionListener to add</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLocalProperties-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocalProperties</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 <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> setLocalProperties(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> localProps)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>setLocalMaxMemory(int)</code></a> in GemFire 5.1 and later releases</span></div> |
| <div class="block">Sets the <code>Properties</code> for the local instance the partitioned Region. Local |
| properties define how the local instance of the partitioned region and any storage it may |
| provide, behaves. There are currently no non-deprecated local properties.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>localProps</code> - the <code>Properties</code> for the local instance the partitioned Region</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setGlobalProperties-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGlobalProperties</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 <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> setGlobalProperties(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> globalProps)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setTotalMaxMemory-long-"><code>setTotalMaxMemory(long)</code></a> and <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setTotalNumBuckets-int-"><code>setTotalNumBuckets(int)</code></a> in |
| GemFire 5.1 and later releases</span></div> |
| <div class="block">Sets the global <code>Properties</code> for the next <code>PartitionAttributes</code> created. |
| Global properties define how the entire partitioned Region behaves. |
| <p> |
| Note that global settings must be the same in all processes using the Region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>globalProps</code> - the global <code>Properties</code> for the next |
| <code>PartitionAttributes</code> created</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#GLOBAL_MAX_MEMORY_PROPERTY"><code>GLOBAL_MAX_MEMORY_PROPERTY</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFixedPartitionAttributes-org.apache.geode.cache.FixedPartitionAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFixedPartitionAttributes</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache">PartitionAttributesFactory</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> addFixedPartitionAttributes(<a href="../../../../org/apache/geode/cache/FixedPartitionAttributes.html" title="class in org.apache.geode.cache">FixedPartitionAttributes</a> fpa)</pre> |
| <div class="block">FixedPartitionAttributes defined for this partitioned region is added to PR attributes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fpa</code> - the FixedPartitionAttributes to add</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PartitionAttributeFactory.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache">PartitionAttributes</a><<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">K</a>,<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="type parameter in PartitionAttributesFactory">V</a>> create()</pre> |
| <div class="block">Creates a <code>PartitionAttributes</code> with the current settings.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <code>PartitionAttributes</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 the current settings violate the |
| <a href="#compatibility">compatibility rules </a></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/PartitionAttributes.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/PartitionedRegionDistributionException.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/PartitionAttributesFactory.html" target="_top">Frames</a></li> |
| <li><a href="PartitionAttributesFactory.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
