Published site at d5aaeee88b331e064830a2774f4fed238631457c.
[hbase-site.git] / devapidocs / org / apache / hadoop / hbase / backup / impl / BackupCommands.DeleteCommand.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc -->
6 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7 <title>BackupCommands.DeleteCommand (Apache HBase 3.0.0-SNAPSHOT API)</title>
8 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
9 <script type="text/javascript" src="../../../../../../script.js"></script>
10 </head>
11 <body>
12 <script type="text/javascript"><!--
13 try {
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="BackupCommands.DeleteCommand (Apache HBase 3.0.0-SNAPSHOT API)";
16 }
17 }
18 catch(err) {
19 }
20 //-->
21 var methods = {"i0":10,"i1":10,"i2":10};
22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var activeTableTab = "activeTableTab";
27 </script>
28 <noscript>
29 <div>JavaScript is disabled on your browser.</div>
30 </noscript>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
33 <!-- -->
34 </a>
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
37 <!-- -->
38 </a>
39 <ul class="navList" title="Navigation">
40 <li><a href="../../../../../../overview-summary.html">Overview</a></li>
41 <li><a href="package-summary.html">Package</a></li>
42 <li class="navBarCell1Rev">Class</li>
43 <li><a href="class-use/BackupCommands.DeleteCommand.html">Use</a></li>
44 <li><a href="package-tree.html">Tree</a></li>
45 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
46 <li><a href="../../../../../../index-all.html">Index</a></li>
47 <li><a href="../../../../../../help-doc.html">Help</a></li>
48 </ul>
49 </div>
50 <div class="subNav">
51 <ul class="navList">
52 <li><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.CreateCommand.html" title="class in org.apache.hadoop.hbase.backup.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53 <li><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.DescribeCommand.html" title="class in org.apache.hadoop.hbase.backup.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54 </ul>
55 <ul class="navList">
56 <li><a href="../../../../../../index.html?org/apache/hadoop/hbase/backup/impl/BackupCommands.DeleteCommand.html" target="_top">Frames</a></li>
57 <li><a href="BackupCommands.DeleteCommand.html" target="_top">No&nbsp;Frames</a></li>
58 </ul>
59 <ul class="navList" id="allclasses_navbar_top">
60 <li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61 </ul>
62 <div>
63 <script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
65 if(window==top) {
66 allClassesLink.style.display = "block";
67 }
68 else {
69 allClassesLink.style.display = "none";
70 }
71 //-->
72 </script>
73 </div>
74 <div>
75 <ul class="subNavList">
76 <li>Summary:&nbsp;</li>
77 <li>Nested&nbsp;|&nbsp;</li>
78 <li><a href="#fields.inherited.from.class.org.apache.hadoop.hbase.backup.impl.BackupCommands.Command">Field</a>&nbsp;|&nbsp;</li>
79 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80 <li><a href="#method.summary">Method</a></li>
81 </ul>
82 <ul class="subNavList">
83 <li>Detail:&nbsp;</li>
84 <li>Field&nbsp;|&nbsp;</li>
85 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86 <li><a href="#method.detail">Method</a></li>
87 </ul>
88 </div>
89 <a name="skip.navbar.top">
90 <!-- -->
91 </a></div>
92 <!-- ========= END OF TOP NAVBAR ========= -->
93 <!-- ======== START OF CLASS DATA ======== -->
94 <div class="header">
95 <div class="subTitle">org.apache.hadoop.hbase.backup.impl</div>
96 <h2 title="Class BackupCommands.DeleteCommand" class="title">Class BackupCommands.DeleteCommand</h2>
97 </div>
98 <div class="contentContainer">
99 <ul class="inheritance">
100 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
101 <li>
102 <ul class="inheritance">
103 <li>org.apache.hadoop.conf.Configured</li>
104 <li>
105 <ul class="inheritance">
106 <li><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html" title="class in org.apache.hadoop.hbase.backup.impl">org.apache.hadoop.hbase.backup.impl.BackupCommands.Command</a></li>
107 <li>
108 <ul class="inheritance">
109 <li>org.apache.hadoop.hbase.backup.impl.BackupCommands.DeleteCommand</li>
110 </ul>
111 </li>
112 </ul>
113 </li>
114 </ul>
115 </li>
116 </ul>
117 <div class="description">
118 <ul class="blockList">
119 <li class="blockList">
120 <dl>
121 <dt>All Implemented Interfaces:</dt>
122 <dd>org.apache.hadoop.conf.Configurable</dd>
123 </dl>
124 <dl>
125 <dt>Enclosing class:</dt>
126 <dd><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupCommands</a></dd>
127 </dl>
128 <hr>
129 <br>
130 <pre>public static class <a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/BackupCommands.html#line.550">BackupCommands.DeleteCommand</a>
131 extends <a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupCommands.Command</a></pre>
132 </li>
133 </ul>
134 </div>
135 <div class="summary">
136 <ul class="blockList">
137 <li class="blockList">
138 <!-- =========== FIELD SUMMARY =========== -->
139 <ul class="blockList">
140 <li class="blockList"><a name="field.summary">
141 <!-- -->
142 </a>
143 <h3>Field Summary</h3>
144 <ul class="blockList">
145 <li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.backup.impl.BackupCommands.Command">
146 <!-- -->
147 </a>
148 <h3>Fields inherited from class&nbsp;org.apache.hadoop.hbase.backup.impl.<a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupCommands.Command</a></h3>
149 <code><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html#cmdline">cmdline</a>, <a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html#conn">conn</a></code></li>
150 </ul>
151 </li>
152 </ul>
153 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
154 <ul class="blockList">
155 <li class="blockList"><a name="constructor.summary">
156 <!-- -->
157 </a>
158 <h3>Constructor Summary</h3>
159 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
160 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
161 <tr>
162 <th class="colOne" scope="col">Constructor and Description</th>
163 </tr>
164 <tr class="altColor">
165 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.DeleteCommand.html#DeleteCommand-org.apache.hadoop.conf.Configuration-org.apache.commons.cli.CommandLine-">DeleteCommand</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
166 org.apache.commons.cli.CommandLine&nbsp;cmdline)</code>&nbsp;</td>
167 </tr>
168 </table>
169 </li>
170 </ul>
171 <!-- ========== METHOD SUMMARY =========== -->
172 <ul class="blockList">
173 <li class="blockList"><a name="method.summary">
174 <!-- -->
175 </a>
176 <h3>Method Summary</h3>
177 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
178 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
179 <tr>
180 <th class="colFirst" scope="col">Modifier and Type</th>
181 <th class="colLast" scope="col">Method and Description</th>
182 </tr>
183 <tr id="i0" class="altColor">
184 <td class="colFirst"><code>void</code></td>
185 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.DeleteCommand.html#execute--">execute</a></span>()</code>&nbsp;</td>
186 </tr>
187 <tr id="i1" class="rowColor">
188 <td class="colFirst"><code>protected void</code></td>
189 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.DeleteCommand.html#printUsage--">printUsage</a></span>()</code>&nbsp;</td>
190 </tr>
191 <tr id="i2" class="altColor">
192 <td class="colFirst"><code>protected boolean</code></td>
193 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.DeleteCommand.html#requiresNoActiveSession--">requiresNoActiveSession</a></span>()</code>
194 <div class="block">The command can't be run if active backup session is in progress</div>
195 </td>
196 </tr>
197 </table>
198 <ul class="blockList">
199 <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.backup.impl.BackupCommands.Command">
200 <!-- -->
201 </a>
202 <h3>Methods inherited from class&nbsp;org.apache.hadoop.hbase.backup.impl.<a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupCommands.Command</a></h3>
203 <code><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html#finish--">finish</a>, <a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html#requiresConsistentState--">requiresConsistentState</a></code></li>
204 </ul>
205 <ul class="blockList">
206 <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.conf.Configured">
207 <!-- -->
208 </a>
209 <h3>Methods inherited from class&nbsp;org.apache.hadoop.conf.Configured</h3>
210 <code>getConf, setConf</code></li>
211 </ul>
212 <ul class="blockList">
213 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
214 <!-- -->
215 </a>
216 <h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
217 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
218 </ul>
219 </li>
220 </ul>
221 </li>
222 </ul>
223 </div>
224 <div class="details">
225 <ul class="blockList">
226 <li class="blockList">
227 <!-- ========= CONSTRUCTOR DETAIL ======== -->
228 <ul class="blockList">
229 <li class="blockList"><a name="constructor.detail">
230 <!-- -->
231 </a>
232 <h3>Constructor Detail</h3>
233 <a name="DeleteCommand-org.apache.hadoop.conf.Configuration-org.apache.commons.cli.CommandLine-">
234 <!-- -->
235 </a>
236 <ul class="blockListLast">
237 <li class="blockList">
238 <h4>DeleteCommand</h4>
239 <pre><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/BackupCommands.DeleteCommand.html#line.551">DeleteCommand</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
240 org.apache.commons.cli.CommandLine&nbsp;cmdline)</pre>
241 </li>
242 </ul>
243 </li>
244 </ul>
245 <!-- ============ METHOD DETAIL ========== -->
246 <ul class="blockList">
247 <li class="blockList"><a name="method.detail">
248 <!-- -->
249 </a>
250 <h3>Method Detail</h3>
251 <a name="requiresNoActiveSession--">
252 <!-- -->
253 </a>
254 <ul class="blockList">
255 <li class="blockList">
256 <h4>requiresNoActiveSession</h4>
257 <pre>protected&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/BackupCommands.DeleteCommand.html#line.557">requiresNoActiveSession</a>()</pre>
258 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html#requiresNoActiveSession--">BackupCommands.Command</a></code></span></div>
259 <div class="block">The command can't be run if active backup session is in progress</div>
260 <dl>
261 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
262 <dd><code><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html#requiresNoActiveSession--">requiresNoActiveSession</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupCommands.Command</a></code></dd>
263 <dt><span class="returnLabel">Returns:</span></dt>
264 <dd>true if no active sessions are in progress</dd>
265 </dl>
266 </li>
267 </ul>
268 <a name="execute--">
269 <!-- -->
270 </a>
271 <ul class="blockList">
272 <li class="blockList">
273 <h4>execute</h4>
274 <pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/BackupCommands.DeleteCommand.html#line.562">execute</a>()
275 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
276 <dl>
277 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
278 <dd><code><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html#execute--">execute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupCommands.Command</a></code></dd>
279 <dt><span class="throwsLabel">Throws:</span></dt>
280 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
281 </dl>
282 </li>
283 </ul>
284 <a name="printUsage--">
285 <!-- -->
286 </a>
287 <ul class="blockListLast">
288 <li class="blockList">
289 <h4>printUsage</h4>
290 <pre>protected&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/impl/BackupCommands.DeleteCommand.html#line.584">printUsage</a>()</pre>
291 <dl>
292 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
293 <dd><code><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html#printUsage--">printUsage</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.Command.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupCommands.Command</a></code></dd>
294 </dl>
295 </li>
296 </ul>
297 </li>
298 </ul>
299 </li>
300 </ul>
301 </div>
302 </div>
303 <!-- ========= END OF CLASS DATA ========= -->
304 <!-- ======= START OF BOTTOM NAVBAR ====== -->
305 <div class="bottomNav"><a name="navbar.bottom">
306 <!-- -->
307 </a>
308 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
309 <a name="navbar.bottom.firstrow">
310 <!-- -->
311 </a>
312 <ul class="navList" title="Navigation">
313 <li><a href="../../../../../../overview-summary.html">Overview</a></li>
314 <li><a href="package-summary.html">Package</a></li>
315 <li class="navBarCell1Rev">Class</li>
316 <li><a href="class-use/BackupCommands.DeleteCommand.html">Use</a></li>
317 <li><a href="package-tree.html">Tree</a></li>
318 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
319 <li><a href="../../../../../../index-all.html">Index</a></li>
320 <li><a href="../../../../../../help-doc.html">Help</a></li>
321 </ul>
322 </div>
323 <div class="subNav">
324 <ul class="navList">
325 <li><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.CreateCommand.html" title="class in org.apache.hadoop.hbase.backup.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
326 <li><a href="../../../../../../org/apache/hadoop/hbase/backup/impl/BackupCommands.DescribeCommand.html" title="class in org.apache.hadoop.hbase.backup.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
327 </ul>
328 <ul class="navList">
329 <li><a href="../../../../../../index.html?org/apache/hadoop/hbase/backup/impl/BackupCommands.DeleteCommand.html" target="_top">Frames</a></li>
330 <li><a href="BackupCommands.DeleteCommand.html" target="_top">No&nbsp;Frames</a></li>
331 </ul>
332 <ul class="navList" id="allclasses_navbar_bottom">
333 <li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
334 </ul>
335 <div>
336 <script type="text/javascript"><!--
337 allClassesLink = document.getElementById("allclasses_navbar_bottom");
338 if(window==top) {
339 allClassesLink.style.display = "block";
340 }
341 else {
342 allClassesLink.style.display = "none";
343 }
344 //-->
345 </script>
346 </div>
347 <div>
348 <ul class="subNavList">
349 <li>Summary:&nbsp;</li>
350 <li>Nested&nbsp;|&nbsp;</li>
351 <li><a href="#fields.inherited.from.class.org.apache.hadoop.hbase.backup.impl.BackupCommands.Command">Field</a>&nbsp;|&nbsp;</li>
352 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
353 <li><a href="#method.summary">Method</a></li>
354 </ul>
355 <ul class="subNavList">
356 <li>Detail:&nbsp;</li>
357 <li>Field&nbsp;|&nbsp;</li>
358 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
359 <li><a href="#method.detail">Method</a></li>
360 </ul>
361 </div>
362 <a name="skip.navbar.bottom">
363 <!-- -->
364 </a></div>
365 <!-- ======== END OF BOTTOM NAVBAR ======= -->
366 <p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
367 </body>
368 </html>