| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SnapshotDescriptionUtils (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.snapshot, class: SnapshotDescriptionUtils"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <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> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.snapshot</a></div> |
| <h1 title="Class SnapshotDescriptionUtils" class="title">Class SnapshotDescriptionUtils</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public final class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-89">SnapshotDescriptionUtils</a></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <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="#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> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="SnapshotDescriptionUtils.CompletedSnaphotDirectoriesFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.snapshot">SnapshotDescriptionUtils.CompletedSnaphotDirectoriesFilter</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Filter that only accepts completed snapshot directories</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final long</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_MAX_WAIT_TIME" class="member-name-link">DEFAULT_MAX_WAIT_TIME</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">By default, wait 300 seconds for a snapshot to complete</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#MASTER_SNAPSHOT_TIMEOUT_MILLIS" class="member-name-link">MASTER_SNAPSHOT_TIMEOUT_MILLIS</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#NO_SNAPSHOT_START_TIME_SPECIFIED" class="member-name-link">NO_SNAPSHOT_START_TIME_SPECIFIED</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Default value if no start time is specified</div> |
| </div> |
| <div class="col-first even-row-color"><code>private static final long</code></div> |
| <div class="col-second even-row-color"><code><a href="#NO_SNAPSHOT_TTL_SPECIFIED" class="member-name-link">NO_SNAPSHOT_TTL_SPECIFIED</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SNAPSHOT_CORRUPTED_FILE" class="member-name-link">SNAPSHOT_CORRUPTED_FILE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#SNAPSHOT_LAYOUT_VERSION" class="member-name-link">SNAPSHOT_LAYOUT_VERSION</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Version of the fs layout for a snapshot.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SNAPSHOT_TMP_DIR_NAME" class="member-name-link">SNAPSHOT_TMP_DIR_NAME</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Temporary directory under the snapshot directory to store in-progress snapshots</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#SNAPSHOT_WORKING_DIR" class="member-name-link">SNAPSHOT_WORKING_DIR</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The configuration property that determines the filepath of the snapshot base working directory</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SNAPSHOTINFO_FILE" class="member-name-link">SNAPSHOTINFO_FILE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The file contains the snapshot basic information and it is under the directory of a snapshot.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SnapshotDescriptionUtils</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#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)" class="member-name-link">completeSnapshot</a><wbr>(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> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Commits the snapshot process by moving the working snapshot to the finalized filepath</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCompletedSnapshotDir(java.lang.String,org.apache.hadoop.fs.Path)" class="member-name-link">getCompletedSnapshotDir</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName, |
| org.apache.hadoop.fs.Path rootDir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the directory for a completed snapshot.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCompletedSnapshotDir(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,org.apache.hadoop.fs.Path)" class="member-name-link">getCompletedSnapshotDir</a><wbr>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path rootDir)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the directory for a specified snapshot.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCorruptedFlagFileForSnapshot(org.apache.hadoop.fs.Path)" class="member-name-link">getCorruptedFlagFileForSnapshot</a><wbr>(org.apache.hadoop.fs.Path workingDir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the flag file path if the snapshot is corrupted</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDefaultWorkingSnapshotDir(org.apache.hadoop.fs.Path)" class="member-name-link">getDefaultWorkingSnapshotDir</a><wbr>(org.apache.hadoop.fs.Path rootDir)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the default working directory for snapshots - where they are built, where they are |
| temporarily copied on export, etc.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxMasterTimeout(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription.Type,long)" class="member-name-link">getMaxMasterTimeout</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription.Type type, |
| long defaultMaxWaitTime)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSnapshotRootDir(org.apache.hadoop.fs.Path)" class="member-name-link">getSnapshotRootDir</a><wbr>(org.apache.hadoop.fs.Path rootDir)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the snapshot root directory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSnapshotsDir(org.apache.hadoop.fs.Path)" class="member-name-link">getSnapshotsDir</a><wbr>(org.apache.hadoop.fs.Path rootDir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static final org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSpecifiedSnapshotDir(org.apache.hadoop.fs.Path,java.lang.String)" class="member-name-link">getSpecifiedSnapshotDir</a><wbr>(org.apache.hadoop.fs.Path snapshotsDir, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the directory within the given filepath to store the snapshot instance</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getWorkingSnapshotDir(java.lang.String,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)" class="member-name-link">getWorkingSnapshotDir</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName, |
| org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the directory to build a snapshot, before it is finalized</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getWorkingSnapshotDir(org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)" class="member-name-link">getWorkingSnapshotDir</a><wbr>(org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the general working directory for snapshots - where they are built, where they are |
| temporarily copied on export, etc.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getWorkingSnapshotDir(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)" class="member-name-link">getWorkingSnapshotDir</a><wbr>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the directory to build a snapshot, before it is finalized</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isExpiredSnapshot(long,long,long)" class="member-name-link">isExpiredSnapshot</a><wbr>(long snapshotTtl, |
| long snapshotCreatedTime, |
| long currentTime)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Method to check whether TTL has expired for specified snapshot creation time and snapshot ttl.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isSecurityAvailable(org.apache.hadoop.conf.Configuration)" class="member-name-link">isSecurityAvailable</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isSnapshotOwner(org.apache.hadoop.hbase.client.SnapshotDescription,org.apache.hadoop.hbase.security.User)" class="member-name-link">isSnapshotOwner</a><wbr>(<a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a> snapshot, |
| <a href="../security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Check if the user is this table snapshot's owner</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isSubDirectoryOf(org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path)" class="member-name-link">isSubDirectoryOf</a><wbr>(org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.fs.Path rootDir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Determines if the given workingDir is a subdirectory of the given "root directory"</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isWithinDefaultWorkingDir(org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)" class="member-name-link">isWithinDefaultWorkingDir</a><wbr>(org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Determines if the given workingDir is a subdirectory of the default working snapshot directory</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#readSnapshotInfo(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">readSnapshotInfo</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path snapshotDir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Read in the <code>SnapshotProtos.SnapshotDescription</code> stored for the snapshot in the passed directory</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#shouldSkipRenameSnapshotDirectories(java.net.URI,java.net.URI)" class="member-name-link">shouldSkipRenameSnapshotDirectories</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> workingURI, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> rootURI)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#validate(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,org.apache.hadoop.conf.Configuration)" class="member-name-link">validate</a><wbr>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Convert the passed snapshot description into a 'full' snapshot description based on default |
| parameters, if none have been supplied.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#writeAclToSnapshotDescription(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,org.apache.hadoop.conf.Configuration)" class="member-name-link">writeAclToSnapshotDescription</a><wbr>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#writeSnapshotInfo(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem)" class="member-name-link">writeSnapshotInfo</a><wbr>(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.fs.FileSystem fs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Write the snapshot description into the working directory of a snapshot</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-104">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_LAYOUT_VERSION"> |
| <h3>SNAPSHOT_LAYOUT_VERSION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-109">SNAPSHOT_LAYOUT_VERSION</a></span></div> |
| <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 class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.SNAPSHOT_LAYOUT_VERSION">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOTINFO_FILE"> |
| <h3>SNAPSHOTINFO_FILE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-115">SNAPSHOTINFO_FILE</a></span></div> |
| <div class="block">The file contains the snapshot basic information and it is under the directory of a snapshot.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.SNAPSHOTINFO_FILE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_TMP_DIR_NAME"> |
| <h3>SNAPSHOT_TMP_DIR_NAME</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-118">SNAPSHOT_TMP_DIR_NAME</a></span></div> |
| <div class="block">Temporary directory under the snapshot directory to store in-progress snapshots</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.SNAPSHOT_TMP_DIR_NAME">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_WORKING_DIR"> |
| <h3>SNAPSHOT_WORKING_DIR</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-123">SNAPSHOT_WORKING_DIR</a></span></div> |
| <div class="block">The configuration property that determines the filepath of the snapshot base working directory</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.SNAPSHOT_WORKING_DIR">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="NO_SNAPSHOT_START_TIME_SPECIFIED"> |
| <h3>NO_SNAPSHOT_START_TIME_SPECIFIED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-127">NO_SNAPSHOT_START_TIME_SPECIFIED</a></span></div> |
| <div class="block">Default value if no start time is specified</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.NO_SNAPSHOT_START_TIME_SPECIFIED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="NO_SNAPSHOT_TTL_SPECIFIED"> |
| <h3>NO_SNAPSHOT_TTL_SPECIFIED</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-130">NO_SNAPSHOT_TTL_SPECIFIED</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.NO_SNAPSHOT_TTL_SPECIFIED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MASTER_SNAPSHOT_TIMEOUT_MILLIS"> |
| <h3>MASTER_SNAPSHOT_TIMEOUT_MILLIS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-132">MASTER_SNAPSHOT_TIMEOUT_MILLIS</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.MASTER_SNAPSHOT_TIMEOUT_MILLIS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_MAX_WAIT_TIME"> |
| <h3>DEFAULT_MAX_WAIT_TIME</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-136">DEFAULT_MAX_WAIT_TIME</a></span></div> |
| <div class="block">By default, wait 300 seconds for a snapshot to complete</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.DEFAULT_MAX_WAIT_TIME">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_CORRUPTED_FILE"> |
| <h3>SNAPSHOT_CORRUPTED_FILE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-138">SNAPSHOT_CORRUPTED_FILE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils.SNAPSHOT_CORRUPTED_FILE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>SnapshotDescriptionUtils</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-140">SnapshotDescriptionUtils</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getMaxMasterTimeout(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription.Type,long)"> |
| <h3>getMaxMasterTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-150">getMaxMasterTimeout</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription.Type type, |
| long defaultMaxWaitTime)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>the max amount of time the master should wait for a snapshot to complete</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSnapshotRootDir(org.apache.hadoop.fs.Path)"> |
| <h3>getSnapshotRootDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-168">getSnapshotRootDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path rootDir)</span></div> |
| <div class="block">Get the snapshot root directory. All the snapshots are kept under this directory, i.e. |
| ${hbase.rootdir}/.snapshot</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rootDir</code> - hbase root directory</dd> |
| <dt>Returns:</dt> |
| <dd>the base directory in which all snapshots are kept</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCompletedSnapshotDir(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,org.apache.hadoop.fs.Path)"> |
| <h3>getCompletedSnapshotDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-179">getCompletedSnapshotDir</a></span><wbr><span class="parameters">(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path rootDir)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>snapshot</code> - snapshot being taken</dd> |
| <dd><code>rootDir</code> - hbase root directory</dd> |
| <dt>Returns:</dt> |
| <dd>the final directory for the completed snapshot</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCompletedSnapshotDir(java.lang.String,org.apache.hadoop.fs.Path)"> |
| <h3>getCompletedSnapshotDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-191">getCompletedSnapshotDir</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName, |
| org.apache.hadoop.fs.Path rootDir)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>snapshotName</code> - name of the snapshot being taken</dd> |
| <dd><code>rootDir</code> - hbase root directory</dd> |
| <dt>Returns:</dt> |
| <dd>the final directory for the completed snapshot</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWorkingSnapshotDir(org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)"> |
| <h3>getWorkingSnapshotDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-202">getWorkingSnapshotDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Get the general working directory for snapshots - where they are built, where they are |
| temporarily copied on export, etc.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rootDir</code> - root directory of the HBase installation</dd> |
| <dd><code>conf</code> - Configuration of the HBase instance</dd> |
| <dt>Returns:</dt> |
| <dd>Path to the snapshot tmp directory, relative to the passed root directory</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWorkingSnapshotDir(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)"> |
| <h3>getWorkingSnapshotDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-214">getWorkingSnapshotDir</a></span><wbr><span class="parameters">(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Get the directory to build a snapshot, before it is finalized</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd><code>Path</code> where one can build a snapshot</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWorkingSnapshotDir(java.lang.String,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)"> |
| <h3>getWorkingSnapshotDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-226">getWorkingSnapshotDir</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName, |
| org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Get the directory to build a snapshot, before it is finalized</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd><code>Path</code> where one can build a snapshot</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCorruptedFlagFileForSnapshot(org.apache.hadoop.fs.Path)"> |
| <h3>getCorruptedFlagFileForSnapshot</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-236">getCorruptedFlagFileForSnapshot</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path workingDir)</span></div> |
| <div class="block">Get the flag file path if the snapshot is corrupted</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>workingDir</code> - the directory where we build the specific snapshot</dd> |
| <dt>Returns:</dt> |
| <dd><code>Path</code> snapshot corrupted flag file path</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSpecifiedSnapshotDir(org.apache.hadoop.fs.Path,java.lang.String)"> |
| <h3>getSpecifiedSnapshotDir</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-246">getSpecifiedSnapshotDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path snapshotsDir, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName)</span></div> |
| <div class="block">Get the directory within the given filepath to store the snapshot instance</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>snapshotsDir</code> - directory to store snapshot directory within</dd> |
| <dd><code>snapshotName</code> - name of the snapshot to take</dd> |
| <dt>Returns:</dt> |
| <dd>the final directory for the snapshot in the given filepath</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSnapshotsDir(org.apache.hadoop.fs.Path)"> |
| <h3>getSnapshotsDir</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-254">getSnapshotsDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path rootDir)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rootDir</code> - hbase root directory</dd> |
| <dt>Returns:</dt> |
| <dd>the directory for all completed snapshots;</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSubDirectoryOf(org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path)"> |
| <h3>isSubDirectoryOf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-265">isSubDirectoryOf</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.fs.Path rootDir)</span></div> |
| <div class="block">Determines if the given workingDir is a subdirectory of the given "root directory"</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>workingDir</code> - a directory to check</dd> |
| <dd><code>rootDir</code> - root directory of the HBase installation</dd> |
| <dt>Returns:</dt> |
| <dd>true if the given workingDir is a subdirectory of the given root directory, false |
| otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isWithinDefaultWorkingDir(org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)"> |
| <h3>isWithinDefaultWorkingDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-277">isWithinDefaultWorkingDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.conf.Configuration conf)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Determines if the given workingDir is a subdirectory of the default working snapshot directory</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>workingDir</code> - a directory to check</dd> |
| <dd><code>conf</code> - configuration for the HBase cluster</dd> |
| <dt>Returns:</dt> |
| <dd>true if the given workingDir is a subdirectory of the default working directory for |
| snapshots, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if we can't get the root dir</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDefaultWorkingSnapshotDir(org.apache.hadoop.fs.Path)"> |
| <h3>getDefaultWorkingSnapshotDir</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-289">getDefaultWorkingSnapshotDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path rootDir)</span></div> |
| <div class="block">Get the default working directory for snapshots - where they are built, where they are |
| temporarily copied on export, etc.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rootDir</code> - root directory of the HBase installation</dd> |
| <dt>Returns:</dt> |
| <dd>Path to the default snapshot tmp directory, relative to the passed root directory</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,org.apache.hadoop.conf.Configuration)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-303">validate</a></span><wbr><span class="parameters">(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.conf.Configuration conf)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>a valid snapshot description</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">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/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeSnapshotInfo(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem)"> |
| <h3>writeSnapshotInfo</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-367">writeSnapshotInfo</a></span><wbr><span class="parameters">(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.fs.Path workingDir, |
| org.apache.hadoop.fs.FileSystem fs)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Write the snapshot description into the working directory of a snapshot</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if we can't reach the filesystem and the file cannot be cleaned up on |
| failure</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readSnapshotInfo(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>readSnapshotInfo</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-391">readSnapshotInfo</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path snapshotDir)</span> |
| throws <span class="exceptions"><a href="CorruptedSnapshotException.html" title="class in org.apache.hadoop.hbase.snapshot">CorruptedSnapshotException</a></span></div> |
| <div class="block">Read in the <code>SnapshotProtos.SnapshotDescription</code> stored for the snapshot in the passed directory</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - filesystem where the snapshot was taken</dd> |
| <dd><code>snapshotDir</code> - directory where the snapshot was stored</dd> |
| <dt>Returns:</dt> |
| <dd>the stored snapshot description</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="CorruptedSnapshotException.html" title="class in org.apache.hadoop.hbase.snapshot">CorruptedSnapshotException</a></code> - if the snapshot cannot be read</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="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)"> |
| <h3>completeSnapshot</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-411">completeSnapshot</a></span><wbr><span class="parameters">(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)</span> |
| throws <span class="exceptions"><a href="SnapshotCreationException.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotCreationException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Commits the snapshot process by moving the working snapshot to the finalized filepath</div> |
| <dl class="notes"> |
| <dt>Parameters:</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>Throws:</dt> |
| <dd><code><a href="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/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - the filesystem could not be reached</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldSkipRenameSnapshotDirectories(java.net.URI,java.net.URI)"> |
| <h3>shouldSkipRenameSnapshotDirectories</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-433">shouldSkipRenameSnapshotDirectories</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> workingURI, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> rootURI)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSnapshotOwner(org.apache.hadoop.hbase.client.SnapshotDescription,org.apache.hadoop.hbase.security.User)"> |
| <h3>isSnapshotOwner</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-471">isSnapshotOwner</a></span><wbr><span class="parameters">(<a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a> snapshot, |
| <a href="../security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user)</span></div> |
| <div class="block">Check if the user is this table snapshot's owner</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>snapshot</code> - the table snapshot description</dd> |
| <dd><code>user</code> - the user</dd> |
| <dt>Returns:</dt> |
| <dd>true if the user is the owner of the snapshot, false otherwise or the snapshot owner |
| field is not present.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSecurityAvailable(org.apache.hadoop.conf.Configuration)"> |
| <h3>isSecurityAvailable</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-477">isSecurityAvailable</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeAclToSnapshotDescription(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,org.apache.hadoop.conf.Configuration)"> |
| <h3>writeAclToSnapshotDescription</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-484">writeAclToSnapshotDescription</a></span><wbr><span class="parameters">(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, |
| org.apache.hadoop.conf.Configuration conf)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isExpiredSnapshot(long,long,long)"> |
| <h3>isExpiredSnapshot</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.html#line-505">isExpiredSnapshot</a></span><wbr><span class="parameters">(long snapshotTtl, |
| long snapshotCreatedTime, |
| long currentTime)</span></div> |
| <div class="block">Method to check whether TTL has expired for specified snapshot creation time and snapshot ttl. |
| NOTE: For backward compatibility (after the patch deployment on HMaster), any snapshot with ttl |
| 0 is to be considered as snapshot to keep FOREVER. Default ttl value specified by |
| <a href="../HConstants.html#DEFAULT_SNAPSHOT_TTL"><code>HConstants.DEFAULT_SNAPSHOT_TTL</code></a></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if ttl has expired, or, false, otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
