| <!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>RegionSnapshotService (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="RegionSnapshotService (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/CacheSnapshotService.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/SnapshotFilter.html" title="interface 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/RegionSnapshotService.html" target="_top">Frames</a></li> |
| <li><a href="RegionSnapshotService.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>Constr | </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>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 RegionSnapshotService" class="title">Interface RegionSnapshotService<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> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RegionSnapshotService<K,V></span></pre> |
| <div class="block">Allows a snapshot of region data to be imported and exported. Example usage: |
| |
| <pre> |
| // obtain a snapshot |
| RegionSnapshot snapshot = region.getSnapshotService(); |
| |
| // export the snapshot, every region in the cache will be exported |
| snapshot.save(new File("snapshot.gfd"), SnapshotOptions.GEMFIRE); |
| |
| // import the snapshot file, updates any existing entries in the region |
| snapshot.load(new File("snapshot.gfd"), SnapshotOptions.GEMFIRE); |
| </pre> |
| |
| |
| When parallel export is used, the file name will be modified to include a unique identifier for |
| the member that created the file, so providing a file location of "snapshot.gfd" would result in |
| creation of multiple files with the format "snapshot-unique_id.gfd". When loading files from a |
| parallel export, a directory can be given instead of a single file and all snapshot files in that |
| directory will be loaded. |
| |
| <pre> |
| // import directory of snapshot files |
| snapshot.load(new File("snapshotDir"), SnapshotOptions.GEMFIRE); |
| </pre> |
| |
| The default behavior is to perform all I/O operations on the node where the snapshot operations |
| are invoked. This will involve either collecting or dispersing data over the network if the |
| region is a partitioned region. The snapshot behavior can be changed using |
| <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot"><code>SnapshotOptions</code></a>. For example: |
| |
| <pre> |
| RegionSnapshotService snapshot = region.getSnapshotService(); |
| SnapshotFilter filter = new SnapshotFilter() { |
| public boolean accept(Entry$lt;K, V$gt; entry) { |
| return true; |
| } |
| }; |
| |
| SnapshotOptions$lt;Object, Object$gt; options = snapshot.createOptions(); |
| options.setFilter(filter); |
| |
| snapshot.save(new File("snapshot.gfd"), SnapshotFormat.GEMFIRE, options); |
| </pre> |
| |
| Note that the snapshot does not provide a consistency guarantee. Updates to data during the |
| course of import/export operations could result data inconsistencies.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/Region.html#getSnapshotService--"><code>Region.getSnapshotService()</code></a>, |
| <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot"><code>SnapshotOptions</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 <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/snapshot/RegionSnapshotService.html#SNAPSHOT_FILE_EXTENSION">SNAPSHOT_FILE_EXTENSION</a></span></code> |
| <div class="block">File extension for snapshot files</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/SnapshotOptions.html" title="interface in org.apache.geode.cache.snapshot">SnapshotOptions</a><<a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html#createOptions--">createOptions</a></span>()</code> |
| <div class="block">Creates a <code>SnapshotOptions</code> object configured with default settings.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html#load-java.io.File-org.apache.geode.cache.snapshot.SnapshotOptions.SnapshotFormat-">load</a></span>(<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> snapshot, |
| <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot">SnapshotOptions.SnapshotFormat</a> format)</code> |
| <div class="block">Imports the snapshot file into the specified region.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html#load-java.io.File-org.apache.geode.cache.snapshot.SnapshotOptions.SnapshotFormat-org.apache.geode.cache.snapshot.SnapshotOptions-">load</a></span>(<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> snapshot, |
| <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot">SnapshotOptions.SnapshotFormat</a> format, |
| <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/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">V</a>> options)</code> |
| <div class="block">Imports the snapshot file into the specified region by applying user-configured options.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html#save-java.io.File-org.apache.geode.cache.snapshot.SnapshotOptions.SnapshotFormat-">save</a></span>(<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> snapshot, |
| <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot">SnapshotOptions.SnapshotFormat</a> format)</code> |
| <div class="block">Exports the region data into the snapshot file.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html#save-java.io.File-org.apache.geode.cache.snapshot.SnapshotOptions.SnapshotFormat-org.apache.geode.cache.snapshot.SnapshotOptions-">save</a></span>(<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> snapshot, |
| <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot">SnapshotOptions.SnapshotFormat</a> format, |
| <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/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">V</a>> options)</code> |
| <div class="block">Exports the region data into the snapshot file by applying user-configured options.</div> |
| </td> |
| </tr> |
| </table> |
| </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="SNAPSHOT_FILE_EXTENSION"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SNAPSHOT_FILE_EXTENSION</h4> |
| <pre>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> SNAPSHOT_FILE_EXTENSION</pre> |
| <div class="block">File extension for snapshot files</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.snapshot.RegionSnapshotService.SNAPSHOT_FILE_EXTENSION">Constant Field Values</a></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="createOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createOptions</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/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">V</a>> createOptions()</pre> |
| <div class="block">Creates a <code>SnapshotOptions</code> object configured with default settings. The options can |
| be used to configure snapshot behavior.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default options</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="save-java.io.File-org.apache.geode.cache.snapshot.SnapshotOptions.SnapshotFormat-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>save</h4> |
| <pre>void save(<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> snapshot, |
| <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot">SnapshotOptions.SnapshotFormat</a> format) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Exports the region data into the snapshot file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshot</code> - the snapshot file (must end in .gfd)</dd> |
| <dd><code>format</code> - the snapshot format</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - error writing snapshot</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="save-java.io.File-org.apache.geode.cache.snapshot.SnapshotOptions.SnapshotFormat-org.apache.geode.cache.snapshot.SnapshotOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>save</h4> |
| <pre>void save(<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> snapshot, |
| <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot">SnapshotOptions.SnapshotFormat</a> format, |
| <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/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">V</a>> options) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Exports the region data into the snapshot file by applying user-configured options.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshot</code> - the snapshot file (must end in .gfd)</dd> |
| <dd><code>format</code> - the snapshot format</dd> |
| <dd><code>options</code> - the snapshot options</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - error writing snapshot</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="load-java.io.File-org.apache.geode.cache.snapshot.SnapshotOptions.SnapshotFormat-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>void load(<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> snapshot, |
| <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot">SnapshotOptions.SnapshotFormat</a> format) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></pre> |
| <div class="block">Imports the snapshot file into the specified region. The snapshot parameter can be either a |
| single snapshot file or a directory containing snapshot files. If a single file, it must end in |
| the snapshot file extension (.gfd) to be imported. If a directory, only files in the directory |
| that end in .gfd will be loaded. |
| <p> |
| Prior to loading data, the region should have been created and any necessary serializers |
| (either <a href="../../../../../org/apache/geode/DataSerializer.html" title="class in org.apache.geode"><code>DataSerializer</code></a> or <a href="../../../../../org/apache/geode/pdx/PdxSerializer.html" title="interface in org.apache.geode.pdx"><code>PdxSerializer</code></a>) and <a href="../../../../../org/apache/geode/Instantiator.html" title="class in org.apache.geode"><code>Instantiator</code></a>s should have |
| been registered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshot</code> - the snapshot file (ending in .gfd) or a directory of .gfd snapshot files</dd> |
| <dd><code>format</code> - the snapshot file format</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Unable to import data</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></code> - Unable to import data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="load-java.io.File-org.apache.geode.cache.snapshot.SnapshotOptions.SnapshotFormat-org.apache.geode.cache.snapshot.SnapshotOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>void load(<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> snapshot, |
| <a href="../../../../../org/apache/geode/cache/snapshot/SnapshotOptions.SnapshotFormat.html" title="enum in org.apache.geode.cache.snapshot">SnapshotOptions.SnapshotFormat</a> format, |
| <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/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">K</a>,<a href="../../../../../org/apache/geode/cache/snapshot/RegionSnapshotService.html" title="type parameter in RegionSnapshotService">V</a>> options) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></pre> |
| <div class="block">Imports the snapshot file into the specified region by applying user-configured options. The |
| snapshot parameter can be either a single snapshot file or a directory containing snapshot |
| files. If a single file, it must end in the snapshot file extension (.gfd) to be imported. If a |
| directory, only files in the directory that end in .gfd will be loaded. |
| <p> |
| Prior to loading data, the region should have been created and any necessary serializers |
| (either <a href="../../../../../org/apache/geode/DataSerializer.html" title="class in org.apache.geode"><code>DataSerializer</code></a> or <a href="../../../../../org/apache/geode/pdx/PdxSerializer.html" title="interface in org.apache.geode.pdx"><code>PdxSerializer</code></a>) and <a href="../../../../../org/apache/geode/Instantiator.html" title="class in org.apache.geode"><code>Instantiator</code></a>s should have |
| been registered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshot</code> - the snapshot file (ending in .gfd) or a directory of .gfd snapshot files</dd> |
| <dd><code>format</code> - the snapshot file format</dd> |
| <dd><code>options</code> - the snapshot options</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Unable to import data</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</a></code> - Unable to import data</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/CacheSnapshotService.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/SnapshotFilter.html" title="interface 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/RegionSnapshotService.html" target="_top">Frames</a></li> |
| <li><a href="RegionSnapshotService.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>Constr | </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>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> |
