| <!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>FileSystem (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="FileSystem (Apache Hadoop Common 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":9,"i11":9,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":9,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":6,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":9,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":42,"i46":6,"i47":10,"i48":10,"i49":9,"i50":10,"i51":10,"i52":9,"i53":9,"i54":9,"i55":10,"i56":41,"i57":10,"i58":42,"i59":10,"i60":10,"i61":10,"i62":42,"i63":10,"i64":10,"i65":42,"i66":10,"i67":9,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":6,"i74":9,"i75":9,"i76":9,"i77":10,"i78":10,"i79":42,"i80":10,"i81":9,"i82":42,"i83":41,"i84":10,"i85":10,"i86":42,"i87":10,"i88":42,"i89":10,"i90":41,"i91":41,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10,"i98":6,"i99":10,"i100":10,"i101":6,"i102":10,"i103":10,"i104":10,"i105":10,"i106":10,"i107":10,"i108":10,"i109":42,"i110":42,"i111":10,"i112":10,"i113":10,"i114":10,"i115":6,"i116":10,"i117":10,"i118":10,"i119":10,"i120":10,"i121":10,"i122":9,"i123":10,"i124":6,"i125":10,"i126":10,"i127":10,"i128":10,"i129":10,"i130":9,"i131":9,"i132":9,"i133":9,"i134":10,"i135":10,"i136":10,"i137":6,"i138":10,"i139":10,"i140":10,"i141":10,"i142":42,"i143":42,"i144":42,"i145":9,"i146":10,"i147":10,"i148":10,"i149":10,"i150":10,"i151":6,"i152":42,"i153":10,"i154":10,"i155":10,"i156":10,"i157":10,"i158":9,"i159":9,"i160":10,"i161":10,"i162":10,"i163":10,"i164":10,"i165":10,"i166":10,"i167":10,"i168":6,"i169":10,"i170":10,"i171":10,"i172":10,"i173":10,"i174":10,"i175":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/FileSystem.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/FileStatus.AttrFlags.html" title="enum in org.apache.hadoop.fs"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/fs/FileSystem.DirListingIterator.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/FileSystem.html" target="_top">Frames</a></li> |
| <li><a href="FileSystem.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="#field.summary">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><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <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 FileSystem" class="title">Class FileSystem</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/conf/Configured.html" title="class in org.apache.hadoop.conf">org.apache.hadoop.conf.Configured</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.fs.FileSystem</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../org/apache/hadoop/conf/Configurable.html" title="interface in org.apache.hadoop.conf">Configurable</a>, <a href="../../../../org/apache/hadoop/fs/PathCapabilities.html" title="interface in org.apache.hadoop.fs">PathCapabilities</a>, org.apache.hadoop.security.token.DelegationTokenIssuer</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/FilterFileSystem.html" title="class in org.apache.hadoop.fs">FilterFileSystem</a>, <a href="../../../../org/apache/hadoop/fs/ftp/FTPFileSystem.html" title="class in org.apache.hadoop.fs.ftp">FTPFileSystem</a>, <a href="../../../../org/apache/hadoop/fs/HarFileSystem.html" title="class in org.apache.hadoop.fs">HarFileSystem</a>, <a href="../../../../org/apache/hadoop/fs/http/HttpFileSystem.html" title="class in org.apache.hadoop.fs.http">HttpFileSystem</a>, <a href="../../../../org/apache/hadoop/fs/http/HttpsFileSystem.html" title="class in org.apache.hadoop.fs.http">HttpsFileSystem</a>, <a href="../../../../org/apache/hadoop/fs/RawLocalFileSystem.html" title="class in org.apache.hadoop.fs">RawLocalFileSystem</a>, <a href="../../../../org/apache/hadoop/fs/sftp/SFTPFileSystem.html" title="class in org.apache.hadoop.fs.sftp">SFTPFileSystem</a>, <a href="../../../../org/apache/hadoop/fs/viewfs/ViewFileSystem.html" title="class in org.apache.hadoop.fs.viewfs">ViewFileSystem</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| public abstract class <span class="typeNameLabel">FileSystem</span> |
| extends <a href="../../../../org/apache/hadoop/conf/Configured.html" title="class in org.apache.hadoop.conf">Configured</a> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, org.apache.hadoop.security.token.DelegationTokenIssuer, <a href="../../../../org/apache/hadoop/fs/PathCapabilities.html" title="interface in org.apache.hadoop.fs">PathCapabilities</a></pre> |
| <div class="block">An abstract base class for a fairly generic filesystem. It |
| may be implemented as a distributed filesystem, or as a "local" |
| one that reflects the locally-connected disk. The local version |
| exists for small Hadoop instances and for testing. |
| |
| <p> |
| |
| All user code that may potentially use the Hadoop Distributed |
| File System should be written to use a FileSystem object or its |
| successor, <a href="../../../../org/apache/hadoop/fs/FileContext.html" title="class in org.apache.hadoop.fs"><code>FileContext</code></a>. |
| |
| <p> |
| The local implementation is <a href="../../../../org/apache/hadoop/fs/LocalFileSystem.html" title="class in org.apache.hadoop.fs"><code>LocalFileSystem</code></a> and distributed |
| implementation is DistributedFileSystem. There are other implementations |
| for object stores and (outside the Apache Hadoop codebase), |
| third party filesystems. |
| <p> |
| Notes |
| <ol> |
| <li>The behaviour of the filesystem is |
| <a href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/filesystem/filesystem.html"> |
| specified in the Hadoop documentation. </a> |
| However, the normative specification of the behavior of this class is |
| actually HDFS: if HDFS does not behave the way these Javadocs or |
| the specification in the Hadoop documentations define, assume that |
| the documentation is incorrect. |
| </li> |
| <li>The term <code>FileSystem</code> refers to an instance of this class.</li> |
| <li>The acronym "FS" is used as an abbreviation of FileSystem.</li> |
| <li>The term <code>filesystem</code> refers to the distributed/local filesystem |
| itself, rather than the class used to interact with it.</li> |
| <li>The term "file" refers to a file in the remote filesystem, |
| rather than instances of <code>java.io.File</code>.</li> |
| </ol> |
| |
| This is a carefully evolving class. |
| New methods may be marked as Unstable or Evolving for their initial release, |
| as a warning that they are new and may change based on the |
| experience of use in applications. |
| <p></p> |
| <b>Important note for developers</b> |
| <p></p> |
| If you are making changes here to the public API or protected methods, |
| you must review the following subclasses and make sure that |
| they are filtering/passing through new methods as appropriate. |
| <p></p> |
| |
| <a href="../../../../org/apache/hadoop/fs/FilterFileSystem.html" title="class in org.apache.hadoop.fs"><code>FilterFileSystem</code></a>: methods are passed through. If not, |
| then <code>TestFilterFileSystem.MustNotImplement</code> must be |
| updated with the unsupported interface. |
| Furthermore, if the new API's support is probed for via |
| <a href="../../../../org/apache/hadoop/fs/FileSystem.html#hasPathCapability-org.apache.hadoop.fs.Path-java.lang.String-"><code>hasPathCapability(Path, String)</code></a> then |
| <a href="../../../../org/apache/hadoop/fs/FilterFileSystem.html#hasPathCapability-org.apache.hadoop.fs.Path-java.lang.String-"><code>FilterFileSystem.hasPathCapability(Path, String)</code></a> |
| must return false, always. |
| <p></p> |
| <a href="../../../../org/apache/hadoop/fs/ChecksumFileSystem.html" title="class in org.apache.hadoop.fs"><code>ChecksumFileSystem</code></a>: checksums are created and |
| verified. |
| <p></p> |
| <code>TestHarFileSystem</code> will need its <code>MustNotImplement</code> |
| interface updated. |
| <p></p> |
| |
| There are some external places your changes will break things. |
| Do co-ordinate changes here. |
| <p></p> |
| |
| HBase: HBoss |
| <p></p> |
| Hive: HiveShim23 |
| <code>shims/0.23/src/main/java/org/apache/hadoop/hive/shims/Hadoop23Shims.java</code></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>protected class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.DirListingIterator.html" title="class in org.apache.hadoop.fs">FileSystem.DirListingIterator</a><<a href="../../../../org/apache/hadoop/fs/FileSystem.DirListingIterator.html" title="type parameter in FileSystem.DirListingIterator">T</a> extends <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>></span></code> |
| <div class="block">Generic iterator for implementing <a href="../../../../org/apache/hadoop/fs/FileSystem.html#listStatusIterator-org.apache.hadoop.fs.Path-"><code>listStatusIterator(Path)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.Statistics.html" title="class in org.apache.hadoop.fs">FileSystem.Statistics</a></span></code> |
| <div class="block">Tracks statistics about how many reads, writes, and so forth have been |
| done in a FileSystem.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr 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/FileSystem.html#DEFAULT_FS">DEFAULT_FS</a></span></code> </td> |
| </tr> |
| <tr 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/FileSystem.html#FS_DEFAULT_NAME_KEY">FS_DEFAULT_NAME_KEY</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#SHUTDOWN_HOOK_PRIORITY">SHUTDOWN_HOOK_PRIORITY</a></span></code> |
| <div class="block">Priority of the FileSystem shutdown hook: 10.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/hadoop/fs/FileSystem.Statistics.html" title="class in org.apache.hadoop.fs">FileSystem.Statistics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#statistics">statistics</a></span></code> |
| <div class="block">The statistics for this file system.</div> |
| </td> |
| </tr> |
| <tr 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/FileSystem.html#TRASH_PREFIX">TRASH_PREFIX</a></span></code> |
| <div class="block">Prefix for trash directory: ".Trash".</div> |
| </td> |
| </tr> |
| <tr 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/FileSystem.html#USER_HOME_PREFIX">USER_HOME_PREFIX</a></span></code> </td> |
| </tr> |
| </table> |
| </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="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#FileSystem--">FileSystem</a></span>()</code> </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#append-org.apache.hadoop.fs.Path-">append</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Append to an existing file (optional operation).</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#append-org.apache.hadoop.fs.Path-int-">append</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| int bufferSize)</code> |
| <div class="block">Append to an existing file (optional operation).</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#append-org.apache.hadoop.fs.Path-int-org.apache.hadoop.util.Progressable-">append</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| int bufferSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress)</code> |
| <div class="block">Append to an existing file (optional operation).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="class in org.apache.hadoop.fs">FSDataOutputStreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#appendFile-org.apache.hadoop.fs.Path-">appendFile</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Create a Builder to append a file.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#areSymlinksEnabled--">areSymlinksEnabled</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#cancelDeleteOnExit-org.apache.hadoop.fs.Path-">cancelDeleteOnExit</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Cancel the scheduled deletion of the path when the FileSystem is closed.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#canonicalizeUri-java.net.URI-">canonicalizeUri</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri)</code> |
| <div class="block">Canonicalize the given URI.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#checkPath-org.apache.hadoop.fs.Path-">checkPath</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Check that a Path belongs to this FileSystem.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#clearStatistics--">clearStatistics</a></span>()</code> |
| <div class="block">Reset all statistics for all file systems.</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/fs/FileSystem.html#close--">close</a></span>()</code> |
| <div class="block">Close this FileSystem instance.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#closeAll--">closeAll</a></span>()</code> |
| <div class="block">Close all cached FileSystem instances.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#closeAllForUGI-org.apache.hadoop.security.UserGroupInformation-">closeAllForUGI</a></span>(<a href="../../../../org/apache/hadoop/security/UserGroupInformation.html" title="class in org.apache.hadoop.security">UserGroupInformation</a> ugi)</code> |
| <div class="block">Close all cached FileSystem instances for a given UGI.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#completeLocalOutput-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">completeLocalOutput</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> fsOutputFile, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> tmpLocalFile)</code> |
| <div class="block">Called when we're all done writing to the target.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#concat-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path:A-">concat</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> trg, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>[] psrcs)</code> |
| <div class="block">Concat existing files together.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#copyFromLocalFile-boolean-boolean-org.apache.hadoop.fs.Path:A-org.apache.hadoop.fs.Path-">copyFromLocalFile</a></span>(boolean delSrc, |
| boolean overwrite, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>[] srcs, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst)</code> |
| <div class="block">The src files are on the local disk.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#copyFromLocalFile-boolean-boolean-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">copyFromLocalFile</a></span>(boolean delSrc, |
| boolean overwrite, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst)</code> |
| <div class="block">The src file is on the local disk.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#copyFromLocalFile-boolean-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">copyFromLocalFile</a></span>(boolean delSrc, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst)</code> |
| <div class="block">The src file is on the local disk.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#copyFromLocalFile-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">copyFromLocalFile</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst)</code> |
| <div class="block">The src file is on the local disk.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#copyToLocalFile-boolean-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">copyToLocalFile</a></span>(boolean delSrc, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst)</code> |
| <div class="block">Copy it a file from a remote filesystem to the local one.</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/fs/FileSystem.html#copyToLocalFile-boolean-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-boolean-">copyToLocalFile</a></span>(boolean delSrc, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst, |
| boolean useRawLocalFileSystem)</code> |
| <div class="block">The src file is under this filesystem, and the dst is on the local disk.</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/fs/FileSystem.html#copyToLocalFile-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">copyToLocalFile</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst)</code> |
| <div class="block">Copy it a file from the remote filesystem to the local one.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> fs, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> file, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission)</code> |
| <div class="block">Create a file with the provided permission.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-boolean-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-boolean-int-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite, |
| int bufferSize)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-boolean-int-org.apache.hadoop.util.Progressable-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite, |
| int bufferSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress)</code> |
| <div class="block">Create an <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs"><code>FSDataOutputStream</code></a> at the indicated Path |
| with write-progress reporting.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-boolean-int-short-long-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite, |
| int bufferSize, |
| short replication, |
| long blockSize)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-boolean-int-short-long-org.apache.hadoop.util.Progressable-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-boolean-int-short-long-org.apache.hadoop.util.Progressable-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission, |
| boolean overwrite, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-java.util.EnumSet-int-short-long-org.apache.hadoop.util.Progressable-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs">CreateFlag</a>> flags, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-java.util.EnumSet-int-short-long-org.apache.hadoop.util.Progressable-org.apache.hadoop.fs.Options.ChecksumOpt-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs">CreateFlag</a>> flags, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress, |
| <a href="../../../../org/apache/hadoop/fs/Options.ChecksumOpt.html" title="class in org.apache.hadoop.fs">Options.ChecksumOpt</a> checksumOpt)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path with a custom |
| checksum option.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-org.apache.hadoop.util.Progressable-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-short-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| short replication)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.Path-short-org.apache.hadoop.util.Progressable-">create</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| short replication, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress)</code> |
| <div class="block">Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="class in org.apache.hadoop.fs">FSDataOutputStreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createDataOutputStreamBuilder-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-">createDataOutputStreamBuilder</a></span>(<a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> fileSystem, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Create instance of the standard FSDataOutputStreamBuilder for the |
| given filesystem and path.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="class in org.apache.hadoop.fs">FSDataOutputStreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createFile-org.apache.hadoop.fs.Path-">createFile</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Create a new FSDataOutputStreamBuilder for the file with path.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/MultipartUploaderBuilder.html" title="interface in org.apache.hadoop.fs">MultipartUploaderBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createMultipartUploader-org.apache.hadoop.fs.Path-">createMultipartUploader</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> basePath)</code> |
| <div class="block">Create a multipart uploader.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createNewFile-org.apache.hadoop.fs.Path-">createNewFile</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Creates the given Path as a brand-new zero-length file.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createNonRecursive-org.apache.hadoop.fs.Path-boolean-int-short-long-org.apache.hadoop.util.Progressable-">createNonRecursive</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress)</code> |
| <div class="block">Opens an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createNonRecursive-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-boolean-int-short-long-org.apache.hadoop.util.Progressable-">createNonRecursive</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission, |
| boolean overwrite, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress)</code> |
| <div class="block">Opens an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createNonRecursive-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-java.util.EnumSet-int-short-long-org.apache.hadoop.util.Progressable-">createNonRecursive</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs">CreateFlag</a>> flags, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress)</code> |
| <div class="block">Opens an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createPathHandle-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Options.HandleOpt...-">createPathHandle</a></span>(<a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a> stat, |
| <a href="../../../../org/apache/hadoop/fs/Options.HandleOpt.html" title="class in org.apache.hadoop.fs">Options.HandleOpt</a>... opt)</code> |
| <div class="block">Hook to implement support for <a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs"><code>PathHandle</code></a> operations.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createSnapshot-org.apache.hadoop.fs.Path-">createSnapshot</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Create a snapshot with a default name.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createSnapshot-org.apache.hadoop.fs.Path-java.lang.String-">createSnapshot</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> snapshotName)</code> |
| <div class="block">Create a snapshot.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#createSymlink-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-boolean-">createSymlink</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> target, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> link, |
| boolean createParent)</code> |
| <div class="block">See <a href="../../../../org/apache/hadoop/fs/FileContext.html#createSymlink-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-boolean-"><code>FileContext.createSymlink(Path, Path, boolean)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#delete-org.apache.hadoop.fs.Path-">delete</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#delete-org.apache.hadoop.fs.Path-boolean-"><code>delete(Path, boolean)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#delete-org.apache.hadoop.fs.Path-boolean-">delete</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean recursive)</code> |
| <div class="block">Delete a file.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#deleteOnExit-org.apache.hadoop.fs.Path-">deleteOnExit</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Mark a path to be deleted when its FileSystem is closed.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#deleteSnapshot-org.apache.hadoop.fs.Path-java.lang.String-">deleteSnapshot</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> snapshotName)</code> |
| <div class="block">Delete a snapshot of a directory.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#enableSymlinks--">enableSymlinks</a></span>()</code> </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#exists-org.apache.hadoop.fs.Path-">exists</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Check if a path exists.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#fixRelativePart-org.apache.hadoop.fs.Path-">fixRelativePart</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p)</code> |
| <div class="block">See <a href="../../../../org/apache/hadoop/fs/FileContext.html#fixRelativePart-org.apache.hadoop.fs.Path-"><code>FileContext.fixRelativePart(org.apache.hadoop.fs.Path)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#get-org.apache.hadoop.conf.Configuration-">get</a></span>(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Returns the configured FileSystem implementation.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#get-java.net.URI-org.apache.hadoop.conf.Configuration-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Get a FileSystem for this URI's scheme and authority.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#get-java.net.URI-org.apache.hadoop.conf.Configuration-java.lang.String-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf, |
| <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> user)</code> |
| <div class="block">Get a FileSystem instance based on the uri, the passed in |
| configuration and the user.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/permission/AclStatus.html" title="class in org.apache.hadoop.fs.permission">AclStatus</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getAclStatus-org.apache.hadoop.fs.Path-">getAclStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Gets the ACL of a file or directory.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>static <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/FileSystem.Statistics.html" title="class in org.apache.hadoop.fs">FileSystem.Statistics</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getAllStatistics--">getAllStatistics</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getGlobalStorageStatistics--"><code>getGlobalStorageStatistics()</code></a></span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../../org/apache/hadoop/fs/BlockStoragePolicySpi.html" title="interface in org.apache.hadoop.fs">BlockStoragePolicySpi</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getAllStoragePolicies--">getAllStoragePolicies</a></span>()</code> |
| <div class="block">Retrieve all the storage policies supported by this file system.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getBlockSize-org.apache.hadoop.fs.Path-">getBlockSize</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i59" 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/FileSystem.html#getCanonicalServiceName--">getCanonicalServiceName</a></span>()</code> |
| <div class="block">Get a canonical service name for this FileSystem.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getCanonicalUri--">getCanonicalUri</a></span>()</code> |
| <div class="block">Return a canonicalized form of this FileSystem's URI.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/ContentSummary.html" title="class in org.apache.hadoop.fs">ContentSummary</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getContentSummary-org.apache.hadoop.fs.Path-">getContentSummary</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Return the <a href="../../../../org/apache/hadoop/fs/ContentSummary.html" title="class in org.apache.hadoop.fs"><code>ContentSummary</code></a> of a given <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs"><code>Path</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultBlockSize--">getDefaultBlockSize</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultBlockSize-org.apache.hadoop.fs.Path-"><code>getDefaultBlockSize(Path)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultBlockSize-org.apache.hadoop.fs.Path-">getDefaultBlockSize</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Return the number of bytes that large input files should be optimally |
| be split into to minimize I/O time.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultPort--">getDefaultPort</a></span>()</code> |
| <div class="block">Get the default port for this FileSystem.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultReplication--">getDefaultReplication</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultReplication-org.apache.hadoop.fs.Path-"><code>getDefaultReplication(Path)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultReplication-org.apache.hadoop.fs.Path-">getDefaultReplication</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Get the default replication for a path.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultUri-org.apache.hadoop.conf.Configuration-">getDefaultUri</a></span>(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Get the default FileSystem URI from a configuration.</div> |
| </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/BlockLocation.html" title="class in org.apache.hadoop.fs">BlockLocation</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileBlockLocations-org.apache.hadoop.fs.FileStatus-long-long-">getFileBlockLocations</a></span>(<a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a> file, |
| long start, |
| long len)</code> |
| <div class="block">Return an array containing hostnames, offset and size of |
| portions of the given file.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/BlockLocation.html" title="class in org.apache.hadoop.fs">BlockLocation</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileBlockLocations-org.apache.hadoop.fs.Path-long-long-">getFileBlockLocations</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p, |
| long start, |
| long len)</code> |
| <div class="block">Return an array containing hostnames, offset and size of |
| portions of the given file.</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FileChecksum.html" title="class in org.apache.hadoop.fs">FileChecksum</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileChecksum-org.apache.hadoop.fs.Path-">getFileChecksum</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Get the checksum of a file, if the FS supports checksums.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FileChecksum.html" title="class in org.apache.hadoop.fs">FileChecksum</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileChecksum-org.apache.hadoop.fs.Path-long-">getFileChecksum</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| long length)</code> |
| <div class="block">Get the checksum of a file, from the beginning of the file till the |
| specific length.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileLinkStatus-org.apache.hadoop.fs.Path-">getFileLinkStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">See <a href="../../../../org/apache/hadoop/fs/FileContext.html#getFileLinkStatus-org.apache.hadoop.fs.Path-"><code>FileContext.getFileLinkStatus(Path)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-">getFileStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Return a file status object that represents the path.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileSystemClass-java.lang.String-org.apache.hadoop.conf.Configuration-">getFileSystemClass</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> scheme, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Get the FileSystem implementation class of a filesystem.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFSofPath-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-">getFSofPath</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> absOrFqPath, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</code> </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/GlobalStorageStatistics.html" title="enum in org.apache.hadoop.fs">GlobalStorageStatistics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getGlobalStorageStatistics--">getGlobalStorageStatistics</a></span>()</code> |
| <div class="block">Get the global storage statistics.</div> |
| </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getHomeDirectory--">getHomeDirectory</a></span>()</code> |
| <div class="block">Return the current user's home directory in this FileSystem.</div> |
| </td> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getInitialWorkingDirectory--">getInitialWorkingDirectory</a></span>()</code> |
| <div class="block">Note: with the new FileContext class, getWorkingDirectory() |
| will be removed.</div> |
| </td> |
| </tr> |
| <tr id="i79" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getLength-org.apache.hadoop.fs.Path-">getLength</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i80" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getLinkTarget-org.apache.hadoop.fs.Path-">getLinkTarget</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">See <a href="../../../../org/apache/hadoop/fs/FileContext.html#getLinkTarget-org.apache.hadoop.fs.Path-"><code>FileContext.getLinkTarget(Path)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i81" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/LocalFileSystem.html" title="class in org.apache.hadoop.fs">LocalFileSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getLocal-org.apache.hadoop.conf.Configuration-">getLocal</a></span>(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Get the local FileSystem.</div> |
| </td> |
| </tr> |
| <tr id="i82" 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/FileSystem.html#getName--">getName</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">call <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getUri--"><code>getUri()</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i83" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getNamed-java.lang.String-org.apache.hadoop.conf.Configuration-">getNamed</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> name, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">call <a href="../../../../org/apache/hadoop/fs/FileSystem.html#get-java.net.URI-org.apache.hadoop.conf.Configuration-"><code>get(URI, Configuration)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i84" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getPathHandle-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Options.HandleOpt...-">getPathHandle</a></span>(<a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a> stat, |
| <a href="../../../../org/apache/hadoop/fs/Options.HandleOpt.html" title="class in org.apache.hadoop.fs">Options.HandleOpt</a>... opt)</code> |
| <div class="block">Create a durable, serializable handle to the referent of the given |
| entity.</div> |
| </td> |
| </tr> |
| <tr id="i85" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs">QuotaUsage</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getQuotaUsage-org.apache.hadoop.fs.Path-">getQuotaUsage</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Return the <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs"><code>QuotaUsage</code></a> of a given <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs"><code>Path</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i86" class="altColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getReplication-org.apache.hadoop.fs.Path-">getReplication</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i87" 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/FileSystem.html#getScheme--">getScheme</a></span>()</code> |
| <div class="block">Return the protocol scheme for this FileSystem.</div> |
| </td> |
| </tr> |
| <tr id="i88" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FsServerDefaults.html" title="class in org.apache.hadoop.fs">FsServerDefaults</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getServerDefaults--">getServerDefaults</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getServerDefaults-org.apache.hadoop.fs.Path-"><code>getServerDefaults(Path)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i89" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FsServerDefaults.html" title="class in org.apache.hadoop.fs">FsServerDefaults</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getServerDefaults-org.apache.hadoop.fs.Path-">getServerDefaults</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p)</code> |
| <div class="block">Return a set of server default configuration values.</div> |
| </td> |
| </tr> |
| <tr id="i90" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<a href="../../../../org/apache/hadoop/fs/FileSystem.Statistics.html" title="class in org.apache.hadoop.fs">FileSystem.Statistics</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getStatistics--">getStatistics</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getGlobalStorageStatistics--"><code>getGlobalStorageStatistics()</code></a></span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i91" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/FileSystem.Statistics.html" title="class in org.apache.hadoop.fs">FileSystem.Statistics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getStatistics-java.lang.String-java.lang.Class-">getStatistics</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> scheme, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a>> cls)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getGlobalStorageStatistics--"><code>getGlobalStorageStatistics()</code></a></span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i92" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FsStatus.html" title="class in org.apache.hadoop.fs">FsStatus</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getStatus--">getStatus</a></span>()</code> |
| <div class="block">Returns a status object describing the use and capacity of the |
| filesystem.</div> |
| </td> |
| </tr> |
| <tr id="i93" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FsStatus.html" title="class in org.apache.hadoop.fs">FsStatus</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getStatus-org.apache.hadoop.fs.Path-">getStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p)</code> |
| <div class="block">Returns a status object describing the use and capacity of the |
| filesystem.</div> |
| </td> |
| </tr> |
| <tr id="i94" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/BlockStoragePolicySpi.html" title="interface in org.apache.hadoop.fs">BlockStoragePolicySpi</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getStoragePolicy-org.apache.hadoop.fs.Path-">getStoragePolicy</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src)</code> |
| <div class="block">Query the effective storage policy ID for the given file or directory.</div> |
| </td> |
| </tr> |
| <tr id="i95" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/StorageStatistics.html" title="class in org.apache.hadoop.fs">StorageStatistics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getStorageStatistics--">getStorageStatistics</a></span>()</code> |
| <div class="block">Get the StorageStatistics for this FileSystem object.</div> |
| </td> |
| </tr> |
| <tr id="i96" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getTrashRoot-org.apache.hadoop.fs.Path-">getTrashRoot</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Get the root directory of Trash for current user when the path specified |
| is deleted.</div> |
| </td> |
| </tr> |
| <tr id="i97" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getTrashRoots-boolean-">getTrashRoots</a></span>(boolean allUsers)</code> |
| <div class="block">Get all the trash roots for current user or all users.</div> |
| </td> |
| </tr> |
| <tr id="i98" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getUri--">getUri</a></span>()</code> |
| <div class="block">Returns a URI which identifies this FileSystem.</div> |
| </td> |
| </tr> |
| <tr id="i99" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getUsed--">getUsed</a></span>()</code> |
| <div class="block">Return the total size of all files in the filesystem.</div> |
| </td> |
| </tr> |
| <tr id="i100" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getUsed-org.apache.hadoop.fs.Path-">getUsed</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Return the total size of all files from a specified path.</div> |
| </td> |
| </tr> |
| <tr id="i101" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getWorkingDirectory--">getWorkingDirectory</a></span>()</code> |
| <div class="block">Get the current working directory for the given FileSystem</div> |
| </td> |
| </tr> |
| <tr id="i102" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getXAttr-org.apache.hadoop.fs.Path-java.lang.String-">getXAttr</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> name)</code> |
| <div class="block">Get an xattr name and value for a file or directory.</div> |
| </td> |
| </tr> |
| <tr id="i103" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,byte[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getXAttrs-org.apache.hadoop.fs.Path-">getXAttrs</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Get all of the xattr name/value pairs for a file or directory.</div> |
| </td> |
| </tr> |
| <tr id="i104" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,byte[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#getXAttrs-org.apache.hadoop.fs.Path-java.util.List-">getXAttrs</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> names)</code> |
| <div class="block">Get all of the xattrs name/value pairs for a file or directory.</div> |
| </td> |
| </tr> |
| <tr id="i105" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#globStatus-org.apache.hadoop.fs.Path-">globStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> pathPattern)</code> |
| <div class="block">Return all the files that match filePattern and are not checksum |
| files.</div> |
| </td> |
| </tr> |
| <tr id="i106" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#globStatus-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.PathFilter-">globStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> pathPattern, |
| <a href="../../../../org/apache/hadoop/fs/PathFilter.html" title="interface in org.apache.hadoop.fs">PathFilter</a> filter)</code> |
| <div class="block">Return an array of <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs"><code>FileStatus</code></a> objects whose path names match |
| <code>pathPattern</code> and is accepted by the user-supplied path filter.</div> |
| </td> |
| </tr> |
| <tr id="i107" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#hasPathCapability-org.apache.hadoop.fs.Path-java.lang.String-">hasPathCapability</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> capability)</code> |
| <div class="block">The base FileSystem implementation generally has no knowledge |
| of the capabilities of actual implementations.</div> |
| </td> |
| </tr> |
| <tr id="i108" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#initialize-java.net.URI-org.apache.hadoop.conf.Configuration-">initialize</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> name, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Initialize a FileSystem.</div> |
| </td> |
| </tr> |
| <tr id="i109" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#isDirectory-org.apache.hadoop.fs.Path-">isDirectory</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i110" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#isFile-org.apache.hadoop.fs.Path-">isFile</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i111" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/RemoteIterator.html" title="interface in org.apache.hadoop.fs">RemoteIterator</a><<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#listCorruptFileBlocks-org.apache.hadoop.fs.Path-">listCorruptFileBlocks</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">List corrupted file blocks.</div> |
| </td> |
| </tr> |
| <tr id="i112" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/RemoteIterator.html" title="interface in org.apache.hadoop.fs">RemoteIterator</a><<a href="../../../../org/apache/hadoop/fs/LocatedFileStatus.html" title="class in org.apache.hadoop.fs">LocatedFileStatus</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#listFiles-org.apache.hadoop.fs.Path-boolean-">listFiles</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean recursive)</code> |
| <div class="block">List the statuses and block locations of the files in the given path.</div> |
| </td> |
| </tr> |
| <tr id="i113" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/RemoteIterator.html" title="interface in org.apache.hadoop.fs">RemoteIterator</a><<a href="../../../../org/apache/hadoop/fs/LocatedFileStatus.html" title="class in org.apache.hadoop.fs">LocatedFileStatus</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#listLocatedStatus-org.apache.hadoop.fs.Path-">listLocatedStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">List the statuses of the files/directories in the given path if the path is |
| a directory.</div> |
| </td> |
| </tr> |
| <tr id="i114" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/hadoop/fs/RemoteIterator.html" title="interface in org.apache.hadoop.fs">RemoteIterator</a><<a href="../../../../org/apache/hadoop/fs/LocatedFileStatus.html" title="class in org.apache.hadoop.fs">LocatedFileStatus</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#listLocatedStatus-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.PathFilter-">listLocatedStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/PathFilter.html" title="interface in org.apache.hadoop.fs">PathFilter</a> filter)</code> |
| <div class="block">List a directory.</div> |
| </td> |
| </tr> |
| <tr id="i115" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#listStatus-org.apache.hadoop.fs.Path-">listStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">List the statuses of the files/directories in the given path if the path is |
| a directory.</div> |
| </td> |
| </tr> |
| <tr id="i116" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#listStatus-org.apache.hadoop.fs.Path:A-">listStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>[] files)</code> |
| <div class="block">Filter files/directories in the given list of paths using default |
| path filter.</div> |
| </td> |
| </tr> |
| <tr id="i117" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#listStatus-org.apache.hadoop.fs.Path:A-org.apache.hadoop.fs.PathFilter-">listStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>[] files, |
| <a href="../../../../org/apache/hadoop/fs/PathFilter.html" title="interface in org.apache.hadoop.fs">PathFilter</a> filter)</code> |
| <div class="block">Filter files/directories in the given list of paths using user-supplied |
| path filter.</div> |
| </td> |
| </tr> |
| <tr id="i118" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#listStatus-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.PathFilter-">listStatus</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/PathFilter.html" title="interface in org.apache.hadoop.fs">PathFilter</a> filter)</code> |
| <div class="block">Filter files/directories in the given path using the user-supplied path |
| filter.</div> |
| </td> |
| </tr> |
| <tr id="i119" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/RemoteIterator.html" title="interface in org.apache.hadoop.fs">RemoteIterator</a><<a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#listStatusIterator-org.apache.hadoop.fs.Path-">listStatusIterator</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p)</code> |
| <div class="block">Returns a remote iterator so that followup calls are made on demand |
| while consuming the entries.</div> |
| </td> |
| </tr> |
| <tr id="i120" class="altColor"> |
| <td class="colFirst"><code><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="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/FileSystem.html#listXAttrs-org.apache.hadoop.fs.Path-">listXAttrs</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Get all of the xattr names for a file or directory.</div> |
| </td> |
| </tr> |
| <tr id="i121" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#makeQualified-org.apache.hadoop.fs.Path-">makeQualified</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Qualify a path to one which uses this FileSystem and, if relative, |
| made absolute.</div> |
| </td> |
| </tr> |
| <tr id="i122" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#mkdirs-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-">mkdirs</a></span>(<a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> fs, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dir, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission)</code> |
| <div class="block">Create a directory with the provided permission.</div> |
| </td> |
| </tr> |
| <tr id="i123" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#mkdirs-org.apache.hadoop.fs.Path-">mkdirs</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Call <a href="../../../../org/apache/hadoop/fs/FileSystem.html#mkdirs-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"><code>mkdirs(Path, FsPermission)</code></a> with default permission.</div> |
| </td> |
| </tr> |
| <tr id="i124" class="altColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#mkdirs-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-">mkdirs</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission)</code> |
| <div class="block">Make the given file and all non-existent parents into |
| directories.</div> |
| </td> |
| </tr> |
| <tr id="i125" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#modifyAclEntries-org.apache.hadoop.fs.Path-java.util.List-">modifyAclEntries</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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/permission/AclEntry.html" title="class in org.apache.hadoop.fs.permission">AclEntry</a>> aclSpec)</code> |
| <div class="block">Modifies ACL entries of files and directories.</div> |
| </td> |
| </tr> |
| <tr id="i126" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#moveFromLocalFile-org.apache.hadoop.fs.Path:A-org.apache.hadoop.fs.Path-">moveFromLocalFile</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>[] srcs, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst)</code> |
| <div class="block">The src files is on the local disk.</div> |
| </td> |
| </tr> |
| <tr id="i127" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#moveFromLocalFile-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">moveFromLocalFile</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst)</code> |
| <div class="block">The src file is on the local disk.</div> |
| </td> |
| </tr> |
| <tr id="i128" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#moveToLocalFile-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">moveToLocalFile</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst)</code> |
| <div class="block">Copy a file to the local filesystem, then delete it from the |
| remote filesystem (if successfully copied).</div> |
| </td> |
| </tr> |
| <tr id="i129" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#msync--">msync</a></span>()</code> |
| <div class="block">Synchronize client metadata state.</div> |
| </td> |
| </tr> |
| <tr id="i130" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#newInstance-org.apache.hadoop.conf.Configuration-">newInstance</a></span>(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Returns a unique configured FileSystem implementation for the default |
| filesystem of the supplied configuration.</div> |
| </td> |
| </tr> |
| <tr id="i131" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#newInstance-java.net.URI-org.apache.hadoop.conf.Configuration-">newInstance</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> config)</code> |
| <div class="block">Returns the FileSystem for this URI's scheme and authority.</div> |
| </td> |
| </tr> |
| <tr id="i132" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#newInstance-java.net.URI-org.apache.hadoop.conf.Configuration-java.lang.String-">newInstance</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf, |
| <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> user)</code> |
| <div class="block">Returns the FileSystem for this URI's scheme and authority and the |
| given user.</div> |
| </td> |
| </tr> |
| <tr id="i133" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/fs/LocalFileSystem.html" title="class in org.apache.hadoop.fs">LocalFileSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#newInstanceLocal-org.apache.hadoop.conf.Configuration-">newInstanceLocal</a></span>(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Get a unique local FileSystem object.</div> |
| </td> |
| </tr> |
| <tr id="i134" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#open-org.apache.hadoop.fs.Path-">open</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">Opens an FSDataInputStream at the indicated Path.</div> |
| </td> |
| </tr> |
| <tr id="i135" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#open-org.apache.hadoop.fs.PathHandle-">open</a></span>(<a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a> fd)</code> |
| <div class="block">Open an FSDataInputStream matching the PathHandle instance.</div> |
| </td> |
| </tr> |
| <tr id="i136" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#open-org.apache.hadoop.fs.PathHandle-int-">open</a></span>(<a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a> fd, |
| int bufferSize)</code> |
| <div class="block">Open an FSDataInputStream matching the PathHandle instance.</div> |
| </td> |
| </tr> |
| <tr id="i137" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#open-org.apache.hadoop.fs.Path-int-">open</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| int bufferSize)</code> |
| <div class="block">Opens an FSDataInputStream at the indicated Path.</div> |
| </td> |
| </tr> |
| <tr id="i138" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FutureDataInputStreamBuilder.html" title="interface in org.apache.hadoop.fs">FutureDataInputStreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#openFile-org.apache.hadoop.fs.Path-">openFile</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Open a file for reading through a builder API.</div> |
| </td> |
| </tr> |
| <tr id="i139" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/FutureDataInputStreamBuilder.html" title="interface in org.apache.hadoop.fs">FutureDataInputStreamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#openFile-org.apache.hadoop.fs.PathHandle-">openFile</a></span>(<a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a> pathHandle)</code> |
| <div class="block">Open a file for reading through a builder API.</div> |
| </td> |
| </tr> |
| <tr id="i140" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#openFileWithOptions-org.apache.hadoop.fs.PathHandle-org.apache.hadoop.fs.impl.OpenFileParameters-">openFileWithOptions</a></span>(<a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a> pathHandle, |
| <a href="../../../../org/apache/hadoop/fs/impl/OpenFileParameters.html" title="class in org.apache.hadoop.fs.impl">OpenFileParameters</a> parameters)</code> |
| <div class="block">Execute the actual open file operation.</div> |
| </td> |
| </tr> |
| <tr id="i141" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#openFileWithOptions-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.impl.OpenFileParameters-">openFileWithOptions</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <a href="../../../../org/apache/hadoop/fs/impl/OpenFileParameters.html" title="class in org.apache.hadoop.fs.impl">OpenFileParameters</a> parameters)</code> |
| <div class="block">Execute the actual open file operation.</div> |
| </td> |
| </tr> |
| <tr id="i142" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#primitiveCreate-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-java.util.EnumSet-int-short-long-org.apache.hadoop.util.Progressable-org.apache.hadoop.fs.Options.ChecksumOpt-">primitiveCreate</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> absolutePermission, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs">CreateFlag</a>> flag, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress, |
| <a href="../../../../org/apache/hadoop/fs/Options.ChecksumOpt.html" title="class in org.apache.hadoop.fs">Options.ChecksumOpt</a> checksumOpt)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i143" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#primitiveMkdir-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-">primitiveMkdir</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> absolutePermission)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i144" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#primitiveMkdir-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-boolean-">primitiveMkdir</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> absolutePermission, |
| boolean createParent)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i145" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#printStatistics--">printStatistics</a></span>()</code> |
| <div class="block">Print all statistics for all file systems to <code>System.out</code></div> |
| </td> |
| </tr> |
| <tr id="i146" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#processDeleteOnExit--">processDeleteOnExit</a></span>()</code> |
| <div class="block">Delete all paths that were marked as delete-on-exit.</div> |
| </td> |
| </tr> |
| <tr id="i147" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#removeAcl-org.apache.hadoop.fs.Path-">removeAcl</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Removes all but the base ACL entries of files and directories.</div> |
| </td> |
| </tr> |
| <tr id="i148" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#removeAclEntries-org.apache.hadoop.fs.Path-java.util.List-">removeAclEntries</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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/permission/AclEntry.html" title="class in org.apache.hadoop.fs.permission">AclEntry</a>> aclSpec)</code> |
| <div class="block">Removes ACL entries from files and directories.</div> |
| </td> |
| </tr> |
| <tr id="i149" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#removeDefaultAcl-org.apache.hadoop.fs.Path-">removeDefaultAcl</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Removes all default ACL entries from files and directories.</div> |
| </td> |
| </tr> |
| <tr id="i150" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#removeXAttr-org.apache.hadoop.fs.Path-java.lang.String-">removeXAttr</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> name)</code> |
| <div class="block">Remove an xattr of a file or directory.</div> |
| </td> |
| </tr> |
| <tr id="i151" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#rename-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">rename</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst)</code> |
| <div class="block">Renames Path src to Path dst.</div> |
| </td> |
| </tr> |
| <tr id="i152" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#rename-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Options.Rename...-">rename</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst, |
| <a href="../../../../org/apache/hadoop/fs/Options.Rename.html" title="enum in org.apache.hadoop.fs">Options.Rename</a>... options)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i153" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#renameSnapshot-org.apache.hadoop.fs.Path-java.lang.String-java.lang.String-">renameSnapshot</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> snapshotOldName, |
| <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> snapshotNewName)</code> |
| <div class="block">Rename a snapshot.</div> |
| </td> |
| </tr> |
| <tr id="i154" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#resolveLink-org.apache.hadoop.fs.Path-">resolveLink</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</code> |
| <div class="block">See <a href="../../../../org/apache/hadoop/fs/AbstractFileSystem.html#getLinkTarget-org.apache.hadoop.fs.Path-"><code>AbstractFileSystem.getLinkTarget(Path)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i155" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#resolvePath-org.apache.hadoop.fs.Path-">resolvePath</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p)</code> |
| <div class="block">Return the fully-qualified path of path, resolving the path |
| through any symlinks or mount point.</div> |
| </td> |
| </tr> |
| <tr id="i156" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#satisfyStoragePolicy-org.apache.hadoop.fs.Path-">satisfyStoragePolicy</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</code> |
| <div class="block">Set the source path to satisfy storage policy.</div> |
| </td> |
| </tr> |
| <tr id="i157" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setAcl-org.apache.hadoop.fs.Path-java.util.List-">setAcl</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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/permission/AclEntry.html" title="class in org.apache.hadoop.fs.permission">AclEntry</a>> aclSpec)</code> |
| <div class="block">Fully replaces ACL of files and directories, discarding all existing |
| entries.</div> |
| </td> |
| </tr> |
| <tr id="i158" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setDefaultUri-org.apache.hadoop.conf.Configuration-java.lang.String-">setDefaultUri</a></span>(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf, |
| <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> uri)</code> |
| <div class="block">Set the default FileSystem URI in a configuration.</div> |
| </td> |
| </tr> |
| <tr id="i159" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setDefaultUri-org.apache.hadoop.conf.Configuration-java.net.URI-">setDefaultUri</a></span>(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri)</code> |
| <div class="block">Set the default FileSystem URI in a configuration.</div> |
| </td> |
| </tr> |
| <tr id="i160" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setOwner-org.apache.hadoop.fs.Path-java.lang.String-java.lang.String-">setOwner</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p, |
| <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> username, |
| <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> groupname)</code> |
| <div class="block">Set owner of a path (i.e.</div> |
| </td> |
| </tr> |
| <tr id="i161" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setPermission-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-">setPermission</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission)</code> |
| <div class="block">Set permission of a path.</div> |
| </td> |
| </tr> |
| <tr id="i162" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setQuota-org.apache.hadoop.fs.Path-long-long-">setQuota</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| long namespaceQuota, |
| long storagespaceQuota)</code> |
| <div class="block">Set quota for the given <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs"><code>Path</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i163" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setQuotaByStorageType-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.StorageType-long-">setQuotaByStorageType</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/StorageType.html" title="enum in org.apache.hadoop.fs">StorageType</a> type, |
| long quota)</code> |
| <div class="block">Set per storage type quota for the given <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs"><code>Path</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i164" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setReplication-org.apache.hadoop.fs.Path-short-">setReplication</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| short replication)</code> |
| <div class="block">Set the replication for an existing file.</div> |
| </td> |
| </tr> |
| <tr id="i165" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setStoragePolicy-org.apache.hadoop.fs.Path-java.lang.String-">setStoragePolicy</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <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> policyName)</code> |
| <div class="block">Set the storage policy for a given file or directory.</div> |
| </td> |
| </tr> |
| <tr id="i166" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setTimes-org.apache.hadoop.fs.Path-long-long-">setTimes</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p, |
| long mtime, |
| long atime)</code> |
| <div class="block">Set access time of a file.</div> |
| </td> |
| </tr> |
| <tr id="i167" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setVerifyChecksum-boolean-">setVerifyChecksum</a></span>(boolean verifyChecksum)</code> |
| <div class="block">Set the verify checksum flag.</div> |
| </td> |
| </tr> |
| <tr id="i168" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setWorkingDirectory-org.apache.hadoop.fs.Path-">setWorkingDirectory</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> new_dir)</code> |
| <div class="block">Set the current working directory for the given FileSystem.</div> |
| </td> |
| </tr> |
| <tr id="i169" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setWriteChecksum-boolean-">setWriteChecksum</a></span>(boolean writeChecksum)</code> |
| <div class="block">Set the write checksum flag.</div> |
| </td> |
| </tr> |
| <tr id="i170" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setXAttr-org.apache.hadoop.fs.Path-java.lang.String-byte:A-">setXAttr</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> name, |
| byte[] value)</code> |
| <div class="block">Set an xattr of a file or directory.</div> |
| </td> |
| </tr> |
| <tr id="i171" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setXAttr-org.apache.hadoop.fs.Path-java.lang.String-byte:A-java.util.EnumSet-">setXAttr</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> name, |
| byte[] value, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../org/apache/hadoop/fs/XAttrSetFlag.html" title="enum in org.apache.hadoop.fs">XAttrSetFlag</a>> flag)</code> |
| <div class="block">Set an xattr of a file or directory.</div> |
| </td> |
| </tr> |
| <tr id="i172" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#startLocalOutput-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">startLocalOutput</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> fsOutputFile, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> tmpLocalFile)</code> |
| <div class="block">Returns a local file that the user can write output to.</div> |
| </td> |
| </tr> |
| <tr id="i173" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#supportsSymlinks--">supportsSymlinks</a></span>()</code> |
| <div class="block">See <a href="../../../../org/apache/hadoop/fs/AbstractFileSystem.html#supportsSymlinks--"><code>AbstractFileSystem.supportsSymlinks()</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i174" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#truncate-org.apache.hadoop.fs.Path-long-">truncate</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| long newLength)</code> |
| <div class="block">Truncate the file in the indicated path to the indicated size.</div> |
| </td> |
| </tr> |
| <tr id="i175" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/fs/FileSystem.html#unsetStoragePolicy-org.apache.hadoop.fs.Path-">unsetStoragePolicy</a></span>(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src)</code> |
| <div class="block">Unset the storage policy set for a given file or directory.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.conf.Configured"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.conf.<a href="../../../../org/apache/hadoop/conf/Configured.html" title="class in org.apache.hadoop.conf">Configured</a></h3> |
| <code><a href="../../../../org/apache/hadoop/conf/Configured.html#getConf--">getConf</a>, <a href="../../../../org/apache/hadoop/conf/Configured.html#setConf-org.apache.hadoop.conf.Configuration-">setConf</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#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.security.token.DelegationTokenIssuer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.security.token.DelegationTokenIssuer</h3> |
| <code>addDelegationTokens, getAdditionalTokenIssuers, getDelegationToken</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="FS_DEFAULT_NAME_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FS_DEFAULT_NAME_KEY</h4> |
| <pre>public static final <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> FS_DEFAULT_NAME_KEY</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.hadoop.fs.FileSystem.FS_DEFAULT_NAME_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_FS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_FS</h4> |
| <pre>public static final <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> DEFAULT_FS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.hadoop.fs.FileSystem.DEFAULT_FS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SHUTDOWN_HOOK_PRIORITY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SHUTDOWN_HOOK_PRIORITY</h4> |
| <pre>public static final int SHUTDOWN_HOOK_PRIORITY</pre> |
| <div class="block">Priority of the FileSystem shutdown hook: 10.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.hadoop.fs.FileSystem.SHUTDOWN_HOOK_PRIORITY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TRASH_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TRASH_PREFIX</h4> |
| <pre>public static final <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> TRASH_PREFIX</pre> |
| <div class="block">Prefix for trash directory: ".Trash".</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.hadoop.fs.FileSystem.TRASH_PREFIX">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="USER_HOME_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>USER_HOME_PREFIX</h4> |
| <pre>public static final <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> USER_HOME_PREFIX</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.hadoop.fs.FileSystem.USER_HOME_PREFIX">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="statistics"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>statistics</h4> |
| <pre>protected <a href="../../../../org/apache/hadoop/fs/FileSystem.Statistics.html" title="class in org.apache.hadoop.fs">FileSystem.Statistics</a> statistics</pre> |
| <div class="block">The statistics for this file system.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FileSystem--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FileSystem</h4> |
| <pre>protected FileSystem()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="get-java.net.URI-org.apache.hadoop.conf.Configuration-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> get(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf, |
| <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> user) |
| 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>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
| <div class="block">Get a FileSystem instance based on the uri, the passed in |
| configuration and the user.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - of the filesystem</dd> |
| <dd><code>conf</code> - the configuration to use</dd> |
| <dd><code>user</code> - to perform the get as</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filesystem instance</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> - failure to load</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - If the <code>UGI.doAs()</code> call was |
| somehow interrupted.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> get(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf) |
| 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 the configured FileSystem implementation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration to use</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="getDefaultUri-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultUri</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> getDefaultUri(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf)</pre> |
| <div class="block">Get the default FileSystem URI from a configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the uri of the default filesystem</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDefaultUri-org.apache.hadoop.conf.Configuration-java.net.URI-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultUri</h4> |
| <pre>public static void setDefaultUri(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri)</pre> |
| <div class="block">Set the default FileSystem URI in a configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration to alter</dd> |
| <dd><code>uri</code> - the new default filesystem uri</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDefaultUri-org.apache.hadoop.conf.Configuration-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultUri</h4> |
| <pre>public static void setDefaultUri(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf, |
| <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> uri)</pre> |
| <div class="block">Set the default FileSystem URI in a configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration to alter</dd> |
| <dd><code>uri</code> - the new default filesystem uri</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initialize-java.net.URI-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> name, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf) |
| 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">Initialize a FileSystem. |
| |
| Called after the new FileSystem instance is constructed, and before it |
| is ready for use. |
| |
| FileSystem implementations overriding this method MUST forward it to |
| their superclass, though the order in which it is done, and whether |
| to alter the configuration before the invocation are options of the |
| subclass.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a URI whose authority section names the host, port, etc. |
| for this FileSystem</dd> |
| <dd><code>conf</code> - the configuration</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> - on any failure to initialize this instance.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the URI is considered invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getScheme--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheme</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> getScheme()</pre> |
| <div class="block">Return the protocol scheme for this FileSystem. |
| <p> |
| This implementation throws an <code>UnsupportedOperationException</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the protocol scheme for this FileSystem.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUri--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUri</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> getUri()</pre> |
| <div class="block">Returns a URI which identifies this FileSystem.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the URI of this filesystem.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCanonicalUri--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCanonicalUri</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> getCanonicalUri()</pre> |
| <div class="block">Return a canonicalized form of this FileSystem's URI. |
| |
| The default implementation simply calls <a href="../../../../org/apache/hadoop/fs/FileSystem.html#canonicalizeUri-java.net.URI-"><code>canonicalizeUri(URI)</code></a> |
| on the filesystem's own URI, so subclasses typically only need to |
| implement that method.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/FileSystem.html#canonicalizeUri-java.net.URI-"><code>canonicalizeUri(URI)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canonicalizeUri-java.net.URI-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canonicalizeUri</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> canonicalizeUri(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri)</pre> |
| <div class="block">Canonicalize the given URI. |
| |
| This is implementation-dependent, and may for example consist of |
| canonicalizing the hostname using DNS and adding the default |
| port if not specified. |
| |
| The default implementation simply fills in the default port if |
| not specified and if <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultPort--"><code>getDefaultPort()</code></a> returns a |
| default port.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>URI</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>NetUtils.getCanonicalUri(URI, int)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultPort</h4> |
| <pre>protected int getDefaultPort()</pre> |
| <div class="block">Get the default port for this FileSystem.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default port or 0 if there isn't one</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFSofPath-org.apache.hadoop.fs.Path-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFSofPath</h4> |
| <pre>protected static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> getFSofPath(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> absOrFqPath, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf) |
| throws <a href="../../../../org/apache/hadoop/fs/UnsupportedFileSystemException.html" title="class in org.apache.hadoop.fs">UnsupportedFileSystemException</a>, |
| <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> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/UnsupportedFileSystemException.html" title="class in org.apache.hadoop.fs">UnsupportedFileSystemException</a></code></dd> |
| <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="getCanonicalServiceName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCanonicalServiceName</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| 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> getCanonicalServiceName()</pre> |
| <div class="block">Get a canonical service name for this FileSystem. |
| The token cache is the only user of the canonical service name, |
| and uses it to lookup this FileSystem's service tokens. |
| If the file system provides a token of its own then it must have a |
| canonical name, otherwise the canonical name can be null. |
| |
| Default implementation: If the FileSystem has child file systems |
| (such as an embedded file system) then it is assumed that the FS has no |
| tokens of its own and hence returns a null name; otherwise a service |
| name is built using Uri and port.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getCanonicalServiceName</code> in interface <code>org.apache.hadoop.security.token.DelegationTokenIssuer</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a service string that uniquely identifies this file system, null |
| if the filesystem does not implement tokens</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/security/SecurityUtil.html#buildDTServiceName-java.net.URI-int-"><code>SecurityUtil.buildDTServiceName(URI, int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</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 <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> getName()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">call <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getUri--"><code>getUri()</code></a> instead.</span></div> |
| </li> |
| </ul> |
| <a name="getNamed-java.lang.String-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNamed</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 static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> getNamed(<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> name, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf) |
| 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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">call <a href="../../../../org/apache/hadoop/fs/FileSystem.html#get-java.net.URI-org.apache.hadoop.conf.Configuration-"><code>get(URI, Configuration)</code></a> instead.</span></div> |
| <dl> |
| <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="getLocal-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocal</h4> |
| <pre>public static <a href="../../../../org/apache/hadoop/fs/LocalFileSystem.html" title="class in org.apache.hadoop.fs">LocalFileSystem</a> getLocal(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf) |
| 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">Get the local FileSystem.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration to configure the FileSystem with |
| if it is newly instantiated.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a LocalFileSystem</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> - if somehow the local FS cannot be instantiated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-java.net.URI-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> get(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf) |
| 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">Get a FileSystem for this URI's scheme and authority. |
| <ol> |
| <li> |
| If the configuration has the property |
| <code>"fs.$SCHEME.impl.disable.cache"</code> set to true, |
| a new instance will be created, initialized with the supplied URI and |
| configuration, then returned without being cached. |
| </li> |
| <li> |
| If the there is a cached FS instance matching the same URI, it will |
| be returned. |
| </li> |
| <li> |
| Otherwise: a new FS instance will be created, initialized with the |
| configuration and URI, cached and returned to the caller. |
| </li> |
| </ol></div> |
| <dl> |
| <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> - if the FileSystem cannot be instantiated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newInstance-java.net.URI-org.apache.hadoop.conf.Configuration-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre>public static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> newInstance(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf, |
| <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> user) |
| 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>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
| <div class="block">Returns the FileSystem for this URI's scheme and authority and the |
| given user. Internally invokes <a href="../../../../org/apache/hadoop/fs/FileSystem.html#newInstance-java.net.URI-org.apache.hadoop.conf.Configuration-"><code>newInstance(URI, Configuration)</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - of the filesystem</dd> |
| <dd><code>conf</code> - the configuration to use</dd> |
| <dd><code>user</code> - to perform the get as</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>filesystem instance</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> - if the FileSystem cannot be instantiated.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - If the <code>UGI.doAs()</code> call was |
| somehow interrupted.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newInstance-java.net.URI-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre>public static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> newInstance(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> config) |
| 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 the FileSystem for this URI's scheme and authority. |
| The entire URI is passed to the FileSystem instance's initialize method. |
| This always returns a new FileSystem object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - FS URI</dd> |
| <dd><code>config</code> - configuration to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new FS instance</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> - FS creation or initialization failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newInstance-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre>public static <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> newInstance(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf) |
| 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 unique configured FileSystem implementation for the default |
| filesystem of the supplied configuration. |
| This always returns a new FileSystem object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new FS instance</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> - FS creation or initialization failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newInstanceLocal-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstanceLocal</h4> |
| <pre>public static <a href="../../../../org/apache/hadoop/fs/LocalFileSystem.html" title="class in org.apache.hadoop.fs">LocalFileSystem</a> newInstanceLocal(<a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf) |
| 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">Get a unique local FileSystem object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration to configure the FileSystem with</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new LocalFileSystem object.</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> - FS creation or initialization failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="closeAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeAll</h4> |
| <pre>public static void closeAll() |
| 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">Close all cached FileSystem instances. After this operation, they |
| may not be used in any operations.</div> |
| <dl> |
| <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> - a problem arose closing one or more filesystem.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="closeAllForUGI-org.apache.hadoop.security.UserGroupInformation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeAllForUGI</h4> |
| <pre>public static void closeAllForUGI(<a href="../../../../org/apache/hadoop/security/UserGroupInformation.html" title="class in org.apache.hadoop.security">UserGroupInformation</a> ugi) |
| 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">Close all cached FileSystem instances for a given UGI. |
| Be sure those filesystems are not used anymore.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ugi</code> - user group info to close</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> - a problem arose closing one or more filesystem.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeQualified-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeQualified</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> makeQualified(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</pre> |
| <div class="block">Qualify a path to one which uses this FileSystem and, if relative, |
| made absolute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - to qualify.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this path if it contains a scheme and authority and is absolute, or |
| a new path that includes a path and authority and is fully qualified</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the path has a schema/URI different |
| from this FileSystem.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/Path.html#makeQualified-java.net.URI-org.apache.hadoop.fs.Path-"><code>Path.makeQualified(URI, Path)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> fs, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> file, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission) |
| 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">Create a file with the provided permission. |
| |
| The permission of the file is set to be the provided permission as in |
| setPermission, not permission&~umask |
| |
| The HDFS implementation is implemented using two RPCs. |
| It is understood that it is inefficient, |
| but the implementation is thread-safe. The other option is to change the |
| value of umask in configuration to be 0, but it is not thread-safe.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fs</code> - FileSystem</dd> |
| <dd><code>file</code> - the name of the file to be created</dd> |
| <dd><code>permission</code> - the permission of the file</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an output stream</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="mkdirs-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mkdirs</h4> |
| <pre>public static boolean mkdirs(<a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> fs, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dir, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission) |
| 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">Create a directory with the provided permission. |
| The permission of the directory is set to be the provided permission as in |
| setPermission, not permission&~umask</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fs</code> - FileSystem handle</dd> |
| <dd><code>dir</code> - the name of the directory to be created</dd> |
| <dd><code>permission</code> - the permission of the directory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the directory creation succeeds; false otherwise</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> - A problem creating the directories.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/FileSystem.html#create-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"><code>create(FileSystem, Path, FsPermission)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkPath-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPath</h4> |
| <pre>protected void checkPath(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</pre> |
| <div class="block">Check that a Path belongs to this FileSystem. |
| |
| The base implementation performs case insensitive equality checks |
| of the URIs' schemes and authorities. Subclasses may implement slightly |
| different checks.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - to check</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the path is not considered to be |
| part of this FileSystem.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFileBlockLocations-org.apache.hadoop.fs.FileStatus-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileBlockLocations</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/BlockLocation.html" title="class in org.apache.hadoop.fs">BlockLocation</a>[] getFileBlockLocations(<a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a> file, |
| long start, |
| long len) |
| 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">Return an array containing hostnames, offset and size of |
| portions of the given file. For nonexistent |
| file or regions, <code>null</code> is returned. |
| |
| <pre> |
| if f == null : |
| result = null |
| elif f.getLen() <= start: |
| result = [] |
| else result = [ locations(FS, b) for b in blocks(FS, p, s, s+l)] |
| </pre> |
| This call is most helpful with and distributed filesystem |
| where the hostnames of machines that contain blocks of the given file |
| can be determined. |
| |
| The default implementation returns an array containing one element: |
| <pre> |
| BlockLocation( { "localhost:9866" }, { "localhost" }, 0, file.getLen()) |
| </pre> |
| |
| In HDFS, if file is three-replicated, the returned array contains |
| elements like: |
| <pre> |
| BlockLocation(offset: 0, length: BLOCK_SIZE, |
| hosts: {"host1:9866", "host2:9866, host3:9866"}) |
| BlockLocation(offset: BLOCK_SIZE, length: BLOCK_SIZE, |
| hosts: {"host2:9866", "host3:9866, host4:9866"}) |
| </pre> |
| |
| And if a file is erasure-coded, the returned BlockLocation are logical |
| block groups. |
| |
| Suppose we have a RS_3_2 coded file (3 data units and 2 parity units). |
| 1. If the file size is less than one stripe size, say 2 * CELL_SIZE, then |
| there will be one BlockLocation returned, with 0 offset, actual file size |
| and 4 hosts (2 data blocks and 2 parity blocks) hosting the actual blocks. |
| 3. If the file size is less than one group size but greater than one |
| stripe size, then there will be one BlockLocation returned, with 0 offset, |
| actual file size with 5 hosts (3 data blocks and 2 parity blocks) hosting |
| the actual blocks. |
| 4. If the file size is greater than one group size, 3 * BLOCK_SIZE + 123 |
| for example, then the result will be like: |
| <pre> |
| BlockLocation(offset: 0, length: 3 * BLOCK_SIZE, hosts: {"host1:9866", |
| "host2:9866","host3:9866","host4:9866","host5:9866"}) |
| BlockLocation(offset: 3 * BLOCK_SIZE, length: 123, hosts: {"host1:9866", |
| "host4:9866", "host5:9866"}) |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>file</code> - FilesStatus to get data from</dd> |
| <dd><code>start</code> - offset into the given file</dd> |
| <dd><code>len</code> - length for which to get locations for</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFileBlockLocations-org.apache.hadoop.fs.Path-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileBlockLocations</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/BlockLocation.html" title="class in org.apache.hadoop.fs">BlockLocation</a>[] getFileBlockLocations(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p, |
| long start, |
| long len) |
| 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">Return an array containing hostnames, offset and size of |
| portions of the given file. For a nonexistent |
| file or regions, <code>null</code> is returned. |
| |
| This call is most helpful with location-aware distributed |
| filesystems, where it returns hostnames of machines that |
| contain the given file. |
| |
| A FileSystem will normally return the equivalent result |
| of passing the <code>FileStatus</code> of the path to |
| <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileBlockLocations-org.apache.hadoop.fs.FileStatus-long-long-"><code>getFileBlockLocations(FileStatus, long, long)</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - path is used to identify an FS since an FS could have |
| another FS that it could be delegating the call to</dd> |
| <dd><code>start</code> - offset into the given file</dd> |
| <dd><code>len</code> - length for which to get locations for</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - when the path does not exist</dd> |
| <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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerDefaults--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerDefaults</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 <a href="../../../../org/apache/hadoop/fs/FsServerDefaults.html" title="class in org.apache.hadoop.fs">FsServerDefaults</a> getServerDefaults() |
| 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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getServerDefaults-org.apache.hadoop.fs.Path-"><code>getServerDefaults(Path)</code></a> instead</span></div> |
| <div class="block">Return a set of server default configuration values.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>server default configuration values</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerDefaults-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerDefaults</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FsServerDefaults.html" title="class in org.apache.hadoop.fs">FsServerDefaults</a> getServerDefaults(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p) |
| 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">Return a set of server default configuration values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - path is used to identify an FS since an FS could have |
| another FS that it could be delegating the call to</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>server default configuration values</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolvePath-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolvePath</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> resolvePath(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p) |
| 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">Return the fully-qualified path of path, resolving the path |
| through any symlinks or mount point.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - path to be resolved</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>fully qualified path</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if the path is not present</dd> |
| <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> - for any other error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="open-org.apache.hadoop.fs.Path-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>public abstract <a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a> open(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| int bufferSize) |
| 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">Opens an FSDataInputStream at the indicated Path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file name to open</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="open-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a> open(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Opens an FSDataInputStream at the indicated Path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file to open</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="open-org.apache.hadoop.fs.PathHandle-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a> open(<a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a> fd) |
| 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">Open an FSDataInputStream matching the PathHandle instance. The |
| implementation may encode metadata in PathHandle to address the |
| resource directly and verify that the resource referenced |
| satisfies constraints specified at its construciton.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fd</code> - PathHandle object returned by the FS authority.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/InvalidPathHandleException.html" title="class in org.apache.hadoop.fs">InvalidPathHandleException</a></code> - If <a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs"><code>PathHandle</code></a> constraints are |
| not satisfied</dd> |
| <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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - If <a href="../../../../org/apache/hadoop/fs/FileSystem.html#open-org.apache.hadoop.fs.PathHandle-int-"><code>open(PathHandle, int)</code></a> |
| not overridden by subclass</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="open-org.apache.hadoop.fs.PathHandle-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a> open(<a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a> fd, |
| int bufferSize) |
| 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">Open an FSDataInputStream matching the PathHandle instance. The |
| implementation may encode metadata in PathHandle to address the |
| resource directly and verify that the resource referenced |
| satisfies constraints specified at its construciton.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fd</code> - PathHandle object returned by the FS authority.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to use</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/InvalidPathHandleException.html" title="class in org.apache.hadoop.fs">InvalidPathHandleException</a></code> - If <a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs"><code>PathHandle</code></a> constraints are |
| not satisfied</dd> |
| <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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - If not overridden by subclass</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPathHandle-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Options.HandleOpt...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPathHandle</h4> |
| <pre>public final <a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a> getPathHandle(<a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a> stat, |
| <a href="../../../../org/apache/hadoop/fs/Options.HandleOpt.html" title="class in org.apache.hadoop.fs">Options.HandleOpt</a>... opt)</pre> |
| <div class="block">Create a durable, serializable handle to the referent of the given |
| entity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stat</code> - Referent in the target FileSystem</dd> |
| <dd><code>opt</code> - If absent, assume <a href="../../../../org/apache/hadoop/fs/Options.HandleOpt.html#path--"><code>Options.HandleOpt.path()</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If the FileStatus does not belong to |
| this FileSystem</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - If <a href="../../../../org/apache/hadoop/fs/FileSystem.html#createPathHandle-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Options.HandleOpt...-"><code>createPathHandle(org.apache.hadoop.fs.FileStatus, org.apache.hadoop.fs.Options.HandleOpt...)</code></a> |
| not overridden by subclass.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - If this FileSystem cannot enforce |
| the specified constraints.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createPathHandle-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Options.HandleOpt...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPathHandle</h4> |
| <pre>protected <a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a> createPathHandle(<a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a> stat, |
| <a href="../../../../org/apache/hadoop/fs/Options.HandleOpt.html" title="class in org.apache.hadoop.fs">Options.HandleOpt</a>... opt)</pre> |
| <div class="block">Hook to implement support for <a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs"><code>PathHandle</code></a> operations.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stat</code> - Referent in the target FileSystem</dd> |
| <dd><code>opt</code> - Constraints that determine the validity of the |
| <a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs"><code>PathHandle</code></a> reference.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Create an FSDataOutputStream at the indicated Path. |
| Files are overwritten by default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file to create</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite) |
| 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">Create an FSDataOutputStream at the indicated Path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file to create</dd> |
| <dd><code>overwrite</code> - if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an exception will be thrown.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-org.apache.hadoop.util.Progressable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress) |
| 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">Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting. |
| Files are overwritten by default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file to create</dd> |
| <dd><code>progress</code> - to report progress</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-short-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| short replication) |
| 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">Create an FSDataOutputStream at the indicated Path. |
| Files are overwritten by default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file to create</dd> |
| <dd><code>replication</code> - the replication factor</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-short-org.apache.hadoop.util.Progressable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| short replication, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress) |
| 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">Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting. |
| Files are overwritten by default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file to create</dd> |
| <dd><code>replication</code> - the replication factor</dd> |
| <dd><code>progress</code> - to report progress</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-boolean-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite, |
| int bufferSize) |
| 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">Create an FSDataOutputStream at the indicated Path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file to create</dd> |
| <dd><code>overwrite</code> - if a path with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-boolean-int-org.apache.hadoop.util.Progressable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite, |
| int bufferSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress) |
| 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">Create an <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs"><code>FSDataOutputStream</code></a> at the indicated Path |
| with write-progress reporting. |
| |
| The frequency of callbacks is implementation-specific; it may be "none".</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the path of the file to open</dd> |
| <dd><code>overwrite</code> - if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-boolean-int-short-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite, |
| int bufferSize, |
| short replication, |
| long blockSize) |
| 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">Create an FSDataOutputStream at the indicated Path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file name to open</dd> |
| <dd><code>overwrite</code> - if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</dd> |
| <dd><code>replication</code> - required block replication for the file.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-boolean-int-short-long-org.apache.hadoop.util.Progressable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress) |
| 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">Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file name to open</dd> |
| <dd><code>overwrite</code> - if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</dd> |
| <dd><code>replication</code> - required block replication for the file.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-boolean-int-short-long-org.apache.hadoop.util.Progressable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public abstract <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission, |
| boolean overwrite, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress) |
| 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">Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file name to open</dd> |
| <dd><code>permission</code> - file permission</dd> |
| <dd><code>overwrite</code> - if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</dd> |
| <dd><code>replication</code> - required block replication for the file.</dd> |
| <dd><code>blockSize</code> - block size</dd> |
| <dd><code>progress</code> - the progress reporter</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> - IO failure</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setPermission-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"><code>setPermission(Path, FsPermission)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-java.util.EnumSet-int-short-long-org.apache.hadoop.util.Progressable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs">CreateFlag</a>> flags, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress) |
| 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">Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file name to open</dd> |
| <dd><code>permission</code> - file permission</dd> |
| <dd><code>flags</code> - <a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs"><code>CreateFlag</code></a>s to use for this stream.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</dd> |
| <dd><code>replication</code> - required block replication for the file.</dd> |
| <dd><code>blockSize</code> - block size</dd> |
| <dd><code>progress</code> - the progress reporter</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> - IO failure</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setPermission-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"><code>setPermission(Path, FsPermission)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-java.util.EnumSet-int-short-long-org.apache.hadoop.util.Progressable-org.apache.hadoop.fs.Options.ChecksumOpt-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> create(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs">CreateFlag</a>> flags, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress, |
| <a href="../../../../org/apache/hadoop/fs/Options.ChecksumOpt.html" title="class in org.apache.hadoop.fs">Options.ChecksumOpt</a> checksumOpt) |
| 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">Create an FSDataOutputStream at the indicated Path with a custom |
| checksum option.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file name to open</dd> |
| <dd><code>permission</code> - file permission</dd> |
| <dd><code>flags</code> - <a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs"><code>CreateFlag</code></a>s to use for this stream.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</dd> |
| <dd><code>replication</code> - required block replication for the file.</dd> |
| <dd><code>blockSize</code> - block size</dd> |
| <dd><code>progress</code> - the progress reporter</dd> |
| <dd><code>checksumOpt</code> - checksum parameter. If null, the values |
| found in conf will be used.</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> - IO failure</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setPermission-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"><code>setPermission(Path, FsPermission)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="primitiveCreate-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-java.util.EnumSet-int-short-long-org.apache.hadoop.util.Progressable-org.apache.hadoop.fs.Options.ChecksumOpt-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>primitiveCreate</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> |
| protected <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> primitiveCreate(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> absolutePermission, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs">CreateFlag</a>> flag, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress, |
| <a href="../../../../org/apache/hadoop/fs/Options.ChecksumOpt.html" title="class in org.apache.hadoop.fs">Options.ChecksumOpt</a> checksumOpt) |
| 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"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">This create has been added to support the FileContext that processes |
| the permission with umask before calling this method. |
| This a temporary method added to support the transition from FileSystem |
| to FileContext for user applications.</div> |
| <dl> |
| <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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="primitiveMkdir-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>primitiveMkdir</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> |
| protected boolean primitiveMkdir(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> absolutePermission) |
| 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"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">This version of the mkdirs method assumes that the permission is absolute. |
| It has been added to support the FileContext that processes the permission |
| with umask before calling this method. |
| This a temporary method added to support the transition from FileSystem |
| to FileContext for user applications.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - path</dd> |
| <dd><code>absolutePermission</code> - permissions</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the directory was actually created.</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> - IO failure</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/FileSystem.html#mkdirs-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"><code>mkdirs(Path, FsPermission)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="primitiveMkdir-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>primitiveMkdir</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> |
| protected void primitiveMkdir(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> absolutePermission, |
| boolean createParent) |
| 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"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">This version of the mkdirs method assumes that the permission is absolute. |
| It has been added to support the FileContext that processes the permission |
| with umask before calling this method. |
| This a temporary method added to support the transition from FileSystem |
| to FileContext for user applications.</div> |
| <dl> |
| <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="createNonRecursive-org.apache.hadoop.fs.Path-boolean-int-short-long-org.apache.hadoop.util.Progressable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createNonRecursive</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> createNonRecursive(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean overwrite, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress) |
| 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">Opens an FSDataOutputStream at the indicated Path with write-progress |
| reporting. Same as create(), except fails if parent directory doesn't |
| already exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file name to open</dd> |
| <dd><code>overwrite</code> - if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</dd> |
| <dd><code>replication</code> - required block replication for the file.</dd> |
| <dd><code>blockSize</code> - block size</dd> |
| <dd><code>progress</code> - the progress reporter</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> - IO failure</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setPermission-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"><code>setPermission(Path, FsPermission)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createNonRecursive-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-boolean-int-short-long-org.apache.hadoop.util.Progressable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createNonRecursive</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> createNonRecursive(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission, |
| boolean overwrite, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress) |
| 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">Opens an FSDataOutputStream at the indicated Path with write-progress |
| reporting. Same as create(), except fails if parent directory doesn't |
| already exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file name to open</dd> |
| <dd><code>permission</code> - file permission</dd> |
| <dd><code>overwrite</code> - if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</dd> |
| <dd><code>replication</code> - required block replication for the file.</dd> |
| <dd><code>blockSize</code> - block size</dd> |
| <dd><code>progress</code> - the progress reporter</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> - IO failure</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setPermission-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"><code>setPermission(Path, FsPermission)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createNonRecursive-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-java.util.EnumSet-int-short-long-org.apache.hadoop.util.Progressable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createNonRecursive</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> createNonRecursive(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs">CreateFlag</a>> flags, |
| int bufferSize, |
| short replication, |
| long blockSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress) |
| 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">Opens an FSDataOutputStream at the indicated Path with write-progress |
| reporting. Same as create(), except fails if parent directory doesn't |
| already exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the file name to open</dd> |
| <dd><code>permission</code> - file permission</dd> |
| <dd><code>flags</code> - <a href="../../../../org/apache/hadoop/fs/CreateFlag.html" title="enum in org.apache.hadoop.fs"><code>CreateFlag</code></a>s to use for this stream.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</dd> |
| <dd><code>replication</code> - required block replication for the file.</dd> |
| <dd><code>blockSize</code> - block size</dd> |
| <dd><code>progress</code> - the progress reporter</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> - IO failure</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/fs/FileSystem.html#setPermission-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"><code>setPermission(Path, FsPermission)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createNewFile-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createNewFile</h4> |
| <pre>public boolean createNewFile(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Creates the given Path as a brand-new zero-length file. If |
| create fails, or if it already existed, return false. |
| <i>Important: the default implementation is not atomic</i></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - path to use for create</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="append-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> append(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Append to an existing file (optional operation). |
| Same as |
| <code>append(f, getConf().getInt(IO_FILE_BUFFER_SIZE_KEY, |
| IO_FILE_BUFFER_SIZE_DEFAULT), null)</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the existing file to be appended.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="append-org.apache.hadoop.fs.Path-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> append(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| int bufferSize) |
| 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">Append to an existing file (optional operation). |
| Same as append(f, bufferSize, null).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the existing file to be appended.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="append-org.apache.hadoop.fs.Path-int-org.apache.hadoop.util.Progressable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre>public abstract <a href="../../../../org/apache/hadoop/fs/FSDataOutputStream.html" title="class in org.apache.hadoop.fs">FSDataOutputStream</a> append(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| int bufferSize, |
| <a href="../../../../org/apache/hadoop/util/Progressable.html" title="interface in org.apache.hadoop.util">Progressable</a> progress) |
| 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">Append to an existing file (optional operation).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the existing file to be appended.</dd> |
| <dd><code>bufferSize</code> - the size of the buffer to be used.</dd> |
| <dd><code>progress</code> - for reporting progress if it is not null.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="concat-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>concat</h4> |
| <pre>public void concat(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> trg, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>[] psrcs) |
| 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">Concat existing files together.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trg</code> - the path to the target destination.</dd> |
| <dd><code>psrcs</code> - the paths to the sources to use for the concatenation.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReplication-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReplication</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 short getReplication(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src) |
| 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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> instead</span></div> |
| <div class="block">Get the replication factor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - file name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>file replication</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if the path does not resolve.</dd> |
| <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> - an IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReplication-org.apache.hadoop.fs.Path-short-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReplication</h4> |
| <pre>public boolean setReplication(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| short replication) |
| 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">Set the replication for an existing file. |
| If a filesystem does not support replication, it will always |
| return true: the check for a file existing may be bypassed. |
| This is the default behavior.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - file name</dd> |
| <dd><code>replication</code> - new replication</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if successful, or the feature in unsupported; |
| false if replication is supported but the file does not exist, |
| or is a directory</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="rename-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rename</h4> |
| <pre>public abstract boolean rename(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst) |
| 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">Renames Path src to Path dst.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - path to be renamed</dd> |
| <dd><code>dst</code> - new path after rename</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if rename is successful</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> - on failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rename-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Options.Rename...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rename</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> |
| protected void rename(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst, |
| <a href="../../../../org/apache/hadoop/fs/Options.Rename.html" title="enum in org.apache.hadoop.fs">Options.Rename</a>... options) |
| 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"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Renames Path src to Path dst |
| <ul> |
| <li>Fails if src is a file and dst is a directory.</li> |
| <li>Fails if src is a directory and dst is a file.</li> |
| <li>Fails if the parent of dst does not exist or is a file.</li> |
| </ul> |
| <p> |
| If OVERWRITE option is not passed as an argument, rename fails |
| if the dst already exists. |
| <p> |
| If OVERWRITE option is passed as an argument, rename overwrites |
| the dst if it is a file or an empty directory. Rename fails if dst is |
| a non-empty directory. |
| <p> |
| Note that atomicity of rename is dependent on the file system |
| implementation. Please refer to the file system documentation for |
| details. This default implementation is non atomic. |
| <p> |
| This method is deprecated since it is a temporary method added to |
| support the transition from FileSystem to FileContext for user |
| applications.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - path to be renamed</dd> |
| <dd><code>dst</code> - new path after rename</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - src path does not exist, or the parent |
| path of dst does not exist.</dd> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/FileAlreadyExistsException.html" title="class in org.apache.hadoop.fs">FileAlreadyExistsException</a></code> - dest path exists and is a file</dd> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/ParentNotDirectoryException.html" title="class in org.apache.hadoop.fs">ParentNotDirectoryException</a></code> - if the parent path of dest is not |
| a directory</dd> |
| <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> - on failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="truncate-org.apache.hadoop.fs.Path-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>truncate</h4> |
| <pre>public boolean truncate(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| long newLength) |
| 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">Truncate the file in the indicated path to the indicated size. |
| <ul> |
| <li>Fails if path is a directory.</li> |
| <li>Fails if path does not exist.</li> |
| <li>Fails if path is not closed.</li> |
| <li>Fails if new size is greater than current size.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - The path to the file to be truncated</dd> |
| <dd><code>newLength</code> - The size the file is to be truncated to</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the file has been truncated to the desired |
| <code>newLength</code> and is immediately available to be reused for |
| write operations such as <code>append</code>, or |
| <code>false</code> if a background process of adjusting the length of |
| the last block has been started, and clients should wait for it to |
| complete before proceeding with further file updates.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="delete-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</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 boolean delete(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#delete-org.apache.hadoop.fs.Path-boolean-"><code>delete(Path, boolean)</code></a> instead.</span></div> |
| <div class="block">Delete a file/directory.</div> |
| <dl> |
| <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="delete-org.apache.hadoop.fs.Path-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre>public abstract boolean delete(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean recursive) |
| 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">Delete a file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the path to delete.</dd> |
| <dd><code>recursive</code> - if path is a directory and set to |
| true, the directory is deleted else throws an exception. In |
| case of a file the recursive can be set to either true or false.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if delete is successful else false.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteOnExit-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteOnExit</h4> |
| <pre>public boolean deleteOnExit(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Mark a path to be deleted when its FileSystem is closed. |
| When the JVM shuts down cleanly, all cached FileSystem objects will be |
| closed automatically. These the marked paths will be deleted as a result. |
| |
| If a FileSystem instance is not cached, i.e. has been created with |
| <a href="../../../../org/apache/hadoop/fs/FileSystem.html#createFileSystem-java.net.URI-org.apache.hadoop.conf.Configuration-"><code>createFileSystem(URI, Configuration)</code></a>, then the paths will |
| be deleted in when <a href="../../../../org/apache/hadoop/fs/FileSystem.html#close--"><code>close()</code></a> is called on that instance. |
| |
| The path must exist in the filesystem at the time of the method call; |
| it does not have to exist at the time of JVM shutdown. |
| |
| Notes |
| <ol> |
| <li>Clean shutdown of the JVM cannot be guaranteed.</li> |
| <li>The time to shut down a FileSystem will depends on the number of |
| files to delete. For filesystems where the cost of checking |
| for the existence of a file/directory and the actual delete operation |
| (for example: object stores) is high, the time to shutdown the JVM can be |
| significantly extended by over-use of this feature.</li> |
| <li>Connectivity problems with a remote filesystem may delay shutdown |
| further, and may cause the files to not be deleted.</li> |
| </ol></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the path to delete.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if deleteOnExit is successful, otherwise false.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancelDeleteOnExit-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancelDeleteOnExit</h4> |
| <pre>public boolean cancelDeleteOnExit(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</pre> |
| <div class="block">Cancel the scheduled deletion of the path when the FileSystem is closed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the path to cancel deletion</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the path was found in the delete-on-exit list.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="processDeleteOnExit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processDeleteOnExit</h4> |
| <pre>protected void processDeleteOnExit()</pre> |
| <div class="block">Delete all paths that were marked as delete-on-exit. This recursively |
| deletes all files and directories in the specified paths. |
| |
| The time to process this operation is <code>O(paths)</code>, with the actual |
| time dependent on the time for existence and deletion operations to |
| complete, successfully or not.</div> |
| </li> |
| </ul> |
| <a name="exists-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exists</h4> |
| <pre>public boolean exists(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Check if a path exists. |
| |
| It is highly discouraged to call this method back to back with other |
| <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> calls, as this will involve multiple redundant |
| RPC calls in HDFS.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - source path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the path exists</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDirectory-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDirectory</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 boolean isDirectory(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> instead</span></div> |
| <div class="block">True iff the named path is a directory. |
| Note: Avoid using this method. Instead reuse the FileStatus |
| returned by getFileStatus() or listStatus() methods.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - path to check</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isFile-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFile</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 boolean isFile(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> instead</span></div> |
| <div class="block">True iff the named path is a regular file. |
| Note: Avoid using this method. Instead reuse the FileStatus |
| returned by <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> or listStatus() methods.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - path to check</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLength-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLength</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 long getLength(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> instead.</span></div> |
| <div class="block">The number of bytes in a file.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes; 0 for a directory</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if the path does not resolve</dd> |
| <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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentSummary-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentSummary</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/ContentSummary.html" title="class in org.apache.hadoop.fs">ContentSummary</a> getContentSummary(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Return the <a href="../../../../org/apache/hadoop/fs/ContentSummary.html" title="class in org.apache.hadoop.fs"><code>ContentSummary</code></a> of a given <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs"><code>Path</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - path to use</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if the path does not resolve</dd> |
| <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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQuotaUsage-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuotaUsage</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs">QuotaUsage</a> getQuotaUsage(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Return the <a href="../../../../org/apache/hadoop/fs/QuotaUsage.html" title="class in org.apache.hadoop.fs"><code>QuotaUsage</code></a> of a given <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs"><code>Path</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - path to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the quota usage</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQuota-org.apache.hadoop.fs.Path-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQuota</h4> |
| <pre>public void setQuota(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| long namespaceQuota, |
| long storagespaceQuota) |
| 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">Set quota for the given <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs"><code>Path</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - the target path to set quota for</dd> |
| <dd><code>namespaceQuota</code> - the namespace quota (i.e., # of files/directories) |
| to set</dd> |
| <dd><code>storagespaceQuota</code> - the storage space quota to set</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQuotaByStorageType-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.StorageType-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQuotaByStorageType</h4> |
| <pre>public void setQuotaByStorageType(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/StorageType.html" title="enum in org.apache.hadoop.fs">StorageType</a> type, |
| long quota) |
| 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">Set per storage type quota for the given <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs"><code>Path</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - the target path to set storage type quota for</dd> |
| <dd><code>type</code> - the storage type to set</dd> |
| <dd><code>quota</code> - the quota to set for the given storage type</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listStatus-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listStatus</h4> |
| <pre>public abstract <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[] listStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>, |
| <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">List the statuses of the files/directories in the given path if the path is |
| a directory. |
| <p> |
| Does not guarantee to return the List of files/directories status in a |
| sorted order. |
| <p> |
| Will not return null. Expect IOException upon access error.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - given path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the statuses of the files/directories in the given patch</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - when the path does not exist</dd> |
| <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> - see specific implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listCorruptFileBlocks-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listCorruptFileBlocks</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/RemoteIterator.html" title="interface in org.apache.hadoop.fs">RemoteIterator</a><<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>> listCorruptFileBlocks(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path) |
| 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">List corrupted file blocks.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over the corrupt files under the given path |
| (may contain duplicates if a file has more than one corrupt block)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default).</dd> |
| <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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listStatus-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.PathFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listStatus</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[] listStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/PathFilter.html" title="interface in org.apache.hadoop.fs">PathFilter</a> filter) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>, |
| <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">Filter files/directories in the given path using the user-supplied path |
| filter. |
| <p> |
| Does not guarantee to return the List of files/directories status in a |
| sorted order.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - a path name</dd> |
| <dd><code>filter</code> - the user-supplied path filter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array of FileStatus objects for the files under the given path |
| after applying the filter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - when the path does not exist</dd> |
| <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> - see specific implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listStatus-org.apache.hadoop.fs.Path:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listStatus</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[] listStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>[] files) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>, |
| <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">Filter files/directories in the given list of paths using default |
| path filter. |
| <p> |
| Does not guarantee to return the List of files/directories status in a |
| sorted order.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>files</code> - a list of paths</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of statuses for the files under the given paths after |
| applying the filter default Path filter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - when the path does not exist</dd> |
| <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> - see specific implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listStatus-org.apache.hadoop.fs.Path:A-org.apache.hadoop.fs.PathFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listStatus</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[] listStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>[] files, |
| <a href="../../../../org/apache/hadoop/fs/PathFilter.html" title="interface in org.apache.hadoop.fs">PathFilter</a> filter) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>, |
| <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">Filter files/directories in the given list of paths using user-supplied |
| path filter. |
| <p> |
| Does not guarantee to return the List of files/directories status in a |
| sorted order.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>files</code> - a list of paths</dd> |
| <dd><code>filter</code> - the user-supplied path filter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of statuses for the files under the given paths after |
| applying the filter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - when the path does not exist</dd> |
| <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> - see specific implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="globStatus-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>globStatus</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[] globStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> pathPattern) |
| 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"><p>Return all the files that match filePattern and are not checksum |
| files. Results are sorted by their names. |
| |
| <p> |
| A filename pattern is composed of <i>regular</i> characters and |
| <i>special pattern matching</i> characters, which are: |
| |
| <dl> |
| <dd> |
| <dl> |
| <dt> <tt> ? </tt> |
| <dd> Matches any single character. |
| |
| <p> |
| <dt> <tt> * </tt> |
| <dd> Matches zero or more characters. |
| |
| <p> |
| <dt> <tt> [<i>abc</i>] </tt> |
| <dd> Matches a single character from character set |
| <tt>{<i>a,b,c</i>}</tt>. |
| |
| <p> |
| <dt> <tt> [<i>a</i>-<i>b</i>] </tt> |
| <dd> Matches a single character from the character range |
| <tt>{<i>a...b</i>}</tt>. Note that character <tt><i>a</i></tt> must be |
| lexicographically less than or equal to character <tt><i>b</i></tt>. |
| |
| <p> |
| <dt> <tt> [^<i>a</i>] </tt> |
| <dd> Matches a single character that is not from character set or range |
| <tt>{<i>a</i>}</tt>. Note that the <tt>^</tt> character must occur |
| immediately to the right of the opening bracket. |
| |
| <p> |
| <dt> <tt> \<i>c</i> </tt> |
| <dd> Removes (escapes) any special meaning of character <i>c</i>. |
| |
| <p> |
| <dt> <tt> {ab,cd} </tt> |
| <dd> Matches a string from the string set <tt>{<i>ab, cd</i>} </tt> |
| |
| <p> |
| <dt> <tt> {ab,c{de,fh}} </tt> |
| <dd> Matches a string from the string set <tt>{<i>ab, cde, cfh</i>}</tt> |
| |
| </dl> |
| </dd> |
| </dl></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathPattern</code> - a glob specifying a path pattern</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array of paths that match the path pattern</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="globStatus-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.PathFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>globStatus</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>[] globStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> pathPattern, |
| <a href="../../../../org/apache/hadoop/fs/PathFilter.html" title="interface in org.apache.hadoop.fs">PathFilter</a> filter) |
| 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">Return an array of <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs"><code>FileStatus</code></a> objects whose path names match |
| <code>pathPattern</code> and is accepted by the user-supplied path filter. |
| Results are sorted by their path names.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathPattern</code> - a glob specifying the path pattern</dd> |
| <dd><code>filter</code> - a user-supplied path filter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>null if <code>pathPattern</code> has no glob and the path does not exist |
| an empty array if <code>pathPattern</code> has a glob and no path |
| matches it else an array of <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs"><code>FileStatus</code></a> objects matching the |
| pattern</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> - if any I/O error occurs when fetching file status</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listLocatedStatus-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listLocatedStatus</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/RemoteIterator.html" title="interface in org.apache.hadoop.fs">RemoteIterator</a><<a href="../../../../org/apache/hadoop/fs/LocatedFileStatus.html" title="class in org.apache.hadoop.fs">LocatedFileStatus</a>> listLocatedStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>, |
| <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">List the statuses of the files/directories in the given path if the path is |
| a directory. |
| Return the file's status and block locations If the path is a file. |
| |
| If a returned status is a file, it contains the file's block locations.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - is the path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator that traverses statuses of the files/directories |
| in the given path</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - If <code>f</code> does not exist</dd> |
| <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> - If an I/O error occurred</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listLocatedStatus-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.PathFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listLocatedStatus</h4> |
| <pre>protected <a href="../../../../org/apache/hadoop/fs/RemoteIterator.html" title="interface in org.apache.hadoop.fs">RemoteIterator</a><<a href="../../../../org/apache/hadoop/fs/LocatedFileStatus.html" title="class in org.apache.hadoop.fs">LocatedFileStatus</a>> listLocatedStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/PathFilter.html" title="interface in org.apache.hadoop.fs">PathFilter</a> filter) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>, |
| <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">List a directory. |
| The returned results include its block location if it is a file |
| The results are filtered by the given path filter</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - a path</dd> |
| <dd><code>filter</code> - a path filter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator that traverses statuses of the files/directories |
| in the given path</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if <code>f</code> does not exist</dd> |
| <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> - if any I/O error occurred</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listStatusIterator-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listStatusIterator</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/RemoteIterator.html" title="interface in org.apache.hadoop.fs">RemoteIterator</a><<a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>> listStatusIterator(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>, |
| <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 remote iterator so that followup calls are made on demand |
| while consuming the entries. Each FileSystem implementation should |
| override this method and provide a more efficient implementation, if |
| possible. |
| |
| Does not guarantee to return the iterator that traverses statuses |
| of the files in a sorted order.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - target path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>remote iterator</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if <code>p</code> does not exist</dd> |
| <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> - if any I/O error occurred</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listFiles-org.apache.hadoop.fs.Path-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listFiles</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/RemoteIterator.html" title="interface in org.apache.hadoop.fs">RemoteIterator</a><<a href="../../../../org/apache/hadoop/fs/LocatedFileStatus.html" title="class in org.apache.hadoop.fs">LocatedFileStatus</a>> listFiles(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| boolean recursive) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>, |
| <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">List the statuses and block locations of the files in the given path. |
| Does not guarantee to return the iterator that traverses statuses |
| of the files in a sorted order. |
| |
| <pre> |
| If the path is a directory, |
| if recursive is false, returns files in the directory; |
| if recursive is true, return files in the subtree rooted at the path. |
| If the path is a file, return the file's status and block locations. |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - is the path</dd> |
| <dd><code>recursive</code> - if the subdirectories need to be traversed recursively</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator that traverses statuses of the files</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - when the path does not exist;</dd> |
| <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> - see specific implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHomeDirectory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHomeDirectory</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> getHomeDirectory()</pre> |
| <div class="block">Return the current user's home directory in this FileSystem. |
| The default implementation returns <code>"/user/$USER/"</code>.</div> |
| </li> |
| </ul> |
| <a name="setWorkingDirectory-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWorkingDirectory</h4> |
| <pre>public abstract void setWorkingDirectory(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> new_dir)</pre> |
| <div class="block">Set the current working directory for the given FileSystem. All relative |
| paths will be resolved relative to it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>new_dir</code> - Path of new working directory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWorkingDirectory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWorkingDirectory</h4> |
| <pre>public abstract <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> getWorkingDirectory()</pre> |
| <div class="block">Get the current working directory for the given FileSystem</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the directory pathname</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitialWorkingDirectory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialWorkingDirectory</h4> |
| <pre>protected <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> getInitialWorkingDirectory()</pre> |
| <div class="block">Note: with the new FileContext class, getWorkingDirectory() |
| will be removed. |
| The working directory is implemented in FileContext. |
| |
| Some FileSystems like LocalFileSystem have an initial workingDir |
| that we use as the starting workingDir. For other file systems |
| like HDFS there is no built in notion of an initial workingDir.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if there is built in notion of workingDir then it |
| is returned; else a null is returned.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="mkdirs-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mkdirs</h4> |
| <pre>public boolean mkdirs(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Call <a href="../../../../org/apache/hadoop/fs/FileSystem.html#mkdirs-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"><code>mkdirs(Path, FsPermission)</code></a> with default permission.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the directory was created</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="mkdirs-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mkdirs</h4> |
| <pre>public abstract boolean mkdirs(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission) |
| 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">Make the given file and all non-existent parents into |
| directories. Has roughly the semantics of Unix @{code mkdir -p}. |
| Existence of the directory hierarchy is not an error.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - path to create</dd> |
| <dd><code>permission</code> - to apply to f</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyFromLocalFile-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFromLocalFile</h4> |
| <pre>public void copyFromLocalFile(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst) |
| 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">The src file is on the local disk. Add it to filesystem at |
| the given dst name and the source is kept intact afterwards</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - path</dd> |
| <dd><code>dst</code> - path</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="moveFromLocalFile-org.apache.hadoop.fs.Path:A-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>moveFromLocalFile</h4> |
| <pre>public void moveFromLocalFile(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>[] srcs, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst) |
| 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">The src files is on the local disk. Add it to filesystem at |
| the given dst name, removing the source afterwards.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srcs</code> - source paths</dd> |
| <dd><code>dst</code> - path</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="moveFromLocalFile-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>moveFromLocalFile</h4> |
| <pre>public void moveFromLocalFile(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst) |
| 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">The src file is on the local disk. Add it to the filesystem at |
| the given dst name, removing the source afterwards.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - local path</dd> |
| <dd><code>dst</code> - path</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyFromLocalFile-boolean-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFromLocalFile</h4> |
| <pre>public void copyFromLocalFile(boolean delSrc, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst) |
| 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">The src file is on the local disk. Add it to the filesystem at |
| the given dst name. |
| delSrc indicates if the source should be removed</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delSrc</code> - whether to delete the src</dd> |
| <dd><code>src</code> - path</dd> |
| <dd><code>dst</code> - path</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="copyFromLocalFile-boolean-boolean-org.apache.hadoop.fs.Path:A-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFromLocalFile</h4> |
| <pre>public void copyFromLocalFile(boolean delSrc, |
| boolean overwrite, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a>[] srcs, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst) |
| 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">The src files are on the local disk. Add it to the filesystem at |
| the given dst name. |
| delSrc indicates if the source should be removed</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delSrc</code> - whether to delete the src</dd> |
| <dd><code>overwrite</code> - whether to overwrite an existing file</dd> |
| <dd><code>srcs</code> - array of paths which are source</dd> |
| <dd><code>dst</code> - path</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyFromLocalFile-boolean-boolean-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFromLocalFile</h4> |
| <pre>public void copyFromLocalFile(boolean delSrc, |
| boolean overwrite, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst) |
| 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">The src file is on the local disk. Add it to the filesystem at |
| the given dst name. |
| delSrc indicates if the source should be removed</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delSrc</code> - whether to delete the src</dd> |
| <dd><code>overwrite</code> - whether to overwrite an existing file</dd> |
| <dd><code>src</code> - path</dd> |
| <dd><code>dst</code> - path</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyToLocalFile-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyToLocalFile</h4> |
| <pre>public void copyToLocalFile(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst) |
| 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">Copy it a file from the remote filesystem to the local one.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - path src file in the remote filesystem</dd> |
| <dd><code>dst</code> - path local destination</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="moveToLocalFile-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>moveToLocalFile</h4> |
| <pre>public void moveToLocalFile(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst) |
| 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">Copy a file to the local filesystem, then delete it from the |
| remote filesystem (if successfully copied).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - path src file in the remote filesystem</dd> |
| <dd><code>dst</code> - path local destination</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyToLocalFile-boolean-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyToLocalFile</h4> |
| <pre>public void copyToLocalFile(boolean delSrc, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst) |
| 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">Copy it a file from a remote filesystem to the local one. |
| delSrc indicates if the src will be removed or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delSrc</code> - whether to delete the src</dd> |
| <dd><code>src</code> - path src file in the remote filesystem</dd> |
| <dd><code>dst</code> - path local destination</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyToLocalFile-boolean-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyToLocalFile</h4> |
| <pre>public void copyToLocalFile(boolean delSrc, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> dst, |
| boolean useRawLocalFileSystem) |
| 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">The src file is under this filesystem, and the dst is on the local disk. |
| Copy it from the remote filesystem to the local dst name. |
| delSrc indicates if the src will be removed |
| or not. useRawLocalFileSystem indicates whether to use RawLocalFileSystem |
| as the local file system or not. RawLocalFileSystem is non checksumming, |
| So, It will not create any crc files at local.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delSrc</code> - whether to delete the src</dd> |
| <dd><code>src</code> - path</dd> |
| <dd><code>dst</code> - path</dd> |
| <dd><code>useRawLocalFileSystem</code> - whether to use RawLocalFileSystem as local file system or not.</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> - for any IO error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startLocalOutput-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startLocalOutput</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> startLocalOutput(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> fsOutputFile, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> tmpLocalFile) |
| 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 local file that the user can write output to. The caller |
| provides both the eventual target name in this FileSystem |
| and the local working file path. |
| If this FileSystem is local, we write directly into the target. If |
| the FileSystem is not local, we write into the tmp local area.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fsOutputFile</code> - path of output file</dd> |
| <dd><code>tmpLocalFile</code> - path of local tmp file</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="completeLocalOutput-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>completeLocalOutput</h4> |
| <pre>public void completeLocalOutput(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> fsOutputFile, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> tmpLocalFile) |
| 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">Called when we're all done writing to the target. |
| A local FS will do nothing, because we've written to exactly the |
| right place. |
| A remote FS will copy the contents of tmpLocalFile to the correct target at |
| fsOutputFile.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fsOutputFile</code> - path of output file</dd> |
| <dd><code>tmpLocalFile</code> - path to local tmp file</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| 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">Close this FileSystem instance. |
| Will release any held locks, delete all files queued for deletion |
| through calls to <a href="../../../../org/apache/hadoop/fs/FileSystem.html#deleteOnExit-org.apache.hadoop.fs.Path-"><code>deleteOnExit(Path)</code></a>, and remove this FS instance |
| from the cache, if cached. |
| |
| After this operation, the outcome of any method call on this FileSystem |
| instance, or any input/output stream created by it is <i>undefined</i>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUsed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUsed</h4> |
| <pre>public long getUsed() |
| 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">Return the total size of all files in the filesystem.</div> |
| <dl> |
| <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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUsed-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUsed</h4> |
| <pre>public long getUsed(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path) |
| 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">Return the total size of all files from a specified path.</div> |
| <dl> |
| <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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBlockSize-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBlockSize</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 long getBlockSize(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getFileStatus-org.apache.hadoop.fs.Path-"><code>getFileStatus(Path)</code></a> instead</span></div> |
| <div class="block">Get the block size for a particular file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - the filename</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes in a block</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - if the path is not present</dd> |
| <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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultBlockSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultBlockSize</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 long getDefaultBlockSize()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultBlockSize-org.apache.hadoop.fs.Path-"><code>getDefaultBlockSize(Path)</code></a> instead</span></div> |
| <div class="block">Return the number of bytes that large input files should be optimally |
| be split into to minimize I/O time.</div> |
| </li> |
| </ul> |
| <a name="getDefaultBlockSize-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultBlockSize</h4> |
| <pre>public long getDefaultBlockSize(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f)</pre> |
| <div class="block">Return the number of bytes that large input files should be optimally |
| be split into to minimize I/O time. The given path will be used to |
| locate the actual filesystem. The full path does not have to exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - path of file</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default block size for the path's filesystem</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultReplication--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultReplication</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 short getDefaultReplication()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getDefaultReplication-org.apache.hadoop.fs.Path-"><code>getDefaultReplication(Path)</code></a> instead</span></div> |
| <div class="block">Get the default replication.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the replication; the default value is "1".</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultReplication-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultReplication</h4> |
| <pre>public short getDefaultReplication(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</pre> |
| <div class="block">Get the default replication for a path. |
| The given path will be used to locate the actual FileSystem to query. |
| The full path does not have to exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - of the file</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>default replication for the path's filesystem</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFileStatus-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileStatus</h4> |
| <pre>public abstract <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a> getFileStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Return a file status object that represents the path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - The path we want information from</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FileStatus object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - when the path does not exist</dd> |
| <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> - see specific implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="msync--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>msync</h4> |
| <pre>public void msync() |
| 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>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre> |
| <div class="block">Synchronize client metadata state. |
| <p> |
| In some FileSystem implementations such as HDFS metadata |
| synchronization is essential to guarantee consistency of read requests |
| particularly in HA setting.</div> |
| <dl> |
| <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> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fixRelativePart-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fixRelativePart</h4> |
| <pre>protected <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> fixRelativePart(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p)</pre> |
| <div class="block">See <a href="../../../../org/apache/hadoop/fs/FileContext.html#fixRelativePart-org.apache.hadoop.fs.Path-"><code>FileContext.fixRelativePart(org.apache.hadoop.fs.Path)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="createSymlink-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSymlink</h4> |
| <pre>public void createSymlink(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> target, |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> link, |
| boolean createParent) |
| throws <a href="../../../../org/apache/hadoop/security/AccessControlException.html" title="class in org.apache.hadoop.security">AccessControlException</a>, |
| <a href="../../../../org/apache/hadoop/fs/FileAlreadyExistsException.html" title="class in org.apache.hadoop.fs">FileAlreadyExistsException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>, |
| <a href="../../../../org/apache/hadoop/fs/ParentNotDirectoryException.html" title="class in org.apache.hadoop.fs">ParentNotDirectoryException</a>, |
| <a href="../../../../org/apache/hadoop/fs/UnsupportedFileSystemException.html" title="class in org.apache.hadoop.fs">UnsupportedFileSystemException</a>, |
| <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">See <a href="../../../../org/apache/hadoop/fs/FileContext.html#createSymlink-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-boolean-"><code>FileContext.createSymlink(Path, Path, boolean)</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/security/AccessControlException.html" title="class in org.apache.hadoop.security">AccessControlException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/FileAlreadyExistsException.html" title="class in org.apache.hadoop.fs">FileAlreadyExistsException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/ParentNotDirectoryException.html" title="class in org.apache.hadoop.fs">ParentNotDirectoryException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/UnsupportedFileSystemException.html" title="class in org.apache.hadoop.fs">UnsupportedFileSystemException</a></code></dd> |
| <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="getFileLinkStatus-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileLinkStatus</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a> getFileLinkStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| throws <a href="../../../../org/apache/hadoop/security/AccessControlException.html" title="class in org.apache.hadoop.security">AccessControlException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>, |
| <a href="../../../../org/apache/hadoop/fs/UnsupportedFileSystemException.html" title="class in org.apache.hadoop.fs">UnsupportedFileSystemException</a>, |
| <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">See <a href="../../../../org/apache/hadoop/fs/FileContext.html#getFileLinkStatus-org.apache.hadoop.fs.Path-"><code>FileContext.getFileLinkStatus(Path)</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - when the path does not exist</dd> |
| <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> - see specific implementation</dd> |
| <dd><code><a href="../../../../org/apache/hadoop/security/AccessControlException.html" title="class in org.apache.hadoop.security">AccessControlException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/UnsupportedFileSystemException.html" title="class in org.apache.hadoop.fs">UnsupportedFileSystemException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="supportsSymlinks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsSymlinks</h4> |
| <pre>public boolean supportsSymlinks()</pre> |
| <div class="block">See <a href="../../../../org/apache/hadoop/fs/AbstractFileSystem.html#supportsSymlinks--"><code>AbstractFileSystem.supportsSymlinks()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getLinkTarget-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLinkTarget</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> getLinkTarget(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">See <a href="../../../../org/apache/hadoop/fs/FileContext.html#getLinkTarget-org.apache.hadoop.fs.Path-"><code>FileContext.getLinkTarget(Path)</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| <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="resolveLink-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveLink</h4> |
| <pre>protected <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> resolveLink(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">See <a href="../../../../org/apache/hadoop/fs/AbstractFileSystem.html#getLinkTarget-org.apache.hadoop.fs.Path-"><code>AbstractFileSystem.getLinkTarget(Path)</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| <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="getFileChecksum-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileChecksum</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FileChecksum.html" title="class in org.apache.hadoop.fs">FileChecksum</a> getFileChecksum(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f) |
| 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">Get the checksum of a file, if the FS supports checksums.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - The file path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The file checksum. The default return value is null, |
| which indicates that no checksum algorithm is implemented |
| in the corresponding FileSystem.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFileChecksum-org.apache.hadoop.fs.Path-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileChecksum</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FileChecksum.html" title="class in org.apache.hadoop.fs">FileChecksum</a> getFileChecksum(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> f, |
| long length) |
| 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">Get the checksum of a file, from the beginning of the file till the |
| specific length.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>f</code> - The file path</dd> |
| <dd><code>length</code> - The length of the file range for checksum calculation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The file checksum or null if checksums are not supported.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVerifyChecksum-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVerifyChecksum</h4> |
| <pre>public void setVerifyChecksum(boolean verifyChecksum)</pre> |
| <div class="block">Set the verify checksum flag. This is only applicable if the |
| corresponding filesystem supports checksums. |
| By default doesn't do anything.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>verifyChecksum</code> - Verify checksum flag</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setWriteChecksum-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriteChecksum</h4> |
| <pre>public void setWriteChecksum(boolean writeChecksum)</pre> |
| <div class="block">Set the write checksum flag. This is only applicable if the |
| corresponding filesystem supports checksums. |
| By default doesn't do anything.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>writeChecksum</code> - Write checksum flag</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStatus--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatus</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FsStatus.html" title="class in org.apache.hadoop.fs">FsStatus</a> getStatus() |
| 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 status object describing the use and capacity of the |
| filesystem. If the filesystem has multiple partitions, the |
| use and capacity of the root partition is reflected.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FsStatus object</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> - see specific implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStatus-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatus</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FsStatus.html" title="class in org.apache.hadoop.fs">FsStatus</a> getStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p) |
| 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 status object describing the use and capacity of the |
| filesystem. If the filesystem has multiple partitions, the |
| use and capacity of the partition pointed to by the specified |
| path is reflected.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - Path for which status should be obtained. null means |
| the default partition.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FsStatus object</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> - see specific implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPermission-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.permission.FsPermission-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPermission</h4> |
| <pre>public void setPermission(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p, |
| <a href="../../../../org/apache/hadoop/fs/permission/FsPermission.html" title="class in org.apache.hadoop.fs.permission">FsPermission</a> permission) |
| 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">Set permission of a path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - The path</dd> |
| <dd><code>permission</code> - permission</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOwner-org.apache.hadoop.fs.Path-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOwner</h4> |
| <pre>public void setOwner(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p, |
| <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> username, |
| <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> groupname) |
| 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">Set owner of a path (i.e. a file or a directory). |
| The parameters username and groupname cannot both be null.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - The path</dd> |
| <dd><code>username</code> - If it is null, the original username remains unchanged.</dd> |
| <dd><code>groupname</code> - If it is null, the original groupname remains unchanged.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTimes-org.apache.hadoop.fs.Path-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimes</h4> |
| <pre>public void setTimes(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> p, |
| long mtime, |
| long atime) |
| 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">Set access time of a file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>p</code> - The path</dd> |
| <dd><code>mtime</code> - Set the modification time of this file. |
| The number of milliseconds since Jan 1, 1970. |
| A value of -1 means that this call should not set modification time.</dd> |
| <dd><code>atime</code> - Set the access time of this file. |
| The number of milliseconds since Jan 1, 1970. |
| A value of -1 means that this call should not set access time.</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> - IO failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createSnapshot-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSnapshot</h4> |
| <pre>public final <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> createSnapshot(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path) |
| 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">Create a snapshot with a default name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - The directory where snapshots will be taken.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the snapshot path.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createSnapshot-org.apache.hadoop.fs.Path-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSnapshot</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> createSnapshot(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> snapshotName) |
| 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">Create a snapshot.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - The directory where snapshots will be taken.</dd> |
| <dd><code>snapshotName</code> - The name of the snapshot</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the snapshot path.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="renameSnapshot-org.apache.hadoop.fs.Path-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renameSnapshot</h4> |
| <pre>public void renameSnapshot(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> snapshotOldName, |
| <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> snapshotNewName) |
| 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">Rename a snapshot.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - The directory path where the snapshot was taken</dd> |
| <dd><code>snapshotOldName</code> - Old name of the snapshot</dd> |
| <dd><code>snapshotNewName</code> - New name of the snapshot</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteSnapshot-org.apache.hadoop.fs.Path-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteSnapshot</h4> |
| <pre>public void deleteSnapshot(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> snapshotName) |
| 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">Delete a snapshot of a directory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - The directory that the to-be-deleted snapshot belongs to</dd> |
| <dd><code>snapshotName</code> - The name of the snapshot</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="modifyAclEntries-org.apache.hadoop.fs.Path-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>modifyAclEntries</h4> |
| <pre>public void modifyAclEntries(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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/permission/AclEntry.html" title="class in org.apache.hadoop.fs.permission">AclEntry</a>> aclSpec) |
| 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">Modifies ACL entries of files and directories. This method can add new ACL |
| entries or modify the permissions on existing ACL entries. All existing |
| ACL entries that are not specified in this call are retained without |
| changes. (Modifications are merged into the current ACL.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to modify</dd> |
| <dd><code>aclSpec</code> - List<AclEntry> describing modifications</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> - if an ACL could not be modified</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAclEntries-org.apache.hadoop.fs.Path-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAclEntries</h4> |
| <pre>public void removeAclEntries(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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/permission/AclEntry.html" title="class in org.apache.hadoop.fs.permission">AclEntry</a>> aclSpec) |
| 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">Removes ACL entries from files and directories. Other ACL entries are |
| retained.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to modify</dd> |
| <dd><code>aclSpec</code> - List describing entries to remove</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> - if an ACL could not be modified</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeDefaultAcl-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDefaultAcl</h4> |
| <pre>public void removeDefaultAcl(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path) |
| 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">Removes all default ACL entries from files and directories.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to modify</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> - if an ACL could not be modified</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAcl-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAcl</h4> |
| <pre>public void removeAcl(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path) |
| 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">Removes all but the base ACL entries of files and directories. The entries |
| for user, group, and others are retained for compatibility with permission |
| bits.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to modify</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> - if an ACL could not be removed</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAcl-org.apache.hadoop.fs.Path-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAcl</h4> |
| <pre>public void setAcl(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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/permission/AclEntry.html" title="class in org.apache.hadoop.fs.permission">AclEntry</a>> aclSpec) |
| 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">Fully replaces ACL of files and directories, discarding all existing |
| entries.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to modify</dd> |
| <dd><code>aclSpec</code> - List describing modifications, which must include entries |
| for user, group, and others for compatibility with permission bits.</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> - if an ACL could not be modified</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAclStatus-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAclStatus</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/permission/AclStatus.html" title="class in org.apache.hadoop.fs.permission">AclStatus</a> getAclStatus(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path) |
| 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">Gets the ACL of a file or directory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to get</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>AclStatus describing the ACL of the file or directory</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> - if an ACL could not be read</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setXAttr-org.apache.hadoop.fs.Path-java.lang.String-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setXAttr</h4> |
| <pre>public void setXAttr(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> name, |
| byte[] value) |
| 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">Set an xattr of a file or directory. |
| The name must be prefixed with the namespace followed by ".". For example, |
| "user.attr". |
| <p> |
| Refer to the HDFS extended attributes user documentation for details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to modify</dd> |
| <dd><code>name</code> - xattr name.</dd> |
| <dd><code>value</code> - xattr value.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setXAttr-org.apache.hadoop.fs.Path-java.lang.String-byte:A-java.util.EnumSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setXAttr</h4> |
| <pre>public void setXAttr(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> name, |
| byte[] value, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../org/apache/hadoop/fs/XAttrSetFlag.html" title="enum in org.apache.hadoop.fs">XAttrSetFlag</a>> flag) |
| 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">Set an xattr of a file or directory. |
| The name must be prefixed with the namespace followed by ".". For example, |
| "user.attr". |
| <p> |
| Refer to the HDFS extended attributes user documentation for details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to modify</dd> |
| <dd><code>name</code> - xattr name.</dd> |
| <dd><code>value</code> - xattr value.</dd> |
| <dd><code>flag</code> - xattr set flag</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getXAttr-org.apache.hadoop.fs.Path-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXAttr</h4> |
| <pre>public byte[] getXAttr(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> name) |
| 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">Get an xattr name and value for a file or directory. |
| The name must be prefixed with the namespace followed by ".". For example, |
| "user.attr". |
| <p> |
| Refer to the HDFS extended attributes user documentation for details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to get extended attribute</dd> |
| <dd><code>name</code> - xattr name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>byte[] xattr value.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getXAttrs-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXAttrs</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,byte[]> getXAttrs(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path) |
| 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">Get all of the xattr name/value pairs for a file or directory. |
| Only those xattrs which the logged-in user has permissions to view |
| are returned. |
| <p> |
| Refer to the HDFS extended attributes user documentation for details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to get extended attributes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Map describing the XAttrs of the file or directory</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getXAttrs-org.apache.hadoop.fs.Path-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXAttrs</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,byte[]> getXAttrs(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> names) |
| 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">Get all of the xattrs name/value pairs for a file or directory. |
| Only those xattrs which the logged-in user has permissions to view |
| are returned. |
| <p> |
| Refer to the HDFS extended attributes user documentation for details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to get extended attributes</dd> |
| <dd><code>names</code> - XAttr names.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Map describing the XAttrs of the file or directory</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listXAttrs-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listXAttrs</h4> |
| <pre>public <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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> listXAttrs(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path) |
| 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">Get all of the xattr names for a file or directory. |
| Only those xattr names which the logged-in user has permissions to view |
| are returned. |
| <p> |
| Refer to the HDFS extended attributes user documentation for details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to get extended attributes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List<String> of the XAttr names of the file or directory</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeXAttr-org.apache.hadoop.fs.Path-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeXAttr</h4> |
| <pre>public void removeXAttr(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> name) |
| 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">Remove an xattr of a file or directory. |
| The name must be prefixed with the namespace followed by ".". For example, |
| "user.attr". |
| <p> |
| Refer to the HDFS extended attributes user documentation for details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to remove extended attribute</dd> |
| <dd><code>name</code> - xattr name</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="satisfyStoragePolicy-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>satisfyStoragePolicy</h4> |
| <pre>public void satisfyStoragePolicy(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path) |
| 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">Set the source path to satisfy storage policy.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - The source path referring to either a directory or a file.</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="setStoragePolicy-org.apache.hadoop.fs.Path-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStoragePolicy</h4> |
| <pre>public void setStoragePolicy(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src, |
| <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> policyName) |
| 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">Set the storage policy for a given file or directory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - file or directory path.</dd> |
| <dd><code>policyName</code> - the name of the target storage policy. The list |
| of supported Storage policies can be retrieved |
| via <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getAllStoragePolicies--"><code>getAllStoragePolicies()</code></a>.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unsetStoragePolicy-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unsetStoragePolicy</h4> |
| <pre>public void unsetStoragePolicy(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src) |
| 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">Unset the storage policy set for a given file or directory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - file or directory path.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStoragePolicy-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStoragePolicy</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/BlockStoragePolicySpi.html" title="interface in org.apache.hadoop.fs">BlockStoragePolicySpi</a> getStoragePolicy(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> src) |
| 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">Query the effective storage policy ID for the given file or directory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - file or directory path.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>storage policy for give file.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllStoragePolicies--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllStoragePolicies</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../../org/apache/hadoop/fs/BlockStoragePolicySpi.html" title="interface in org.apache.hadoop.fs">BlockStoragePolicySpi</a>> getAllStoragePolicies() |
| 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">Retrieve all the storage policies supported by this file system.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all storage policies supported by this filesystem.</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> - IO failure</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the operation is unsupported |
| (default outcome).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTrashRoot-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrashRoot</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> getTrashRoot(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</pre> |
| <div class="block">Get the root directory of Trash for current user when the path specified |
| is deleted.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the trash root of the path to be determined.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default implementation returns <code>/user/$USER/.Trash</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTrashRoots-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrashRoots</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/hadoop/fs/FileStatus.html" title="class in org.apache.hadoop.fs">FileStatus</a>> getTrashRoots(boolean allUsers)</pre> |
| <div class="block">Get all the trash roots for current user or all users.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allUsers</code> - return trash roots for all users if true.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the trash root directories. |
| Default FileSystem returns .Trash under users' home directories if |
| <code>/user/$USER/.Trash</code> exists.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasPathCapability-org.apache.hadoop.fs.Path-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasPathCapability</h4> |
| <pre>public boolean hasPathCapability(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <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> capability) |
| 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">The base FileSystem implementation generally has no knowledge |
| of the capabilities of actual implementations. |
| Unless it has a way to explicitly determine the capabilities, |
| this method returns false. |
| Probe for a specific capability under the given path. |
| If the function returns <code>true</code>, this instance is explicitly |
| declaring that the capability is available. |
| If the function returns <code>false</code>, it can mean one of: |
| <ul> |
| <li>The capability is not known.</li> |
| <li>The capability is known but it is not supported.</li> |
| <li>The capability is known but the filesystem does not know if it |
| is supported under the supplied path.</li> |
| </ul> |
| The core guarantee which a caller can rely on is: if the predicate |
| returns true, then the specific operation/behavior can be expected to be |
| supported. However a specific call may be rejected for permission reasons, |
| the actual file/directory not being present, or some other failure during |
| the attempted execution of the operation. |
| <p> |
| Implementors: <code>PathCapabilitiesSupport</code> |
| can be used to help implement this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/PathCapabilities.html#hasPathCapability-org.apache.hadoop.fs.Path-java.lang.String-">hasPathCapability</a></code> in interface <code><a href="../../../../org/apache/hadoop/fs/PathCapabilities.html" title="interface in org.apache.hadoop.fs">PathCapabilities</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - path to query the capability of.</dd> |
| <dd><code>capability</code> - non-null, non-empty string to query the path for support.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the capability is supported under that part of the FS.</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> - this should not be raised, except on problems |
| resolving paths or relaying the call.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFileSystemClass-java.lang.String-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileSystemClass</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a>> getFileSystemClass(<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> scheme, |
| <a href="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</a> conf) |
| 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">Get the FileSystem implementation class of a filesystem. |
| This triggers a scan and load of all FileSystem implementations listed as |
| services and discovered via the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html?is-external=true" title="class or interface in java.util"><code>ServiceLoader</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scheme</code> - URL scheme of FS</dd> |
| <dd><code>conf</code> - configuration: can be null, in which case the check for |
| a filesystem binding declaration in the configuration is skipped.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filesystem</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/fs/UnsupportedFileSystemException.html" title="class in org.apache.hadoop.fs">UnsupportedFileSystemException</a></code> - if there was no known implementation |
| for the scheme.</dd> |
| <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> - if the filesystem could not be loaded</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStatistics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatistics</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 static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<a href="../../../../org/apache/hadoop/fs/FileSystem.Statistics.html" title="class in org.apache.hadoop.fs">FileSystem.Statistics</a>> getStatistics()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getGlobalStorageStatistics--"><code>getGlobalStorageStatistics()</code></a></span></div> |
| <div class="block">Get the Map of Statistics object indexed by URI Scheme.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map having a key as URI scheme and value as Statistics object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllStatistics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllStatistics</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 static <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/FileSystem.Statistics.html" title="class in org.apache.hadoop.fs">FileSystem.Statistics</a>> getAllStatistics()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getGlobalStorageStatistics--"><code>getGlobalStorageStatistics()</code></a></span></div> |
| <div class="block">Return the FileSystem classes that have Statistics.</div> |
| </li> |
| </ul> |
| <a name="getStatistics-java.lang.String-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatistics</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 static <a href="../../../../org/apache/hadoop/fs/FileSystem.Statistics.html" title="class in org.apache.hadoop.fs">FileSystem.Statistics</a> getStatistics(<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> scheme, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a>> cls)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/hadoop/fs/FileSystem.html#getGlobalStorageStatistics--"><code>getGlobalStorageStatistics()</code></a></span></div> |
| <div class="block">Get the statistics for a particular file system.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - the class to lookup</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a statistics object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearStatistics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearStatistics</h4> |
| <pre>public static void clearStatistics()</pre> |
| <div class="block">Reset all statistics for all file systems.</div> |
| </li> |
| </ul> |
| <a name="printStatistics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>printStatistics</h4> |
| <pre>public static void printStatistics() |
| 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">Print all statistics for all file systems to <code>System.out</code></div> |
| <dl> |
| <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="areSymlinksEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>areSymlinksEnabled</h4> |
| <pre>public static boolean areSymlinksEnabled()</pre> |
| </li> |
| </ul> |
| <a name="enableSymlinks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enableSymlinks</h4> |
| <pre>public static void enableSymlinks()</pre> |
| </li> |
| </ul> |
| <a name="getStorageStatistics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStorageStatistics</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/StorageStatistics.html" title="class in org.apache.hadoop.fs">StorageStatistics</a> getStorageStatistics()</pre> |
| <div class="block">Get the StorageStatistics for this FileSystem object. These statistics are |
| per-instance. They are not shared with any other FileSystem object. |
| |
| <p>This is a default method which is intended to be overridden by |
| subclasses. The default implementation returns an empty storage statistics |
| object.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The StorageStatistics for this FileSystem instance. |
| Will never be null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGlobalStorageStatistics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGlobalStorageStatistics</h4> |
| <pre>public static <a href="../../../../org/apache/hadoop/fs/GlobalStorageStatistics.html" title="enum in org.apache.hadoop.fs">GlobalStorageStatistics</a> getGlobalStorageStatistics()</pre> |
| <div class="block">Get the global storage statistics.</div> |
| </li> |
| </ul> |
| <a name="createDataOutputStreamBuilder-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDataOutputStreamBuilder</h4> |
| <pre>@InterfaceStability.Unstable |
| protected static <a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="class in org.apache.hadoop.fs">FSDataOutputStreamBuilder</a> createDataOutputStreamBuilder(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a> |
| <a href="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</a> fileSystem, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a> |
| <a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</pre> |
| <div class="block">Create instance of the standard FSDataOutputStreamBuilder for the |
| given filesystem and path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fileSystem</code> - owner</dd> |
| <dd><code>path</code> - path to create</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createFile-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFile</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="class in org.apache.hadoop.fs">FSDataOutputStreamBuilder</a> createFile(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</pre> |
| <div class="block">Create a new FSDataOutputStreamBuilder for the file with path. |
| Files are overwritten by default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - file path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FSDataOutputStreamBuilder object to build the file |
| |
| HADOOP-14384. Temporarily reduce the visibility of method before the |
| builder interface becomes stable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="appendFile-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appendFile</h4> |
| <pre>public <a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="class in org.apache.hadoop.fs">FSDataOutputStreamBuilder</a> appendFile(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path)</pre> |
| <div class="block">Create a Builder to append a file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - file path.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/hadoop/fs/FSDataOutputStreamBuilder.html" title="class in org.apache.hadoop.fs"><code>FSDataOutputStreamBuilder</code></a> to build file append request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="openFile-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openFile</h4> |
| <pre>@InterfaceStability.Unstable |
| public <a href="../../../../org/apache/hadoop/fs/FutureDataInputStreamBuilder.html" title="interface in org.apache.hadoop.fs">FutureDataInputStreamBuilder</a> openFile(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path) |
| 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>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre> |
| <div class="block">Open a file for reading through a builder API. |
| Ultimately calls <a href="../../../../org/apache/hadoop/fs/FileSystem.html#open-org.apache.hadoop.fs.Path-int-"><code>open(Path, int)</code></a> unless a subclass |
| executes the open command differently. |
| |
| The semantics of this call are therefore the same as that of |
| <a href="../../../../org/apache/hadoop/fs/FileSystem.html#open-org.apache.hadoop.fs.Path-int-"><code>open(Path, int)</code></a> with one special point: it is in |
| <code>FSDataInputStreamBuilder.build()</code> in which the open operation |
| takes place -it is there where all preconditions to the operation |
| are checked.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - file path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FSDataInputStreamBuilder object to build the input stream</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> - if some early checks cause IO failures.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if support is checked early.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="openFile-org.apache.hadoop.fs.PathHandle-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openFile</h4> |
| <pre>@InterfaceStability.Unstable |
| public <a href="../../../../org/apache/hadoop/fs/FutureDataInputStreamBuilder.html" title="interface in org.apache.hadoop.fs">FutureDataInputStreamBuilder</a> openFile(<a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a> pathHandle) |
| 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>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre> |
| <div class="block">Open a file for reading through a builder API. |
| Ultimately calls <a href="../../../../org/apache/hadoop/fs/FileSystem.html#open-org.apache.hadoop.fs.PathHandle-int-"><code>open(PathHandle, int)</code></a> unless a subclass |
| executes the open command differently. |
| |
| If PathHandles are unsupported, this may fail in the |
| <code>FSDataInputStreamBuilder.build()</code> command, |
| rather than in this <code>openFile()</code> operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathHandle</code> - path handle.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a FSDataInputStreamBuilder object to build the input stream</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> - if some early checks cause IO failures.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if support is checked early.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="openFileWithOptions-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.impl.OpenFileParameters-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openFileWithOptions</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a>> openFileWithOptions(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> path, |
| <a href="../../../../org/apache/hadoop/fs/impl/OpenFileParameters.html" title="class in org.apache.hadoop.fs.impl">OpenFileParameters</a> parameters) |
| 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">Execute the actual open file operation. |
| |
| This is invoked from <code>FSDataInputStreamBuilder.build()</code> |
| and from <code>DelegateToFileSystem</code> and is where |
| the action of opening the file should begin. |
| |
| The base implementation performs a blocking |
| call to <a href="../../../../org/apache/hadoop/fs/FileSystem.html#open-org.apache.hadoop.fs.Path-int-"><code>open(Path, int)</code></a> in this call; |
| the actual outcome is in the returned <code>CompletableFuture</code>. |
| This avoids having to create some thread pool, while still |
| setting up the expectation that the <code>get()</code> call |
| is needed to evaluate the result.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - path to the file</dd> |
| <dd><code>parameters</code> - open file parameters from the builder.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a future which will evaluate to the opened file.</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> - failure to resolve the link.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - unknown mandatory key</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="openFileWithOptions-org.apache.hadoop.fs.PathHandle-org.apache.hadoop.fs.impl.OpenFileParameters-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openFileWithOptions</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</a>> openFileWithOptions(<a href="../../../../org/apache/hadoop/fs/PathHandle.html" title="interface in org.apache.hadoop.fs">PathHandle</a> pathHandle, |
| <a href="../../../../org/apache/hadoop/fs/impl/OpenFileParameters.html" title="class in org.apache.hadoop.fs.impl">OpenFileParameters</a> parameters) |
| 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">Execute the actual open file operation. |
| The base implementation performs a blocking |
| call to <a href="../../../../org/apache/hadoop/fs/FileSystem.html#open-org.apache.hadoop.fs.Path-int-"><code>open(Path, int)</code></a> in this call; |
| the actual outcome is in the returned <code>CompletableFuture</code>. |
| This avoids having to create some thread pool, while still |
| setting up the expectation that the <code>get()</code> call |
| is needed to evaluate the result.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathHandle</code> - path to the file</dd> |
| <dd><code>parameters</code> - open file parameters from the builder.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a future which will evaluate to the opened file.</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> - failure to resolve the link.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - unknown mandatory key</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - PathHandles are not supported. |
| This may be deferred until the future is evaluated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createMultipartUploader-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createMultipartUploader</h4> |
| <pre>@InterfaceStability.Unstable |
| public <a href="../../../../org/apache/hadoop/fs/MultipartUploaderBuilder.html" title="interface in org.apache.hadoop.fs">MultipartUploaderBuilder</a> createMultipartUploader(<a href="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</a> basePath) |
| 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">Create a multipart uploader.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>basePath</code> - file path under which all files are uploaded</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a MultipartUploaderBuilder object to build the uploader</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> - if some early checks cause IO failures.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if support is checked early.</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/FileSystem.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/FileStatus.AttrFlags.html" title="enum in org.apache.hadoop.fs"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/fs/FileSystem.DirListingIterator.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/FileSystem.html" target="_top">Frames</a></li> |
| <li><a href="FileSystem.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="#field.summary">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><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <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> |
