| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SnapshotDescriptionUtils (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</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="SnapshotDescriptionUtils (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SnapshotDescriptionUtils.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotCreationException.html" title="class in org.apache.hadoop.hbase.snapshot"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.CompletedSnaphotDirectoriesFilter.html" title="class in org.apache.hadoop.hbase.snapshot"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html" target="_top">Frames</a></li> |
| <li><a href="SnapshotDescriptionUtils.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><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.hadoop.hbase.snapshot</div> |
| <h2 title="Class SnapshotDescriptionUtils" class="title">Class SnapshotDescriptionUtils</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.hadoop.hbase.snapshot.SnapshotDescriptionUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| public final class <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.90">SnapshotDescriptionUtils</a> |
| 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">Utility class to help manage <code>SnapshotDesriptions</code>. |
| <p> |
| Snapshots are laid out on disk like this: |
| |
| <pre> |
| /hbase/.snapshots |
| /.tmp <---- working directory |
| /[snapshot name] <----- completed snapshot |
| </pre> |
| |
| A completed snapshot named 'completed' then looks like (multiple regions, servers, files, etc. |
| signified by '...' on the same directory depth). |
| |
| <pre> |
| /hbase/.snapshots/completed |
| .snapshotinfo <--- Description of the snapshot |
| .tableinfo <--- Copy of the tableinfo |
| /.logs |
| /[server_name] |
| /... [log files] |
| ... |
| /[region name] <---- All the region's information |
| .regioninfo <---- Copy of the HRegionInfo |
| /[column family name] |
| /[hfile name] <--- name of the hfile in the real region |
| ... |
| ... |
| ... |
| </pre> |
| |
| Utility methods in this class are useful for getting the correct locations for different parts of |
| the snapshot, as well as moving completed snapshots into place (see |
| <a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#completeSnapshot-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.conf.Configuration-"><code>completeSnapshot(org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path, org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration)</code></a>, and writing the |
| <code>SnapshotProtos.SnapshotDescription</code> to the working snapshot directory.</div> |
| </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">Class 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/hadoop/hbase/snapshot/SnapshotDescriptionUtils.CompletedSnaphotDirectoriesFilter.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotDescriptionUtils.CompletedSnaphotDirectoriesFilter</a></span></code> |
| <div class="block">Filter that only accepts completed snapshot directories</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== 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 long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#DEFAULT_MAX_WAIT_TIME">DEFAULT_MAX_WAIT_TIME</a></span></code> |
| <div class="block">By default, wait 300 seconds for a snapshot to complete</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#LOG">LOG</a></span></code> </td> |
| </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/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#MASTER_SNAPSHOT_TIMEOUT_MILLIS">MASTER_SNAPSHOT_TIMEOUT_MILLIS</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/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#NO_SNAPSHOT_START_TIME_SPECIFIED">NO_SNAPSHOT_START_TIME_SPECIFIED</a></span></code> |
| <div class="block">Default value if no start time is specified</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#NO_SNAPSHOT_TTL_SPECIFIED">NO_SNAPSHOT_TTL_SPECIFIED</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#SNAPSHOT_LAYOUT_VERSION">SNAPSHOT_LAYOUT_VERSION</a></span></code> |
| <div class="block">Version of the fs layout for a snapshot.</div> |
| </td> |
| </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/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#SNAPSHOT_TMP_DIR_NAME">SNAPSHOT_TMP_DIR_NAME</a></span></code> |
| <div class="block">Temporary directory under the snapshot directory to store in-progress snapshots</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/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#SNAPSHOT_WORKING_DIR">SNAPSHOT_WORKING_DIR</a></span></code> |
| <div class="block">The configuration property that determines the filepath of the snapshot |
| base working directory</div> |
| </td> |
| </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/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#SNAPSHOTINFO_FILE">SNAPSHOTINFO_FILE</a></span></code> |
| <div class="block">The file contains the snapshot basic information and it is under the directory of a snapshot.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#SnapshotDescriptionUtils--">SnapshotDescriptionUtils</a></span>()</code> </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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></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>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#completeSnapshot-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.conf.Configuration-">completeSnapshot</a></span>(org.apache.hadoop.fs.Path snapshotDir, |
| org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.FileSystem workingDirFs, |
| org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Commits the snapshot process by moving the working snapshot |
| to the finalized filepath</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#getCompletedSnapshotDir-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription-org.apache.hadoop.fs.Path-">getCompletedSnapshotDir</a></span>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path rootDir)</code> |
| <div class="block">Get the directory for a specified snapshot.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#getCompletedSnapshotDir-java.lang.String-org.apache.hadoop.fs.Path-">getCompletedSnapshotDir</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> snapshotName, |
| org.apache.hadoop.fs.Path rootDir)</code> |
| <div class="block">Get the directory for a completed snapshot.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>private static org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#getDefaultWorkingSnapshotDir-org.apache.hadoop.fs.Path-">getDefaultWorkingSnapshotDir</a></span>(org.apache.hadoop.fs.Path rootDir)</code> |
| <div class="block">Get the default working directory for snapshots - where they are built, where they are |
| temporarily copied on export, etc.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#getMaxMasterTimeout-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription.Type-long-">getMaxMasterTimeout</a></span>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription.Type type, |
| long defaultMaxWaitTime)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#getSnapshotRootDir-org.apache.hadoop.fs.Path-">getSnapshotRootDir</a></span>(org.apache.hadoop.fs.Path rootDir)</code> |
| <div class="block">Get the snapshot root directory.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#getSnapshotsDir-org.apache.hadoop.fs.Path-">getSnapshotsDir</a></span>(org.apache.hadoop.fs.Path rootDir)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>private static org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#getSpecifiedSnapshotDir-org.apache.hadoop.fs.Path-java.lang.String-">getSpecifiedSnapshotDir</a></span>(org.apache.hadoop.fs.Path snapshotsDir, |
| <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> snapshotName)</code> |
| <div class="block">Get the directory within the given filepath to store the snapshot instance</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#getWorkingSnapshotDir-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-">getWorkingSnapshotDir</a></span>(org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Get the general working directory for snapshots - where they are built, where they are |
| temporarily copied on export, etc.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#getWorkingSnapshotDir-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-">getWorkingSnapshotDir</a></span>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Get the directory to build a snapshot, before it is finalized</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#getWorkingSnapshotDir-java.lang.String-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-">getWorkingSnapshotDir</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> snapshotName, |
| org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Get the directory to build a snapshot, before it is finalized</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#isSecurityAvailable-org.apache.hadoop.conf.Configuration-">isSecurityAvailable</a></span>(org.apache.hadoop.conf.Configuration conf)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#isSnapshotOwner-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.security.User-">isSnapshotOwner</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a> snapshot, |
| <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user)</code> |
| <div class="block">Check if the user is this table snapshot's owner</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#isSubDirectoryOf-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">isSubDirectoryOf</a></span>(org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.fs.Path rootDir)</code> |
| <div class="block">Determines if the given workingDir is a subdirectory of the given "root directory"</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#isWithinDefaultWorkingDir-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-">isWithinDefaultWorkingDir</a></span>(org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Determines if the given workingDir is a subdirectory of the default working snapshot directory</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#readSnapshotInfo-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-">readSnapshotInfo</a></span>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path snapshotDir)</code> |
| <div class="block">Read in the <code>SnapshotProtos.SnapshotDescription</code> stored for the snapshot in the passed directory</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#validate-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription-org.apache.hadoop.conf.Configuration-">validate</a></span>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Convert the passed snapshot description into a 'full' snapshot description based on default |
| parameters, if none have been supplied.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>private static org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#writeAclToSnapshotDescription-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription-org.apache.hadoop.conf.Configuration-">writeAclToSnapshotDescription</a></span>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.conf.Configuration conf)</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#writeSnapshotInfo-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.FileSystem-">writeSnapshotInfo</a></span>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.fs.FileSystem fs)</code> |
| <div class="block">Write the snapshot description into the working directory of a snapshot</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="LOG"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>private static final org.slf4j.Logger <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.105">LOG</a></pre> |
| </li> |
| </ul> |
| <a name="SNAPSHOT_LAYOUT_VERSION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SNAPSHOT_LAYOUT_VERSION</h4> |
| <pre>public static final int <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.110">SNAPSHOT_LAYOUT_VERSION</a></pre> |
| <div class="block">Version of the fs layout for a snapshot. Future snapshots may have different file layouts, |
| which we may need to read in differently.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.SNAPSHOT_LAYOUT_VERSION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SNAPSHOTINFO_FILE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SNAPSHOTINFO_FILE</h4> |
| <pre>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> <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.116">SNAPSHOTINFO_FILE</a></pre> |
| <div class="block">The file contains the snapshot basic information and it is under the directory of a snapshot.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.SNAPSHOTINFO_FILE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SNAPSHOT_TMP_DIR_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SNAPSHOT_TMP_DIR_NAME</h4> |
| <pre>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> <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.119">SNAPSHOT_TMP_DIR_NAME</a></pre> |
| <div class="block">Temporary directory under the snapshot directory to store in-progress snapshots</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.SNAPSHOT_TMP_DIR_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SNAPSHOT_WORKING_DIR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SNAPSHOT_WORKING_DIR</h4> |
| <pre>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> <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.125">SNAPSHOT_WORKING_DIR</a></pre> |
| <div class="block">The configuration property that determines the filepath of the snapshot |
| base working directory</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.SNAPSHOT_WORKING_DIR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="NO_SNAPSHOT_START_TIME_SPECIFIED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_SNAPSHOT_START_TIME_SPECIFIED</h4> |
| <pre>public static final long <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.129">NO_SNAPSHOT_START_TIME_SPECIFIED</a></pre> |
| <div class="block">Default value if no start time is specified</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.NO_SNAPSHOT_START_TIME_SPECIFIED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="NO_SNAPSHOT_TTL_SPECIFIED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_SNAPSHOT_TTL_SPECIFIED</h4> |
| <pre>private static final long <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.132">NO_SNAPSHOT_TTL_SPECIFIED</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.NO_SNAPSHOT_TTL_SPECIFIED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MASTER_SNAPSHOT_TIMEOUT_MILLIS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MASTER_SNAPSHOT_TIMEOUT_MILLIS</h4> |
| <pre>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> <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.134">MASTER_SNAPSHOT_TIMEOUT_MILLIS</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.MASTER_SNAPSHOT_TIMEOUT_MILLIS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_MAX_WAIT_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_MAX_WAIT_TIME</h4> |
| <pre>public static final long <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.137">DEFAULT_MAX_WAIT_TIME</a></pre> |
| <div class="block">By default, wait 300 seconds for a snapshot to complete</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.DEFAULT_MAX_WAIT_TIME">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="SnapshotDescriptionUtils--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SnapshotDescriptionUtils</h4> |
| <pre>private <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.139">SnapshotDescriptionUtils</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getMaxMasterTimeout-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription.Type-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxMasterTimeout</h4> |
| <pre>public static long <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.149">getMaxMasterTimeout</a>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription.Type type, |
| long defaultMaxWaitTime)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - <code>Configuration</code> from which to check for the timeout</dd> |
| <dd><code>type</code> - type of snapshot being taken</dd> |
| <dd><code>defaultMaxWaitTime</code> - Default amount of time to wait, if none is in the configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the max amount of time the master should wait for a snapshot to complete</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSnapshotRootDir-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSnapshotRootDir</h4> |
| <pre>public static org.apache.hadoop.fs.Path <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.167">getSnapshotRootDir</a>(org.apache.hadoop.fs.Path rootDir)</pre> |
| <div class="block">Get the snapshot root directory. All the snapshots are kept under this directory, i.e. |
| ${hbase.rootdir}/.snapshot</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootDir</code> - hbase root directory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the base directory in which all snapshots are kept</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCompletedSnapshotDir-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompletedSnapshotDir</h4> |
| <pre>public static org.apache.hadoop.fs.Path <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.178">getCompletedSnapshotDir</a>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path rootDir)</pre> |
| <div class="block">Get the directory for a specified snapshot. This directory is a sub-directory of snapshot root |
| directory and all the data files for a snapshot are kept under this directory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshot</code> - snapshot being taken</dd> |
| <dd><code>rootDir</code> - hbase root directory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the final directory for the completed snapshot</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCompletedSnapshotDir-java.lang.String-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompletedSnapshotDir</h4> |
| <pre>public static org.apache.hadoop.fs.Path <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.189">getCompletedSnapshotDir</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> snapshotName, |
| org.apache.hadoop.fs.Path rootDir)</pre> |
| <div class="block">Get the directory for a completed snapshot. This directory is a sub-directory of snapshot root |
| directory and all the data files for a snapshot are kept under this directory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshotName</code> - name of the snapshot being taken</dd> |
| <dd><code>rootDir</code> - hbase root directory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the final directory for the completed snapshot</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWorkingSnapshotDir-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWorkingSnapshotDir</h4> |
| <pre>public static org.apache.hadoop.fs.Path <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.200">getWorkingSnapshotDir</a>(org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</pre> |
| <div class="block">Get the general working directory for snapshots - where they are built, where they are |
| temporarily copied on export, etc.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootDir</code> - root directory of the HBase installation</dd> |
| <dd><code>conf</code> - Configuration of the HBase instance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Path to the snapshot tmp directory, relative to the passed root directory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWorkingSnapshotDir-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWorkingSnapshotDir</h4> |
| <pre>public static org.apache.hadoop.fs.Path <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.212">getWorkingSnapshotDir</a>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</pre> |
| <div class="block">Get the directory to build a snapshot, before it is finalized</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshot</code> - snapshot that will be built</dd> |
| <dd><code>rootDir</code> - root directory of the hbase installation</dd> |
| <dd><code>conf</code> - Configuration of the HBase instance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>Path</code> where one can build a snapshot</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWorkingSnapshotDir-java.lang.String-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWorkingSnapshotDir</h4> |
| <pre>public static org.apache.hadoop.fs.Path <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.224">getWorkingSnapshotDir</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> snapshotName, |
| org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</pre> |
| <div class="block">Get the directory to build a snapshot, before it is finalized</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshotName</code> - name of the snapshot</dd> |
| <dd><code>rootDir</code> - root directory of the hbase installation</dd> |
| <dd><code>conf</code> - Configuration of the HBase instance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>Path</code> where one can build a snapshot</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSpecifiedSnapshotDir-org.apache.hadoop.fs.Path-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpecifiedSnapshotDir</h4> |
| <pre>private static final org.apache.hadoop.fs.Path <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.235">getSpecifiedSnapshotDir</a>(org.apache.hadoop.fs.Path snapshotsDir, |
| <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> snapshotName)</pre> |
| <div class="block">Get the directory within the given filepath to store the snapshot instance</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshotsDir</code> - directory to store snapshot directory within</dd> |
| <dd><code>snapshotName</code> - name of the snapshot to take</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the final directory for the snapshot in the given filepath</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSnapshotsDir-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSnapshotsDir</h4> |
| <pre>public static final org.apache.hadoop.fs.Path <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.243">getSnapshotsDir</a>(org.apache.hadoop.fs.Path rootDir)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootDir</code> - hbase root directory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the directory for all completed snapshots;</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSubDirectoryOf-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSubDirectoryOf</h4> |
| <pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.254">isSubDirectoryOf</a>(org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.fs.Path rootDir)</pre> |
| <div class="block">Determines if the given workingDir is a subdirectory of the given "root directory"</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>workingDir</code> - a directory to check</dd> |
| <dd><code>rootDir</code> - root directory of the HBase installation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the given workingDir is a subdirectory of the given root directory, |
| false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isWithinDefaultWorkingDir-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isWithinDefaultWorkingDir</h4> |
| <pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.266">isWithinDefaultWorkingDir</a>(org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.conf.Configuration conf) |
| 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">Determines if the given workingDir is a subdirectory of the default working snapshot directory</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>workingDir</code> - a directory to check</dd> |
| <dd><code>conf</code> - configuration for the HBase cluster</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the given workingDir is a subdirectory of the default working directory for |
| snapshots, false otherwise</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> - if we can't get the root dir</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultWorkingSnapshotDir-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultWorkingSnapshotDir</h4> |
| <pre>private static org.apache.hadoop.fs.Path <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.278">getDefaultWorkingSnapshotDir</a>(org.apache.hadoop.fs.Path rootDir)</pre> |
| <div class="block">Get the default working directory for snapshots - where they are built, where they are |
| temporarily copied on export, etc.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootDir</code> - root directory of the HBase installation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Path to the default snapshot tmp directory, relative to the passed root directory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>public static org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.292">validate</a>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.conf.Configuration conf) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a>, |
| <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">Convert the passed snapshot description into a 'full' snapshot description based on default |
| parameters, if none have been supplied. This resolves any 'optional' parameters that aren't |
| supplied to their default values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshot</code> - general snapshot descriptor</dd> |
| <dd><code>conf</code> - Configuration to read configured snapshot defaults if snapshot is not complete</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a valid snapshot description</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the <code>SnapshotProtos.SnapshotDescription</code> is not a complete |
| <code>SnapshotProtos.SnapshotDescription</code>.</dd> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeSnapshotInfo-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.FileSystem-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeSnapshotInfo</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.341">writeSnapshotInfo</a>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.fs.FileSystem fs) |
| 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">Write the snapshot description into the working directory of a snapshot</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshot</code> - description of the snapshot being taken</dd> |
| <dd><code>workingDir</code> - working directory of the snapshot</dd> |
| <dd><code>fs</code> - <code>FileSystem</code> on which the snapshot should be taken</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> - if we can't reach the filesystem and the file cannot be cleaned up on |
| failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readSnapshotInfo-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readSnapshotInfo</h4> |
| <pre>public static org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.365">readSnapshotInfo</a>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path snapshotDir) |
| throws <a href="../../../../../org/apache/hadoop/hbase/snapshot/CorruptedSnapshotException.html" title="class in org.apache.hadoop.hbase.snapshot">CorruptedSnapshotException</a></pre> |
| <div class="block">Read in the <code>SnapshotProtos.SnapshotDescription</code> stored for the snapshot in the passed directory</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fs</code> - filesystem where the snapshot was taken</dd> |
| <dd><code>snapshotDir</code> - directory where the snapshot was stored</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the stored snapshot description</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/snapshot/CorruptedSnapshotException.html" title="class in org.apache.hadoop.hbase.snapshot">CorruptedSnapshotException</a></code> - if the snapshot cannot be read</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="completeSnapshot-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>completeSnapshot</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.388">completeSnapshot</a>(org.apache.hadoop.fs.Path snapshotDir, |
| org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.FileSystem workingDirFs, |
| org.apache.hadoop.conf.Configuration conf) |
| throws <a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotCreationException.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotCreationException</a>, |
| <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">Commits the snapshot process by moving the working snapshot |
| to the finalized filepath</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshotDir</code> - The file path of the completed snapshots</dd> |
| <dd><code>workingDir</code> - The file path of the in progress snapshots</dd> |
| <dd><code>fs</code> - The file system of the completed snapshots</dd> |
| <dd><code>workingDirFs</code> - The file system of the in progress snapshots</dd> |
| <dd><code>conf</code> - Configuration</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotCreationException.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotCreationException</a></code> - if the snapshot could not be moved</dd> |
| <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> - the filesystem could not be reached</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSnapshotOwner-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.security.User-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSnapshotOwner</h4> |
| <pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.418">isSnapshotOwner</a>(<a href="../../../../../org/apache/hadoop/hbase/client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a> snapshot, |
| <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user)</pre> |
| <div class="block">Check if the user is this table snapshot's owner</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snapshot</code> - the table snapshot description</dd> |
| <dd><code>user</code> - the user</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the user is the owner of the snapshot, |
| false otherwise or the snapshot owner field is not present.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSecurityAvailable-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSecurityAvailable</h4> |
| <pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.424">isSecurityAvailable</a>(org.apache.hadoop.conf.Configuration conf) |
| 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> |
| <dl> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeAclToSnapshotDescription-org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>writeAclToSnapshotDescription</h4> |
| <pre>private static org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription <a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line.430">writeAclToSnapshotDescription</a>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.conf.Configuration conf) |
| 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> |
| <dl> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SnapshotDescriptionUtils.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotCreationException.html" title="class in org.apache.hadoop.hbase.snapshot"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.CompletedSnaphotDirectoriesFilter.html" title="class in org.apache.hadoop.hbase.snapshot"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html" target="_top">Frames</a></li> |
| <li><a href="SnapshotDescriptionUtils.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><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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
