blob: 34905fd29142cdd19fd21b0054aee14e87aab4d9 [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 -->
<title>org.apache.beam.sdk.io.fileschematransform (Apache Beam 2.47.0)</title>
<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.fileschematransform (Apache Beam 2.47.0)";
}
}
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/fs/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/fileschematransform/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">
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.io.fileschematransform</h1>
<div class="docSummary">
<div class="block">Defines transforms for File reading and writing support with Schema Transform.</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/fileschematransform/FileWriteSchemaTransformFormatProvider.html" title="interface in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformFormatProvider</a></td>
<td class="colLast">
<div class="block">Provides a <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that writes a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of <a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a>s and outputs a
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of the file names according to a registered <code>AutoService</code> <a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformFormatProvider.html" title="interface in org.apache.beam.sdk.io.fileschematransform"><code>FileWriteSchemaTransformFormatProvider</code></a>
implementation.</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/fileschematransform/AvroWriteSchemaTransformFormatProvider.html" title="class in org.apache.beam.sdk.io.fileschematransform">AvroWriteSchemaTransformFormatProvider</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformFormatProvider.html" title="interface in org.apache.beam.sdk.io.fileschematransform"><code>FileWriteSchemaTransformFormatProvider</code></a> for avro format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/CsvWriteSchemaTransformFormatProvider.html" title="class in org.apache.beam.sdk.io.fileschematransform">CsvWriteSchemaTransformFormatProvider</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformFormatProvider.html" title="interface in org.apache.beam.sdk.io.fileschematransform"><code>FileWriteSchemaTransformFormatProvider</code></a> for CSV format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformConfiguration</a></td>
<td class="colLast">
<div class="block">The configuration for building file writing transforms using <a href="../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransform.html" title="interface in org.apache.beam.sdk.schemas.transforms"><code>SchemaTransform</code></a> and <a href="../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.html" title="interface in org.apache.beam.sdk.schemas.transforms"><code>SchemaTransformProvider</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformConfiguration.Builder.html" title="class in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformConfiguration.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformConfiguration.CsvConfiguration.html" title="class in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformConfiguration.CsvConfiguration</a></td>
<td class="colLast">
<div class="block">Configures extra details related to writing CSV formatted files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformConfiguration.CsvConfiguration.Builder.html" title="class in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformConfiguration.CsvConfiguration.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformConfiguration.ParquetConfiguration.html" title="class in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformConfiguration.ParquetConfiguration</a></td>
<td class="colLast">
<div class="block">Configures extra details related to writing Parquet formatted files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformConfiguration.ParquetConfiguration.Builder.html" title="class in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformConfiguration.ParquetConfiguration.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformConfiguration.XmlConfiguration.html" title="class in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformConfiguration.XmlConfiguration</a></td>
<td class="colLast">
<div class="block">Configures extra details related to writing XML formatted files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformConfiguration.XmlConfiguration.Builder.html" title="class in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformConfiguration.XmlConfiguration.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformFormatProviders.html" title="class in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformFormatProviders</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformFormatProviders.html" title="class in org.apache.beam.sdk.io.fileschematransform"><code>FileWriteSchemaTransformFormatProviders</code></a> contains <a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformFormatProvider.html" title="interface in org.apache.beam.sdk.io.fileschematransform"><code>FileWriteSchemaTransformFormatProvider</code></a> implementations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformProvider.html" title="class in org.apache.beam.sdk.io.fileschematransform">FileWriteSchemaTransformProvider</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms"><code>TypedSchemaTransformProvider</code></a> implementation for writing a <a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a> <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> to file systems, driven by a <a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.fileschematransform"><code>FileWriteSchemaTransformConfiguration</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/JsonWriteSchemaTransformFormatProvider.html" title="class in org.apache.beam.sdk.io.fileschematransform">JsonWriteSchemaTransformFormatProvider</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformFormatProvider.html" title="interface in org.apache.beam.sdk.io.fileschematransform"><code>FileWriteSchemaTransformFormatProvider</code></a> for JSON format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/ParquetWriteSchemaTransformFormatProvider.html" title="class in org.apache.beam.sdk.io.fileschematransform">ParquetWriteSchemaTransformFormatProvider</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformFormatProvider.html" title="interface in org.apache.beam.sdk.io.fileschematransform"><code>FileWriteSchemaTransformFormatProvider</code></a> for Parquet format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/XmlWriteSchemaTransformFormatProvider.html" title="class in org.apache.beam.sdk.io.fileschematransform">XmlWriteSchemaTransformFormatProvider</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/io/fileschematransform/FileWriteSchemaTransformFormatProvider.html" title="interface in org.apache.beam.sdk.io.fileschematransform"><code>FileWriteSchemaTransformFormatProvider</code></a> for XML format.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.io.fileschematransform Description">Package org.apache.beam.sdk.io.fileschematransform Description</h2>
<div class="block">Defines transforms for File reading and writing support with Schema Transform.</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/fs/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/fileschematransform/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>