| <!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:39 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DiskBalancerVolume (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="DiskBalancerVolume (Apache Hadoop HDFS 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":9,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DiskBalancerVolume.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/datamodel/DiskBalancerDataNode.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.datamodel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolumeSet.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.datamodel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html" target="_top">Frames</a></li> |
| <li><a href="DiskBalancerVolume.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.hdfs.server.diskbalancer.datamodel</div> |
| <h2 title="Class DiskBalancerVolume" class="title">Class DiskBalancerVolume</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.hdfs.server.diskbalancer.datamodel.DiskBalancerVolume</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">DiskBalancerVolume</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">DiskBalancerVolume represents a volume in the DataNode.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#DiskBalancerVolume--">DiskBalancerVolume</a></span>()</code> |
| <div class="block">Constructs DiskBalancerVolume.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#computeEffectiveCapacity--">computeEffectiveCapacity</a></span>()</code> |
| <div class="block">Returns effective capacity of a volume.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#computeUsedPercentage--">computeUsedPercentage</a></span>()</code> |
| <div class="block">Returns the usedPercentage of a disk.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#equals-java.lang.Object-">equals</a></span>(<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> o)</code> |
| <div class="block">Compares two volumes and decides if it is the same volume.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#getCapacity--">getCapacity</a></span>()</code> |
| <div class="block">Capacity of this volume.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#getFreeRatio--">getFreeRatio</a></span>()</code> |
| <div class="block">Get ratio between free space and capacity.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#getFreeSpace--">getFreeSpace</a></span>()</code> |
| <div class="block">Get free space of the volume.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/datamodel/DiskBalancerVolume.html#getPath--">getPath</a></span>()</code> |
| <div class="block">Returns the path for this 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/datamodel/DiskBalancerVolume.html#getReserved--">getReserved</a></span>()</code> |
| <div class="block">Gets the reserved size for this volume.</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/datamodel/DiskBalancerVolume.html#getStorageType--">getStorageType</a></span>()</code> |
| <div class="block">Gets the StorageType.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#getUsed--">getUsed</a></span>()</code> |
| <div class="block">Gets the dfsUsed Size.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#getUsedRatio--">getUsedRatio</a></span>()</code> |
| <div class="block">Get ratio between used space and capacity.</div> |
| </td> |
| </tr> |
| <tr id="i11" 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/datamodel/DiskBalancerVolume.html#getUuid--">getUuid</a></span>()</code> |
| <div class="block">Gets the uuid for this volume.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#getVolumeDataDensity--">getVolumeDataDensity</a></span>()</code> |
| <div class="block">Get this volume Data Density |
| Please see DiskBalancerVolumeSet#computeVolumeDataDensity to see how |
| this is computed.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#hashCode--">hashCode</a></span>()</code> |
| <div class="block">Computes hash code for a diskBalancerVolume.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#isFailed--">isFailed</a></span>()</code> |
| <div class="block">Indicates if this is a failed volume.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#isReadOnly--">isReadOnly</a></span>()</code> |
| <div class="block">Tells us if this volume is read-only.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#isSkip--">isSkip</a></span>()</code> |
| <div class="block">returns if we should skip this volume.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#isTransient--">isTransient</a></span>()</code> |
| <div class="block">Indicates if the volume is Transient in nature.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static <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/datamodel/DiskBalancerVolume.html#parseJson-java.lang.String-">parseJson</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> json)</code> |
| <div class="block">Parses a Json string and converts to DiskBalancerVolume.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setCapacity-long-">setCapacity</a></span>(long totalCapacity)</code> |
| <div class="block">Sets the capacity of this volume.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setFailed-boolean-">setFailed</a></span>(boolean fail)</code> |
| <div class="block">Sets the failed flag for this volume.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setIsTransient-boolean-">setIsTransient</a></span>(boolean transientValue)</code> |
| <div class="block">Tells us if a volume is transient.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setPath-java.lang.String-">setPath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> volPath)</code> |
| <div class="block">Sets the path for this volume.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setReadOnly-boolean-">setReadOnly</a></span>(boolean readOnly)</code> |
| <div class="block">Sets this volume as read only.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setReserved-long-">setReserved</a></span>(long reservedSize)</code> |
| <div class="block">Sets the reserved size.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setSkip-boolean-">setSkip</a></span>(boolean skipValue)</code> |
| <div class="block">Sets the Skip value for this volume.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setStorageType-java.lang.String-">setStorageType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeOfStorage)</code> |
| <div class="block">Sets the StorageType.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setTransient-boolean-">setTransient</a></span>(boolean aTransient)</code> |
| <div class="block">Sets volumes transient nature.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setUsed-long-">setUsed</a></span>(long dfsUsedSpace)</code> |
| <div class="block">Sets the used Space for Long.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setUuid-java.lang.String-">setUuid</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</code> |
| <div class="block">Sets the uuid for this volume.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html#setVolumeDataDensity-double-">setVolumeDataDensity</a></span>(double volDataDensity)</code> |
| <div class="block">Sets this volume's data density.</div> |
| </td> |
| </tr> |
| <tr id="i31" 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/datamodel/DiskBalancerVolume.html#toJson--">toJson</a></span>()</code> |
| <div class="block">returns a Json String.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#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#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DiskBalancerVolume--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DiskBalancerVolume</h4> |
| <pre>public DiskBalancerVolume()</pre> |
| <div class="block">Constructs DiskBalancerVolume.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="parseJson-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseJson</h4> |
| <pre>public static <a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.datamodel">DiskBalancerVolume</a> parseJson(<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> json) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Parses a Json string and converts to DiskBalancerVolume.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>json</code> - - Json String</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>DiskBalancerCluster</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVolumeDataDensity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVolumeDataDensity</h4> |
| <pre>public double getVolumeDataDensity()</pre> |
| <div class="block">Get this volume Data Density |
| Please see DiskBalancerVolumeSet#computeVolumeDataDensity to see how |
| this is computed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>float.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVolumeDataDensity-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVolumeDataDensity</h4> |
| <pre>public void setVolumeDataDensity(double volDataDensity)</pre> |
| <div class="block">Sets this volume's data density.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>volDataDensity</code> - - density</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isTransient--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTransient</h4> |
| <pre>public boolean isTransient()</pre> |
| <div class="block">Indicates if the volume is Transient in nature.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true or false.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTransient-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTransient</h4> |
| <pre>public void setTransient(boolean aTransient)</pre> |
| <div class="block">Sets volumes transient nature.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aTransient</code> - - bool</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<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> o)</pre> |
| <div class="block">Compares two volumes and decides if it is the same volume.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - Volume Object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <div class="block">Computes hash code for a diskBalancerVolume.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>int</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCapacity</h4> |
| <pre>public long getCapacity()</pre> |
| <div class="block">Capacity of this volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>long</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFreeSpace--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFreeSpace</h4> |
| <pre>public long getFreeSpace()</pre> |
| <div class="block">Get free space of the volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>long</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUsedRatio--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUsedRatio</h4> |
| <pre>public double getUsedRatio()</pre> |
| <div class="block">Get ratio between used space and capacity.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>double</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFreeRatio--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFreeRatio</h4> |
| <pre>public double getFreeRatio()</pre> |
| <div class="block">Get ratio between free space and capacity.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>double</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCapacity-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCapacity</h4> |
| <pre>public void setCapacity(long totalCapacity)</pre> |
| <div class="block">Sets the capacity of this volume.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>totalCapacity</code> - long</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isFailed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFailed</h4> |
| <pre>public boolean isFailed()</pre> |
| <div class="block">Indicates if this is a failed volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFailed-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFailed</h4> |
| <pre>public void setFailed(boolean fail)</pre> |
| <div class="block">Sets the failed flag for this volume.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fail</code> - boolean</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPath</h4> |
| <pre>public <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> getPath()</pre> |
| <div class="block">Returns the path for this volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPath-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPath</h4> |
| <pre>public void setPath(<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> volPath)</pre> |
| <div class="block">Sets the path for this volume.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>volPath</code> - Path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReserved--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReserved</h4> |
| <pre>public long getReserved()</pre> |
| <div class="block">Gets the reserved size for this volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Long - Reserved size.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReserved-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReserved</h4> |
| <pre>public void setReserved(long reservedSize)</pre> |
| <div class="block">Sets the reserved size.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reservedSize</code> - -- Sets the reserved.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStorageType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStorageType</h4> |
| <pre>public <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> getStorageType()</pre> |
| <div class="block">Gets the StorageType.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String StorageType.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStorageType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStorageType</h4> |
| <pre>public void setStorageType(<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> typeOfStorage)</pre> |
| <div class="block">Sets the StorageType.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeOfStorage</code> - - Storage Type String.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUsed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUsed</h4> |
| <pre>public long getUsed()</pre> |
| <div class="block">Gets the dfsUsed Size.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- long - used space</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUsed-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsed</h4> |
| <pre>public void setUsed(long dfsUsedSpace)</pre> |
| <div class="block">Sets the used Space for Long.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dfsUsedSpace</code> - - dfsUsedSpace for this volume.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUuid--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUuid</h4> |
| <pre>public <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> getUuid()</pre> |
| <div class="block">Gets the uuid for this volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String - uuid of th volume</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUuid-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUuid</h4> |
| <pre>public void setUuid(<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> id)</pre> |
| <div class="block">Sets the uuid for this volume.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - - String</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="computeEffectiveCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>computeEffectiveCapacity</h4> |
| <pre>public long computeEffectiveCapacity()</pre> |
| <div class="block">Returns effective capacity of a volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>float - fraction that represents used capacity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toJson--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toJson</h4> |
| <pre>public <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> toJson() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">returns a Json String.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSkip--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSkip</h4> |
| <pre>public boolean isSkip()</pre> |
| <div class="block">returns if we should skip this volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true / false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSkip-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSkip</h4> |
| <pre>public void setSkip(boolean skipValue)</pre> |
| <div class="block">Sets the Skip value for this volume.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>skipValue</code> - bool</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="computeUsedPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>computeUsedPercentage</h4> |
| <pre>public float computeUsedPercentage()</pre> |
| <div class="block">Returns the usedPercentage of a disk. |
| This is useful in debugging disk usage</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>float</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIsTransient-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsTransient</h4> |
| <pre>public void setIsTransient(boolean transientValue)</pre> |
| <div class="block">Tells us if a volume is transient.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>transientValue</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isReadOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadOnly</h4> |
| <pre>public boolean isReadOnly()</pre> |
| <div class="block">Tells us if this volume is read-only.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true / false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReadOnly-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setReadOnly</h4> |
| <pre>public void setReadOnly(boolean readOnly)</pre> |
| <div class="block">Sets this volume as read only.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>readOnly</code> - - boolean</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/DiskBalancerVolume.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/datamodel/DiskBalancerDataNode.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.datamodel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolumeSet.html" title="class in org.apache.hadoop.hdfs.server.diskbalancer.datamodel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/hdfs/server/diskbalancer/datamodel/DiskBalancerVolume.html" target="_top">Frames</a></li> |
| <li><a href="DiskBalancerVolume.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |