| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TableBackupClient (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.backup.impl, class: TableBackupClient"> |
| <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/TableBackupClient.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.backup.impl</a></div> |
| <h1 title="Class TableBackupClient" class="title">Class TableBackupClient</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.backup.impl.TableBackupClient</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="FullTableBackupClient.html" title="class in org.apache.hadoop.hbase.backup.impl">FullTableBackupClient</a></code>, <code><a href="IncrementalTableBackupClient.html" title="class in org.apache.hadoop.hbase.backup.impl">IncrementalTableBackupClient</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public abstract class </span><span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-54">TableBackupClient</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">Base class for backup operation. Concrete implementation for full and incremental backup are |
| delegated to corresponding sub-classes: <a href="FullTableBackupClient.html" title="class in org.apache.hadoop.hbase.backup.impl"><code>FullTableBackupClient</code></a> and |
| <a href="IncrementalTableBackupClient.html" title="class in org.apache.hadoop.hbase.backup.impl"><code>IncrementalTableBackupClient</code></a></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 enum </code></div> |
| <div class="col-second even-row-color"><code><a href="TableBackupClient.Stage.html" class="type-name-link" title="enum class in org.apache.hadoop.hbase.backup.impl">TableBackupClient.Stage</a></code></div> |
| <div class="col-last even-row-color"> </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 <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="#BACKUP_CLIENT_IMPL_CLASS" class="member-name-link">BACKUP_CLIENT_IMPL_CLASS</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="#BACKUP_TEST_MODE_STAGE" class="member-name-link">BACKUP_TEST_MODE_STAGE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <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="#backupId" class="member-name-link">backupId</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#backupInfo" class="member-name-link">backupInfo</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="BackupManager.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManager</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#backupManager" class="member-name-link">backupManager</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected org.apache.hadoop.conf.Configuration</code></div> |
| <div class="col-second odd-row-color"><code><a href="#conf" class="member-name-link">conf</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#conn" class="member-name-link">conn</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected org.apache.hadoop.fs.FileSystem</code></div> |
| <div class="col-second odd-row-color"><code><a href="#fs" class="member-name-link">fs</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second even-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#newTimestamps" class="member-name-link">newTimestamps</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#tableList" class="member-name-link">tableList</a></code></div> |
| <div class="col-last even-row-color"> </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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">TableBackupClient</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.client.Connection,java.lang.String,org.apache.hadoop.hbase.backup.BackupRequest)" class="member-name-link">TableBackupClient</a><wbr>(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <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> backupId, |
| <a href="../BackupRequest.html" title="class in org.apache.hadoop.hbase.backup">BackupRequest</a> request)</code></div> |
| <div class="col-last odd-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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addManifest(org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.hbase.backup.BackupType,org.apache.hadoop.conf.Configuration)" class="member-name-link">addManifest</a><wbr>(<a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| <a href="../BackupType.html" title="enum class in org.apache.hadoop.hbase.backup">BackupType</a> type, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a manifest based on the provided info, and store it in the backup-specific directory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#beginBackup(org.apache.hadoop.hbase.backup.impl.BackupManager,org.apache.hadoop.hbase.backup.BackupInfo)" class="member-name-link">beginBackup</a><wbr>(<a href="BackupManager.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManager</a> backupManager, |
| <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Begin the overall backup.</div> |
| </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="#cleanupAndRestoreBackupSystem(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.conf.Configuration)" class="member-name-link">cleanupAndRestoreBackupSystem</a><wbr>(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| 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>protected 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="#cleanupExportSnapshotLog(org.apache.hadoop.conf.Configuration)" class="member-name-link">cleanupExportSnapshotLog</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 class="block">Clean up directories with prefix "exportSnapshot-", which are generated when exporting |
| snapshots.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected 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="#cleanupTargetDir(org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.conf.Configuration)" class="member-name-link">cleanupTargetDir</a><wbr>(<a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| 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">Clean up the uncompleted data at target directory if the ongoing backup has already entered the |
| copy phase.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#completeBackup(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.hbase.backup.BackupType,org.apache.hadoop.conf.Configuration)" class="member-name-link">completeBackup</a><wbr>(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| <a href="../BackupType.html" title="enum class in org.apache.hadoop.hbase.backup">BackupType</a> type, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Complete the overall backup.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected 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="#deleteSnapshots(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.conf.Configuration)" class="member-name-link">deleteSnapshots</a><wbr>(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| 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">Delete HBase snapshot for backup.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Backup request execution.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#failBackup(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.hbase.backup.impl.BackupManager,java.lang.Exception,java.lang.String,org.apache.hadoop.hbase.backup.BackupType,org.apache.hadoop.conf.Configuration)" class="member-name-link">failBackup</a><wbr>(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| <a href="BackupManager.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManager</a> backupManager, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a> e, |
| <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> msg, |
| <a href="../BackupType.html" title="enum class in org.apache.hadoop.hbase.backup">BackupType</a> type, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Fail the overall backup.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#failStageIf(org.apache.hadoop.hbase.backup.impl.TableBackupClient.Stage)" class="member-name-link">failStageIf</a><wbr>(<a href="TableBackupClient.Stage.html" title="enum class in org.apache.hadoop.hbase.backup.impl">TableBackupClient.Stage</a> stage)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="BackupManifest.BackupImage.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManifest.BackupImage</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAncestors(org.apache.hadoop.hbase.backup.BackupInfo)" class="member-name-link">getAncestors</a><wbr>(<a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the direct ancestors of the currently being created backup.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMessage(java.lang.Exception)" class="member-name-link">getMessage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a> e)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="TableBackupClient.Stage.html" title="enum class in org.apache.hadoop.hbase.backup.impl">TableBackupClient.Stage</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTestStage()" class="member-name-link">getTestStage</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#init(org.apache.hadoop.hbase.client.Connection,java.lang.String,org.apache.hadoop.hbase.backup.BackupRequest)" class="member-name-link">init</a><wbr>(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <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> backupId, |
| <a href="../BackupRequest.html" title="class in org.apache.hadoop.hbase.backup">BackupRequest</a> request)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#obtainBackupMetaDataStr(org.apache.hadoop.hbase.backup.BackupInfo)" class="member-name-link">obtainBackupMetaDataStr</a><wbr>(<a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get backup request meta data dir as string.</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="BACKUP_CLIENT_IMPL_CLASS"> |
| <h3>BACKUP_CLIENT_IMPL_CLASS</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/backup/impl/TableBackupClient.html#line-57">BACKUP_CLIENT_IMPL_CLASS</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.backup.impl.TableBackupClient.BACKUP_CLIENT_IMPL_CLASS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="BACKUP_TEST_MODE_STAGE"> |
| <h3>BACKUP_TEST_MODE_STAGE</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/backup/impl/TableBackupClient.html#line-59">BACKUP_TEST_MODE_STAGE</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.backup.impl.TableBackupClient.BACKUP_TEST_MODE_STAGE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <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/backup/impl/TableBackupClient.html#line-61">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="conf"> |
| <h3>conf</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.hadoop.conf.Configuration</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-63">conf</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="conn"> |
| <h3>conn</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-64">conn</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="backupId"> |
| <h3>backupId</h3> |
| <div class="member-signature"><span class="modifiers">protected</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/backup/impl/TableBackupClient.html#line-65">backupId</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="tableList"> |
| <h3>tableList</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-66">tableList</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newTimestamps"> |
| <h3>newTimestamps</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-67">newTimestamps</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="backupManager"> |
| <h3>backupManager</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="BackupManager.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManager</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-69">backupManager</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="backupInfo"> |
| <h3>backupInfo</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-70">backupInfo</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fs"> |
| <h3>fs</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.hadoop.fs.FileSystem</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-71">fs</a></span></div> |
| </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>TableBackupClient</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-73">TableBackupClient</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.client.Connection,java.lang.String,org.apache.hadoop.hbase.backup.BackupRequest)"> |
| <h3>TableBackupClient</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-76">TableBackupClient</a></span><wbr><span class="parameters">(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <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> backupId, |
| <a href="../BackupRequest.html" title="class in org.apache.hadoop.hbase.backup">BackupRequest</a> request)</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> |
| </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="init(org.apache.hadoop.hbase.client.Connection,java.lang.String,org.apache.hadoop.hbase.backup.BackupRequest)"> |
| <h3>init</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-81">init</a></span><wbr><span class="parameters">(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <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> backupId, |
| <a href="../BackupRequest.html" title="class in org.apache.hadoop.hbase.backup">BackupRequest</a> request)</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="beginBackup(org.apache.hadoop.hbase.backup.impl.BackupManager,org.apache.hadoop.hbase.backup.BackupInfo)"> |
| <h3>beginBackup</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-108">beginBackup</a></span><wbr><span class="parameters">(<a href="BackupManager.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManager</a> backupManager, |
| <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo)</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">Begin the overall backup.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>backupInfo</code> - backup info</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> - exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMessage(java.lang.Exception)"> |
| <h3>getMessage</h3> |
| <div class="member-signature"><span class="modifiers">protected</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/backup/impl/TableBackupClient.html#line-127">getMessage</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a> e)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deleteSnapshots(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.conf.Configuration)"> |
| <h3>deleteSnapshots</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-140">deleteSnapshots</a></span><wbr><span class="parameters">(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| 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">Delete HBase snapshot for backup.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>backupInfo</code> - backup info</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> - exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanupExportSnapshotLog(org.apache.hadoop.conf.Configuration)"> |
| <h3>cleanupExportSnapshotLog</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-162">cleanupExportSnapshotLog</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> |
| <div class="block">Clean up directories with prefix "exportSnapshot-", which are generated when exporting |
| snapshots.</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> - exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanupTargetDir(org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.conf.Configuration)"> |
| <h3>cleanupTargetDir</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-184">cleanupTargetDir</a></span><wbr><span class="parameters">(<a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Clean up the uncompleted data at target directory if the ongoing backup has already entered the |
| copy phase.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="failBackup(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.hbase.backup.impl.BackupManager,java.lang.Exception,java.lang.String,org.apache.hadoop.hbase.backup.BackupType,org.apache.hadoop.conf.Configuration)"> |
| <h3>failBackup</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-229">failBackup</a></span><wbr><span class="parameters">(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| <a href="BackupManager.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManager</a> backupManager, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a> e, |
| <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> msg, |
| <a href="../BackupType.html" title="enum class in org.apache.hadoop.hbase.backup">BackupType</a> type, |
| 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">Fail the overall backup.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>backupInfo</code> - backup info</dd> |
| <dd><code>e</code> - exception</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> - exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanupAndRestoreBackupSystem(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.conf.Configuration)"> |
| <h3>cleanupAndRestoreBackupSystem</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/backup/impl/TableBackupClient.html#line-257">cleanupAndRestoreBackupSystem</a></span><wbr><span class="parameters">(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| 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="addManifest(org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.hbase.backup.BackupType,org.apache.hadoop.conf.Configuration)"> |
| <h3>addManifest</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-279">addManifest</a></span><wbr><span class="parameters">(<a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| <a href="../BackupType.html" title="enum class in org.apache.hadoop.hbase.backup">BackupType</a> type, |
| 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">Creates a manifest based on the provided info, and store it in the backup-specific directory.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>backupInfo</code> - The current backup info</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> - exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAncestors(org.apache.hadoop.hbase.backup.BackupInfo)"> |
| <h3>getAncestors</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="BackupManifest.BackupImage.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManifest.BackupImage</a>></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-300">getAncestors</a></span><wbr><span class="parameters">(<a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo)</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">Gets the direct ancestors of the currently being created backup.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>backupInfo</code> - The backup info for the backup being created</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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="obtainBackupMetaDataStr(org.apache.hadoop.hbase.backup.BackupInfo)"> |
| <h3>obtainBackupMetaDataStr</h3> |
| <div class="member-signature"><span class="modifiers">protected</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/backup/impl/TableBackupClient.html#line-353">obtainBackupMetaDataStr</a></span><wbr><span class="parameters">(<a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo)</span></div> |
| <div class="block">Get backup request meta data dir as string.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>backupInfo</code> - backup info</dd> |
| <dt>Returns:</dt> |
| <dd>meta data dir</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="completeBackup(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.backup.BackupInfo,org.apache.hadoop.hbase.backup.BackupType,org.apache.hadoop.conf.Configuration)"> |
| <h3>completeBackup</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-372">completeBackup</a></span><wbr><span class="parameters">(<a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <a href="../BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a> backupInfo, |
| <a href="../BackupType.html" title="enum class in org.apache.hadoop.hbase.backup">BackupType</a> type, |
| 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">Complete the overall backup.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>backupInfo</code> - backup info</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> - exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execute()"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-412">execute</a></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">Backup request execution.</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> - if the execution of the backup fails</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTestStage()"> |
| <h3>getTestStage</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="TableBackupClient.Stage.html" title="enum class in org.apache.hadoop.hbase.backup.impl">TableBackupClient.Stage</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-414">getTestStage</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="failStageIf(org.apache.hadoop.hbase.backup.impl.TableBackupClient.Stage)"> |
| <h3>failStageIf</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/TableBackupClient.html#line-418">failStageIf</a></span><wbr><span class="parameters">(<a href="TableBackupClient.Stage.html" title="enum class in org.apache.hadoop.hbase.backup.impl">TableBackupClient.Stage</a> stage)</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> |
| </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> |
