Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.8.0 / . / javadoc / 2.8.0 / org / apache / beam / sdk / io / fs / package-summary.html
blob: f6e1f5496c3f95fd1640a19b618b9ffdef8d86e0 [file] [log] [blame]
<!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_161-google-v7) on Thu Oct 18 16:14:37 PDT 2018 -->
<title>org.apache.beam.sdk.io.fs (Apache Beam 2.8.0-SNAPSHOT)</title>
<meta name="date" content="2018-10-18">
<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="org.apache.beam.sdk.io.fs (Apache Beam 2.8.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/elasticsearch/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/gcp/bigquery/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/fs/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<p>@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.io.fs</h1>
<div class="docSummary">
<div class="block">Apache Beam FileSystem interfaces and their default implementations.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/MoveOptions.html" title="interface in org.apache.beam.sdk.io.fs">MoveOptions</a></td>
<td class="colLast">
<div class="block">An object that configures <a href="../../../../../../org/apache/beam/sdk/io/FileSystems.html#copy-java.util.List-java.util.List-org.apache.beam.sdk.io.fs.MoveOptions...-"><code>FileSystems.copy(java.util.List&lt;org.apache.beam.sdk.io.fs.ResourceId&gt;, java.util.List&lt;org.apache.beam.sdk.io.fs.ResourceId&gt;, org.apache.beam.sdk.io.fs.MoveOptions...)</code></a>, <a href="../../../../../../org/apache/beam/sdk/io/FileSystems.html#rename-java.util.List-java.util.List-org.apache.beam.sdk.io.fs.MoveOptions...-"><code>FileSystems.rename(java.util.List&lt;org.apache.beam.sdk.io.fs.ResourceId&gt;, java.util.List&lt;org.apache.beam.sdk.io.fs.ResourceId&gt;, org.apache.beam.sdk.io.fs.MoveOptions...)</code></a>, and <a href="../../../../../../org/apache/beam/sdk/io/FileSystems.html#delete-java.util.Collection-org.apache.beam.sdk.io.fs.MoveOptions...-"><code>FileSystems.delete(java.util.Collection&lt;org.apache.beam.sdk.io.fs.ResourceId&gt;, org.apache.beam.sdk.io.fs.MoveOptions...)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/ResolveOptions.html" title="interface in org.apache.beam.sdk.io.fs">ResolveOptions</a></td>
<td class="colLast">
<div class="block">An object that configures <a href="../../../../../../org/apache/beam/sdk/io/fs/ResourceId.html#resolve-java.lang.String-org.apache.beam.sdk.io.fs.ResolveOptions-"><code>ResourceId.resolve(java.lang.String, org.apache.beam.sdk.io.fs.ResolveOptions)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a></td>
<td class="colLast">
<div class="block">An identifier which represents a file-like resource.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/CreateOptions.html" title="class in org.apache.beam.sdk.io.fs">CreateOptions</a></td>
<td class="colLast">
<div class="block">An abstract class that contains common configuration options for creating resources.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/CreateOptions.Builder.html" title="class in org.apache.beam.sdk.io.fs">CreateOptions.Builder</a>&lt;BuilderT extends <a href="../../../../../../org/apache/beam/sdk/io/fs/CreateOptions.Builder.html" title="class in org.apache.beam.sdk.io.fs">CreateOptions.Builder</a>&lt;BuilderT&gt;&gt;</td>
<td class="colLast">
<div class="block">An abstract builder for <a href="../../../../../../org/apache/beam/sdk/io/fs/CreateOptions.html" title="class in org.apache.beam.sdk.io.fs"><code>CreateOptions</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/CreateOptions.StandardCreateOptions.html" title="class in org.apache.beam.sdk.io.fs">CreateOptions.StandardCreateOptions</a></td>
<td class="colLast">
<div class="block">A standard configuration options with builder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/CreateOptions.StandardCreateOptions.Builder.html" title="class in org.apache.beam.sdk.io.fs">CreateOptions.StandardCreateOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder for <a href="../../../../../../org/apache/beam/sdk/io/fs/CreateOptions.StandardCreateOptions.html" title="class in org.apache.beam.sdk.io.fs"><code>CreateOptions.StandardCreateOptions</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/MatchResult.html" title="class in org.apache.beam.sdk.io.fs">MatchResult</a></td>
<td class="colLast">
<div class="block">The result of <a href="../../../../../../org/apache/beam/sdk/io/FileSystem.html#match-java.util.List-"><code>FileSystem.match(java.util.List&lt;java.lang.String&gt;)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/MatchResult.Metadata.html" title="class in org.apache.beam.sdk.io.fs">MatchResult.Metadata</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../../org/apache/beam/sdk/io/fs/MatchResult.Metadata.html" title="class in org.apache.beam.sdk.io.fs"><code>MatchResult.Metadata</code></a> of a matched file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/MatchResult.Metadata.Builder.html" title="class in org.apache.beam.sdk.io.fs">MatchResult.Metadata.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for <a href="../../../../../../org/apache/beam/sdk/io/fs/MatchResult.Metadata.html" title="class in org.apache.beam.sdk.io.fs"><code>MatchResult.Metadata</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/MetadataCoder.html" title="class in org.apache.beam.sdk.io.fs">MetadataCoder</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for <a href="../../../../../../org/apache/beam/sdk/io/fs/MatchResult.Metadata.html" title="class in org.apache.beam.sdk.io.fs"><code>MatchResult.Metadata</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/ResourceIdCoder.html" title="class in org.apache.beam.sdk.io.fs">ResourceIdCoder</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for <a href="../../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs"><code>ResourceId</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/ResourceIdTester.html" title="class in org.apache.beam.sdk.io.fs">ResourceIdTester</a></td>
<td class="colLast">
<div class="block">A utility to test <a href="../../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs"><code>ResourceId</code></a> implementations.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/EmptyMatchTreatment.html" title="enum in org.apache.beam.sdk.io.fs">EmptyMatchTreatment</a></td>
<td class="colLast">
<div class="block">Options for allowing or disallowing filepatterns that match no resources in <a href="../../../../../../org/apache/beam/sdk/io/FileSystems.html#match-java.util.List-"><code>FileSystems.match(java.util.List&lt;java.lang.String&gt;)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/MatchResult.Status.html" title="enum in org.apache.beam.sdk.io.fs">MatchResult.Status</a></td>
<td class="colLast">
<div class="block">Status of a <a href="../../../../../../org/apache/beam/sdk/io/fs/MatchResult.html" title="class in org.apache.beam.sdk.io.fs"><code>MatchResult</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/MoveOptions.StandardMoveOptions.html" title="enum in org.apache.beam.sdk.io.fs">MoveOptions.StandardMoveOptions</a></td>
<td class="colLast">
<div class="block">Defines the standard <a href="../../../../../../org/apache/beam/sdk/io/fs/MoveOptions.html" title="interface in org.apache.beam.sdk.io.fs"><code>MoveOptions</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fs/ResolveOptions.StandardResolveOptions.html" title="enum in org.apache.beam.sdk.io.fs">ResolveOptions.StandardResolveOptions</a></td>
<td class="colLast">
<div class="block">Defines the standard resolve options.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.io.fs Description">Package org.apache.beam.sdk.io.fs Description</h2>
<div class="block">Apache Beam FileSystem interfaces and their default implementations.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/elasticsearch/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/gcp/bigquery/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/fs/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>