| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:06:40 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Step (Apache Hadoop HDFS 3.3.1 API)</title> |
| <meta name="date" content="2021-06-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Step (Apache Hadoop HDFS 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Step.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/PlannerFactory.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.planner"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html" target="_top">Frames</a></li> |
| <li><a href="Step.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.hdfs.server.diskbalancer.planner</div> |
| <h2 title="Interface Step" class="title">Interface Step</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/MoveStep.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.planner">MoveStep</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Step</span></pre> |
| <div class="block">A step in the plan.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#getBandwidth--">getBandwidth</a></span>()</code> |
| <div class="block">Returns max disk bandwidth that disk balancer will use.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#getBytesToMove--">getBytesToMove</a></span>()</code> |
| <div class="block">Return the number of bytes to move.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.datamodel">DiskBalancerVolume</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#getDestinationVolume--">getDestinationVolume</a></span>()</code> |
| <div class="block">Gets the destination volume.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#getIdealStorage--">getIdealStorage</a></span>()</code> |
| <div class="block">Gets the IdealStorage.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#getMaxDiskErrors--">getMaxDiskErrors</a></span>()</code> |
| <div class="block">Returns maximum number of disk erros tolerated.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#getSizeString-long-">getSizeString</a></span>(long size)</code> |
| <div class="block">Returns a String representation of the Step Size.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.datamodel">DiskBalancerVolume</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#getSourceVolume--">getSourceVolume</a></span>()</code> |
| <div class="block">Gets Source Volume.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#getTolerancePercent--">getTolerancePercent</a></span>()</code> |
| <div class="block">Returns tolerance percentage, the good enough value |
| when we move data from one to disk to another.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#getVolumeSetID--">getVolumeSetID</a></span>()</code> |
| <div class="block">Gets a volume Set ID.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#setBandwidth-long-">setBandwidth</a></span>(long bandwidth)</code> |
| <div class="block">Set Bandwidth on a specific step.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#setMaxDiskErrors-long-">setMaxDiskErrors</a></span>(long maxDiskErrors)</code> |
| <div class="block">Set maximum errors to tolerate before disk balancer step fails.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html#setTolerancePercent-long-">setTolerancePercent</a></span>(long tolerancePercent)</code> |
| <div class="block">Sets Tolerance percent on a specific step.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getBytesToMove--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBytesToMove</h4> |
| <pre>long getBytesToMove()</pre> |
| <div class="block">Return the number of bytes to move.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDestinationVolume--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDestinationVolume</h4> |
| <pre><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.datamodel">DiskBalancerVolume</a> getDestinationVolume()</pre> |
| <div class="block">Gets the destination volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- volume</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIdealStorage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdealStorage</h4> |
| <pre>double getIdealStorage()</pre> |
| <div class="block">Gets the IdealStorage.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>idealStorage</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSourceVolume--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceVolume</h4> |
| <pre><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.datamodel">DiskBalancerVolume</a> getSourceVolume()</pre> |
| <div class="block">Gets Source Volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>-- Source Volume</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVolumeSetID--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVolumeSetID</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getVolumeSetID()</pre> |
| <div class="block">Gets a volume Set ID.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSizeString-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSizeString</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSizeString(long size)</pre> |
| <div class="block">Returns a String representation of the Step Size.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxDiskErrors--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxDiskErrors</h4> |
| <pre>long getMaxDiskErrors()</pre> |
| <div class="block">Returns maximum number of disk erros tolerated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>long.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTolerancePercent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTolerancePercent</h4> |
| <pre>long getTolerancePercent()</pre> |
| <div class="block">Returns tolerance percentage, the good enough value |
| when we move data from one to disk to another.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>long.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBandwidth--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBandwidth</h4> |
| <pre>long getBandwidth()</pre> |
| <div class="block">Returns max disk bandwidth that disk balancer will use. |
| Expressed in MB/sec. For example, a value like 10 |
| indicates that disk balancer will only move 10 MB / sec |
| while it is running.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>long.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTolerancePercent-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTolerancePercent</h4> |
| <pre>void setTolerancePercent(long tolerancePercent)</pre> |
| <div class="block">Sets Tolerance percent on a specific step.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tolerancePercent</code> - - tolerance in percentage.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setBandwidth-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBandwidth</h4> |
| <pre>void setBandwidth(long bandwidth)</pre> |
| <div class="block">Set Bandwidth on a specific step.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bandwidth</code> - - in MB/s</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxDiskErrors-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setMaxDiskErrors</h4> |
| <pre>void setMaxDiskErrors(long maxDiskErrors)</pre> |
| <div class="block">Set maximum errors to tolerate before disk balancer step fails.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxDiskErrors</code> - - error count.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Step.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/planner/PlannerFactory.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.planner"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/hdfs/server/diskbalancer/planner/Step.html" target="_top">Frames</a></li> |
| <li><a href="Step.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
