| <!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>SnapshotOptions (Apache Geode 1.15.0)</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="SnapshotOptions (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/snapshot/SnapshotIterator.html" title="interface in org.apache.geode.cache.snapshot"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/snapshot/SnapshotOptions.html" target="_top">Frames</a></li> |
| <li><a href="SnapshotOptions.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>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.snapshot</div> |
| <h2 title="Interface SnapshotOptions" class="title">Interface SnapshotOptions<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>K</code> - the cache entry key type</dd> |
| <dd><code>V</code> - the cache entry value type</dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SnapshotOptions<K,V></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block">Provides a way to configure the behavior of snapshot operations. The default options are: |
| <dl> |
| <dt>filter</dt> |
| <dd>null</dd> |
| </dl></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot">SnapshotOptions.SnapshotFormat</a></span></code> |
| <div class="block">Defines the available snapshot file formats.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/snapshot/SnapshotFilter.html" title="interface in org.apache.geode.cache.snapshot">SnapshotFilter</a><<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html#getFilter--">getFilter</a></span>()</code> |
| <div class="block">Returns the filter to be applied to snapshot entries.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot">SnapshotOptions</a><<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html#invokeCallbacks-boolean-">invokeCallbacks</a></span>(boolean invokeCallbacks)</code> |
| <div class="block">Sets whether to invoke callbacks when loading a snapshot.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html#isParallelMode--">isParallelMode</a></span>()</code> |
| <div class="block">Returns true if the snapshot operation will proceed in parallel.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot">SnapshotOptions</a><<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html#setFilter-org.apache.geode.cache.snapshot.SnapshotFilter-">setFilter</a></span>(<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotFilter.html" title="interface in org.apache.geode.cache.snapshot">SnapshotFilter</a><<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">V</a>> filter)</code> |
| <div class="block">Sets a filter to apply to snapshot entries.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot">SnapshotOptions</a><<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html#setParallelMode-boolean-">setParallelMode</a></span>(boolean parallel)</code> |
| <div class="block">Enables parallel mode for snapshot export, which will cause each member of a partitioned region |
| to save its local data set (ignoring redundant copies) to a separate snapshot file.</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/snapshot/SnapshotOptions.html#shouldInvokeCallbacks--">shouldInvokeCallbacks</a></span>()</code> |
| <div class="block">Returns whether loading a snapshot causes callbacks to be invoked</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="setFilter-org.apache.geode.cache.snapshot.SnapshotFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilter</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot">SnapshotOptions</a><<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">V</a>> setFilter(<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotFilter.html" title="interface in org.apache.geode.cache.snapshot">SnapshotFilter</a><<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">V</a>> filter)</pre> |
| <div class="block">Sets a filter to apply to snapshot entries. Entries that are accepted by the filter will be |
| included in import and export operations.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the filter to apply, or null to remove the filter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the snapshot options</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilter</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotFilter.html" title="interface in org.apache.geode.cache.snapshot">SnapshotFilter</a><<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">V</a>> getFilter()</pre> |
| <div class="block">Returns the filter to be applied to snapshot entries. Entries that are accepted by the filter |
| will be included in import and export operations.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter, or null if the filter is not set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invokeCallbacks-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeCallbacks</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot">SnapshotOptions</a><<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">V</a>> invokeCallbacks(boolean invokeCallbacks)</pre> |
| <div class="block">Sets whether to invoke callbacks when loading a snapshot. The default is false.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>invokeCallbacks</code> - whether to invoke callbacks when loading a snapshot</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the snapshot options</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shouldInvokeCallbacks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldInvokeCallbacks</h4> |
| <pre>boolean shouldInvokeCallbacks()</pre> |
| <div class="block">Returns whether loading a snapshot causes callbacks to be invoked</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether loading a snapshot causes callbacks to be invoked</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isParallelMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isParallelMode</h4> |
| <pre>boolean isParallelMode()</pre> |
| <div class="block">Returns true if the snapshot operation will proceed in parallel.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the parallel mode has been enabled</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParallelMode-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setParallelMode</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot">SnapshotOptions</a><<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="type parameter in SnapshotOptions">V</a>> setParallelMode(boolean parallel)</pre> |
| <div class="block">Enables parallel mode for snapshot export, which will cause each member of a partitioned region |
| to save its local data set (ignoring redundant copies) to a separate snapshot file. |
| |
| <p> |
| Parallelizing snapshot operations may yield significant performance improvements for large data |
| sets. This is particularly true when each member is writing to separate physical disks. |
| <p> |
| This flag is ignored for replicated regions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parallel</code> - true if the snapshot operations will be performed in parallel</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the snapshot options</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>SnapshotFileMapper</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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/snapshot/SnapshotIterator.html" title="interface in org.apache.geode.cache.snapshot"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/snapshot/SnapshotOptions.html" target="_top">Frames</a></li> |
| <li><a href="SnapshotOptions.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>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> |
