| <!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:01:44 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ContentSummary (Apache Hadoop Common 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="ContentSummary (Apache Hadoop Common 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":9,"i6":10,"i7":9,"i8":10,"i9":10,"i10":9,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":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/ContentSummary.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/fs/CommonPathCapabilities.html" title="class in org.apache.hadoop.fs"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/fs/ContentSummary.Builder.html" title="class in org.apache.hadoop.fs"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/fs/ContentSummary.html" target="_top">Frames</a></li> |
| <li><a href="ContentSummary.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.hadoop.fs.QuotaUsage">Field</a> | </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.fs</div> |
| <h2 title="Class ContentSummary" class="title">Class ContentSummary</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><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs">org.apache.hadoop.fs.QuotaUsage</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.fs.ContentSummary</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| public class <span class="typeNameLabel">ContentSummary</span> |
| extends <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs">QuotaUsage</a> |
| implements <a href="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</a></pre> |
| <div class="block">Store the summary of a content (a directory or a file).</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/ContentSummary.Builder.html" title="class in org.apache.hadoop.fs">ContentSummary.Builder</a></span></code> |
| <div class="block">We don't use generics.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.fs.QuotaUsage"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.hadoop.fs.<a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs">QuotaUsage</a></h3> |
| <code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#QUOTA_HEADER">QUOTA_HEADER</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#QUOTA_HEADER_FIELDS">QUOTA_HEADER_FIELDS</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#QUOTA_STRING_FORMAT">QUOTA_STRING_FORMAT</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#SPACE_QUOTA_STRING_FORMAT">SPACE_QUOTA_STRING_FORMAT</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== 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/fs/ContentSummary.html#ContentSummary--">ContentSummary</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/ContentSummary.html#ContentSummary-long-long-long-">ContentSummary</a></span>(long length, |
| long fileCount, |
| long directoryCount)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/ContentSummary.html#ContentSummary-long-long-long-long-long-long-">ContentSummary</a></span>(long length, |
| long fileCount, |
| long directoryCount, |
| long quota, |
| long spaceConsumed, |
| long spaceQuota)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/ContentSummary.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> to)</code> </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/fs/ContentSummary.html#getDirectoryCount--">getDirectoryCount</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" 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/fs/ContentSummary.html#getErasureCodingPolicy--">getErasureCodingPolicy</a></span>()</code> </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/fs/ContentSummary.html#getFileCount--">getFileCount</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <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/fs/ContentSummary.html#getHeader-boolean-">getHeader</a></span>(boolean qOption)</code> |
| <div class="block">Return the header of the output.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <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/fs/ContentSummary.html#getHeaderFields--">getHeaderFields</a></span>()</code> |
| <div class="block">Returns the names of the fields from the summary header.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/ContentSummary.html#getLength--">getLength</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <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/fs/ContentSummary.html#getQuotaHeaderFields--">getQuotaHeaderFields</a></span>()</code> |
| <div class="block">Returns the names of the fields used in the quota summary.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/ContentSummary.html#getSnapshotDirectoryCount--">getSnapshotDirectoryCount</a></span>()</code> </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/fs/ContentSummary.html#getSnapshotFileCount--">getSnapshotFileCount</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <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/fs/ContentSummary.html#getSnapshotHeader--">getSnapshotHeader</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/ContentSummary.html#getSnapshotLength--">getSnapshotLength</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/ContentSummary.html#getSnapshotSpaceConsumed--">getSnapshotSpaceConsumed</a></span>()</code> </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/fs/ContentSummary.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" 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/fs/ContentSummary.html#toSnapshot-boolean-">toSnapshot</a></span>(boolean hOption)</code> |
| <div class="block">Return the string representation of the snapshot counts in the output |
| format.</div> |
| </td> |
| </tr> |
| <tr id="i15" 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/fs/ContentSummary.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" 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/fs/ContentSummary.html#toString-boolean-">toString</a></span>(boolean qOption)</code> |
| <div class="block">Return the string representation of the object in the output format.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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/fs/ContentSummary.html#toString-boolean-boolean-">toString</a></span>(boolean qOption, |
| boolean hOption)</code> |
| <div class="block">Return the string representation of the object in the output format.</div> |
| </td> |
| </tr> |
| <tr id="i18" 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/fs/ContentSummary.html#toString-boolean-boolean-boolean-">toString</a></span>(boolean qOption, |
| boolean hOption, |
| boolean xOption)</code> |
| <div class="block">Return the string representation of the object in the output format.</div> |
| </td> |
| </tr> |
| <tr id="i19" 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/fs/ContentSummary.html#toString-boolean-boolean-boolean-boolean-java.util.List-">toString</a></span>(boolean qOption, |
| boolean hOption, |
| boolean tOption, |
| boolean xOption, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/fs/StorageType.html" title="enum in org.apache.hadoop.fs">StorageType</a>> types)</code> |
| <div class="block">Return the string representation of the object in the output format.</div> |
| </td> |
| </tr> |
| <tr id="i20" 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/fs/ContentSummary.html#toString-boolean-boolean-boolean-java.util.List-">toString</a></span>(boolean qOption, |
| boolean hOption, |
| boolean tOption, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/fs/StorageType.html" title="enum in org.apache.hadoop.fs">StorageType</a>> types)</code> |
| <div class="block">Return the string representation of the object in the output format.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.fs.QuotaUsage"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.fs.<a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs">QuotaUsage</a></h3> |
| <code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#getFileAndDirectoryCount--">getFileAndDirectoryCount</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#getHeader--">getHeader</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#getQuota--">getQuota</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#getQuotaUsage-boolean-">getQuotaUsage</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#getSpaceConsumed--">getSpaceConsumed</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#getSpaceQuota--">getSpaceQuota</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#getStorageTypeHeader-java.util.List-">getStorageTypeHeader</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#getTypeConsumed-org.apache.hadoop.fs.StorageType-">getTypeConsumed</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#getTypeQuota-org.apache.hadoop.fs.StorageType-">getTypeQuota</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#getTypesQuotaUsage-boolean-java.util.List-">getTypesQuotaUsage</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#isTypeConsumedAvailable--">isTypeConsumedAvailable</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#isTypeQuotaSet--">isTypeQuotaSet</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#setQuota-long-">setQuota</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#setSpaceConsumed-long-">setSpaceConsumed</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#setSpaceQuota-long-">setSpaceQuota</a>, <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#toString-boolean-boolean-java.util.List-">toString</a></code></li> |
| </ul> |
| <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#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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.io.Writable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.io.<a href="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</a></h3> |
| <code><a href="../../../../org/apache/hadoop/io/Writable.html#readFields-java.io.DataInput-">readFields</a>, <a href="../../../../org/apache/hadoop/io/Writable.html#write-java.io.DataOutput-">write</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="ContentSummary--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ContentSummary</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public ContentSummary()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Constructor deprecated by ContentSummary.Builder</div> |
| </li> |
| </ul> |
| <a name="ContentSummary-long-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ContentSummary</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public ContentSummary(long length, |
| long fileCount, |
| long directoryCount)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Constructor, deprecated by ContentSummary.Builder |
| This constructor implicitly set spaceConsumed the same as length. |
| spaceConsumed and length must be set explicitly with |
| ContentSummary.Builder</div> |
| </li> |
| </ul> |
| <a name="ContentSummary-long-long-long-long-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ContentSummary</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public ContentSummary(long length, |
| long fileCount, |
| long directoryCount, |
| long quota, |
| long spaceConsumed, |
| long spaceQuota)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Constructor, deprecated by ContentSummary.Builder</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLength</h4> |
| <pre>public long getLength()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the length</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSnapshotLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSnapshotLength</h4> |
| <pre>public long getSnapshotLength()</pre> |
| </li> |
| </ul> |
| <a name="getDirectoryCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDirectoryCount</h4> |
| <pre>public long getDirectoryCount()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the directory count</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSnapshotDirectoryCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSnapshotDirectoryCount</h4> |
| <pre>public long getSnapshotDirectoryCount()</pre> |
| </li> |
| </ul> |
| <a name="getFileCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileCount</h4> |
| <pre>public long getFileCount()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the file count</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSnapshotFileCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSnapshotFileCount</h4> |
| <pre>public long getSnapshotFileCount()</pre> |
| </li> |
| </ul> |
| <a name="getSnapshotSpaceConsumed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSnapshotSpaceConsumed</h4> |
| <pre>public long getSnapshotSpaceConsumed()</pre> |
| </li> |
| </ul> |
| <a name="getErasureCodingPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getErasureCodingPolicy</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> getErasureCodingPolicy()</pre> |
| </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> to)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#equals-java.lang.Object-">equals</a></code> in class <code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs">QuotaUsage</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#hashCode--">hashCode</a></code> in class <code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs">QuotaUsage</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHeader-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeader</h4> |
| <pre>public static <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> getHeader(boolean qOption)</pre> |
| <div class="block">Return the header of the output. |
| if qOption is false, output directory count, file count, and content size; |
| if qOption is true, output quota and remaining quota as well.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qOption</code> - a flag indicating if quota needs to be printed or not</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the header of the output</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSnapshotHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSnapshotHeader</h4> |
| <pre>public static <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> getSnapshotHeader()</pre> |
| </li> |
| </ul> |
| <a name="getHeaderFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaderFields</h4> |
| <pre>public static <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>[] getHeaderFields()</pre> |
| <div class="block">Returns the names of the fields from the summary header.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>names of fields as displayed in the header</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQuotaHeaderFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuotaHeaderFields</h4> |
| <pre>public static <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>[] getQuotaHeaderFields()</pre> |
| <div class="block">Returns the names of the fields used in the quota summary.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>names of quota fields as displayed in the header</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</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> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#toString--">toString</a></code> in class <code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs">QuotaUsage</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</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> toString(boolean qOption)</pre> |
| <div class="block">Return the string representation of the object in the output format. |
| if qOption is false, output directory count, file count, and content size; |
| if qOption is true, output quota and remaining quota as well.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html#toString-boolean-">toString</a></code> in class <code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs">QuotaUsage</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qOption</code> - a flag indicating if quota needs to be printed or not</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string representation of the object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</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> toString(boolean qOption, |
| boolean hOption)</pre> |
| <div class="block">Return the string representation of the object in the output format. |
| For description of the options,</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qOption</code> - a flag indicating if quota needs to be printed or not</dd> |
| <dd><code>hOption</code> - a flag indicating if human readable output if to be used</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string representation of the object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/ContentSummary.html#toString-boolean-boolean-boolean-boolean-java.util.List-"><code>toString(boolean, boolean, boolean, boolean, List)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString-boolean-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</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> toString(boolean qOption, |
| boolean hOption, |
| boolean xOption)</pre> |
| <div class="block">Return the string representation of the object in the output format. |
| For description of the options,</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qOption</code> - a flag indicating if quota needs to be printed or not</dd> |
| <dd><code>hOption</code> - a flag indicating if human readable output is to be used</dd> |
| <dd><code>xOption</code> - a flag indicating if calculation from snapshots is to be |
| included in the output</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string representation of the object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/ContentSummary.html#toString-boolean-boolean-boolean-boolean-java.util.List-"><code>toString(boolean, boolean, boolean, boolean, List)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString-boolean-boolean-boolean-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</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> toString(boolean qOption, |
| boolean hOption, |
| boolean tOption, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/fs/StorageType.html" title="enum in org.apache.hadoop.fs">StorageType</a>> types)</pre> |
| <div class="block">Return the string representation of the object in the output format. |
| For description of the options,</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qOption</code> - a flag indicating if quota needs to be printed or not</dd> |
| <dd><code>hOption</code> - a flag indicating if human readable output if to be used</dd> |
| <dd><code>tOption</code> - a flag indicating if display quota by storage types</dd> |
| <dd><code>types</code> - Storage types to display</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string representation of the object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/ContentSummary.html#toString-boolean-boolean-boolean-boolean-java.util.List-"><code>toString(boolean, boolean, boolean, boolean, List)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString-boolean-boolean-boolean-boolean-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</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> toString(boolean qOption, |
| boolean hOption, |
| boolean tOption, |
| boolean xOption, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/fs/StorageType.html" title="enum in org.apache.hadoop.fs">StorageType</a>> types)</pre> |
| <div class="block">Return the string representation of the object in the output format. |
| if qOption is false, output directory count, file count, and content size; |
| if qOption is true, output quota and remaining quota as well. |
| if hOption is false, file sizes are returned in bytes |
| if hOption is true, file sizes are returned in human readable |
| if tOption is true, display the quota by storage types |
| if tOption is false, same logic with #toString(boolean,boolean) |
| if xOption is false, output includes the calculation from snapshots |
| if xOption is true, output excludes the calculation from snapshots</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>qOption</code> - a flag indicating if quota needs to be printed or not</dd> |
| <dd><code>hOption</code> - a flag indicating if human readable output is to be used</dd> |
| <dd><code>tOption</code> - a flag indicating if display quota by storage types</dd> |
| <dd><code>xOption</code> - a flag indicating if calculation from snapshots is to be |
| included in the output</dd> |
| <dd><code>types</code> - Storage types to display</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string representation of the object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toSnapshot-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toSnapshot</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> toSnapshot(boolean hOption)</pre> |
| <div class="block">Return the string representation of the snapshot counts in the output |
| format.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hOption</code> - flag indicating human readable or not</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String representation of the snapshot counts</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/ContentSummary.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/fs/CommonPathCapabilities.html" title="class in org.apache.hadoop.fs"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/fs/ContentSummary.Builder.html" title="class in org.apache.hadoop.fs"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/fs/ContentSummary.html" target="_top">Frames</a></li> |
| <li><a href="ContentSummary.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.hadoop.fs.QuotaUsage">Field</a> | </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> |
