| <!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_181-google-v7) on Mon Jan 27 16:42:32 PST 2020 --> |
| <title>FileSystem (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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 Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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/beam/sdk/io/FileIO.Write.FileNaming.html" title="interface in org.apache.beam.sdk.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/io/FileSystemRegistrar.html" title="interface in org.apache.beam.sdk.io"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/io/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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.io</div> |
| <h2 title="Class FileSystem" class="title">Class FileSystem<ResourceIdT extends <a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.FileSystem<ResourceIdT></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#FILESYSTEM">FILESYSTEM</a>) |
| public abstract class <span class="typeNameLabel">FileSystem<ResourceIdT extends <a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>></span> |
| extends java.lang.Object</pre> |
| <div class="block">File system interface in Beam. |
| |
| <p>It defines APIs for writing file systems agnostic code. |
| |
| <p>All methods are protected, and they are for file system providers to implement. Clients should |
| use the <a href="../../../../../org/apache/beam/sdk/io/FileSystems.html" title="class in org.apache.beam.sdk.io"><code>FileSystems</code></a> utility.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/FileSystem.html#copy-java.util.List-java.util.List-">copy</a></span>(java.util.List<<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a>> srcResourceIds, |
| java.util.List<<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a>> destResourceIds)</code> |
| <div class="block">Copies a <code>List</code> of file-like resources from one location to another.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected abstract java.nio.channels.WritableByteChannel</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/FileSystem.html#create-ResourceIdT-org.apache.beam.sdk.io.fs.CreateOptions-">create</a></span>(<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a> resourceId, |
| <a href="../../../../../org/apache/beam/sdk/io/fs/CreateOptions.html" title="class in org.apache.beam.sdk.io.fs">CreateOptions</a> createOptions)</code> |
| <div class="block">Returns a write channel for the given <code>ResourceIdT</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/FileSystem.html#delete-java.util.Collection-">delete</a></span>(java.util.Collection<<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a>> resourceIds)</code> |
| <div class="block">Deletes a collection of resources.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected abstract java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/FileSystem.html#getScheme--">getScheme</a></span>()</code> |
| <div class="block">Get the URI scheme which defines the namespace of the <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="class in org.apache.beam.sdk.io"><code>FileSystem</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected abstract java.util.List<<a href="../../../../../org/apache/beam/sdk/io/fs/MatchResult.html" title="class in org.apache.beam.sdk.io.fs">MatchResult</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/FileSystem.html#match-java.util.List-">match</a></span>(java.util.List<java.lang.String> specs)</code> |
| <div class="block">This is the entry point to convert user-provided specs to <code>ResourceIds</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/FileSystem.html#matchNewResource-java.lang.String-boolean-">matchNewResource</a></span>(java.lang.String singleResourceSpec, |
| boolean isDirectory)</code> |
| <div class="block">Returns a new <a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs"><code>ResourceId</code></a> for this filesystem that represents the named resource.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected abstract java.nio.channels.ReadableByteChannel</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/FileSystem.html#open-ResourceIdT-">open</a></span>(<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a> resourceId)</code> |
| <div class="block">Returns a read channel for the given <code>ResourceIdT</code>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/FileSystem.html#rename-java.util.List-java.util.List-">rename</a></span>(java.util.List<<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a>> srcResourceIds, |
| java.util.List<<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a>> destResourceIds)</code> |
| <div class="block">Renames a <code>List</code> of file-like resources from one location to another.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FileSystem--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FileSystem</h4> |
| <pre>public 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="match-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>match</h4> |
| <pre>protected abstract java.util.List<<a href="../../../../../org/apache/beam/sdk/io/fs/MatchResult.html" title="class in org.apache.beam.sdk.io.fs">MatchResult</a>> match(java.util.List<java.lang.String> specs) |
| throws java.io.IOException</pre> |
| <div class="block">This is the entry point to convert user-provided specs to <code>ResourceIds</code>. |
| Callers should use <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html#match-java.util.List-"><code>match(java.util.List<java.lang.String>)</code></a> to resolve users specs ambiguities before calling other |
| methods. |
| |
| <p>Implementation should handle the following ambiguities of a user-provided spec: |
| |
| <ol> |
| <li><code>spec</code> could be a glob or a uri. <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html#match-java.util.List-"><code>match(java.util.List<java.lang.String>)</code></a> should be able to tell and choose |
| efficient implementations. |
| <li>The user-provided <code>spec</code> might refer to files or directories. It is common that |
| users that wish to indicate a directory will omit the trailing <code>/</code>, such as in a |
| spec of <code>"/tmp/dir"</code>. The <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="class in org.apache.beam.sdk.io"><code>FileSystem</code></a> should be able to recognize a |
| directory with the trailing <code>/</code> omitted, but should always return a correct <code>ResourceIdT</code> (e.g., <code>"/tmp/dir/"</code> inside the returned <a href="../../../../../org/apache/beam/sdk/io/fs/MatchResult.html" title="class in org.apache.beam.sdk.io.fs"><code>MatchResult</code></a>. |
| </ol> |
| |
| <p>All <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="class in org.apache.beam.sdk.io"><code>FileSystem</code></a> implementations should support glob in the final hierarchical path |
| component of <code>ResourceIdT</code>. This allows SDK libraries to construct file system agnostic |
| spec. <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="class in org.apache.beam.sdk.io"><code>FileSystems</code></a> can support additional patterns for user-provided specs.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>List<MatchResult></code> in the same order of the input specs.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if specs are invalid.</dd> |
| <dd><code>java.io.IOException</code> - if all specs failed to match due to issues like: network connection, |
| authorization. Exception for individual spec need to be deferred until callers retrieve |
| metadata with <a href="../../../../../org/apache/beam/sdk/io/fs/MatchResult.html#metadata--"><code>MatchResult.metadata()</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-org.apache.beam.sdk.io.fs.ResourceId-org.apache.beam.sdk.io.fs.CreateOptions-"> |
| <!-- --> |
| </a><a name="create-ResourceIdT-org.apache.beam.sdk.io.fs.CreateOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>protected abstract java.nio.channels.WritableByteChannel create(<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a> resourceId, |
| <a href="../../../../../org/apache/beam/sdk/io/fs/CreateOptions.html" title="class in org.apache.beam.sdk.io.fs">CreateOptions</a> createOptions) |
| throws java.io.IOException</pre> |
| <div class="block">Returns a write channel for the given <code>ResourceIdT</code>. |
| |
| <p>The resource is not expanded; it is used verbatim.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resourceId</code> - the reference of the file-like resource to create</dd> |
| <dd><code>createOptions</code> - the configuration of the create operation</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="open-org.apache.beam.sdk.io.fs.ResourceId-"> |
| <!-- --> |
| </a><a name="open-ResourceIdT-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>protected abstract java.nio.channels.ReadableByteChannel open(<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a> resourceId) |
| throws java.io.IOException</pre> |
| <div class="block">Returns a read channel for the given <code>ResourceIdT</code>. |
| |
| <p>The resource is not expanded; it is used verbatim. |
| |
| <p>If seeking is supported, then this returns a <code>SeekableByteChannel</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resourceId</code> - the reference of the file-like resource to open</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copy-java.util.List-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>protected abstract void copy(java.util.List<<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a>> srcResourceIds, |
| java.util.List<<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a>> destResourceIds) |
| throws java.io.IOException</pre> |
| <div class="block">Copies a <code>List</code> of file-like resources from one location to another. |
| |
| <p>The number of source resources must equal the number of destination resources. Destination |
| resources will be created recursively.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srcResourceIds</code> - the references of the source resources</dd> |
| <dd><code>destResourceIds</code> - the references of the destination resources</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.FileNotFoundException</code> - if the source resources are missing. When copy throws, each |
| resource might or might not be copied. In such scenarios, callers can use <code>match()</code> |
| to determine the state of the resources.</dd> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rename-java.util.List-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rename</h4> |
| <pre>protected abstract void rename(java.util.List<<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a>> srcResourceIds, |
| java.util.List<<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a>> destResourceIds) |
| throws java.io.IOException</pre> |
| <div class="block">Renames a <code>List</code> of file-like resources from one location to another. |
| |
| <p>The number of source resources must equal the number of destination resources. Destination |
| resources will be created recursively.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srcResourceIds</code> - the references of the source resources</dd> |
| <dd><code>destResourceIds</code> - the references of the destination resources</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.FileNotFoundException</code> - if the source resources are missing. When rename throws, the |
| state of the resources is unknown but safe: for every (source, destination) pair of |
| resources, the following are possible: a) source exists, b) destination exists, c) source |
| and destination both exist. Thus no data is lost, however, duplicated resource are |
| possible. In such scenarios, callers can use <code>match()</code> to determine the state of the |
| resource.</dd> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="delete-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre>protected abstract void delete(java.util.Collection<<a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a>> resourceIds) |
| throws java.io.IOException</pre> |
| <div class="block">Deletes a collection of resources.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resourceIds</code> - the references of the resources to delete.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.FileNotFoundException</code> - if resources are missing. When delete throws, each resource might |
| or might not be deleted. In such scenarios, callers can use <code>match()</code> to determine |
| the state of the resources.</dd> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="matchNewResource-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>matchNewResource</h4> |
| <pre>protected abstract <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="type parameter in FileSystem">ResourceIdT</a> matchNewResource(java.lang.String singleResourceSpec, |
| boolean isDirectory)</pre> |
| <div class="block">Returns a new <a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs"><code>ResourceId</code></a> for this filesystem that represents the named resource. The |
| user supplies both the resource spec and whether it is a directory. |
| |
| <p>The supplied <code>singleResourceSpec</code> is expected to be in a proper format, including any |
| necessary escaping, for this <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="class in org.apache.beam.sdk.io"><code>FileSystem</code></a>. |
| |
| <p>This function may throw an <code>IllegalArgumentException</code> if given an invalid argument, |
| such as when the specified <code>singleResourceSpec</code> is not a valid resource name.</div> |
| </li> |
| </ul> |
| <a name="getScheme--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getScheme</h4> |
| <pre>protected abstract java.lang.String getScheme()</pre> |
| <div class="block">Get the URI scheme which defines the namespace of the <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="class in org.apache.beam.sdk.io"><code>FileSystem</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a></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="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/beam/sdk/io/FileIO.Write.FileNaming.html" title="interface in org.apache.beam.sdk.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/io/FileSystemRegistrar.html" title="interface in org.apache.beam.sdk.io"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/io/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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
