blob: 0247af3a26ebe636c866b88bd5f60eab9fd931b1 [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>TextJsonTable (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="TextJsonTable (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><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>Prev&nbsp;Class</li>
<li><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.text"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/meta/provider/text/TextJsonTable.html" target="_top">Frames</a></li>
<li><a href="TextJsonTable.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.SchemaBaseBeamTable">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTable">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</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.extensions.sql.meta.provider.text</div>
<h2 title="Class TextJsonTable" class="title">Class TextJsonTable</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BaseBeamTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta">org.apache.beam.sdk.extensions.sql.meta.BaseBeamTable</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/SchemaBaseBeamTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta">org.apache.beam.sdk.extensions.sql.meta.SchemaBaseBeamTable</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.text">org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTable</a></li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.sql.meta.provider.text.TextJsonTable</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql.meta">BeamSqlTable</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a>
public class <span class="typeNameLabel">TextJsonTable</span>
extends <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.text">TextTable</a></pre>
<div class="block"><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextJsonTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.text"><code>TextJsonTable</code></a> is a <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BeamSqlTable.html" title="interface in org.apache.beam.sdk.extensions.sql.meta"><code>BeamSqlTable</code></a> that reads text files and converts them according
to the JSON format.
<p>Support format is <code>"json"</code>.
<p>Check <a href="https://static.javadoc.io/com.fasterxml.jackson.core/jackson-databind/2.14.1/com/fasterxml/jackson/databind/ObjectMapper.html?is-external=true" title="class or interface in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> javadoc for more info on reading and writing JSON.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../../serialized-form.html#org.apache.beam.sdk.extensions.sql.meta.provider.text.TextJsonTable">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.SchemaBaseBeamTable">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.beam.sdk.extensions.sql.meta.<a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/SchemaBaseBeamTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta">SchemaBaseBeamTable</a></h3>
<code><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/SchemaBaseBeamTable.html#schema">schema</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</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/extensions/sql/meta/provider/text/TextJsonTable.html#TextJsonTable-org.apache.beam.sdk.schemas.Schema-java.lang.String-org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTableProvider.JsonToRow-org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTableProvider.RowToJson-">TextJsonTable</a></span>(<a href="../../../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;schema,
java.lang.String&nbsp;filePattern,
org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTableProvider.JsonToRow&nbsp;readConverter,
org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTableProvider.RowToJson&nbsp;writerConverter)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.extensions.sql.meta.provider.text.<a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.text">TextTable</a></h3>
<code><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html#buildIOReader-org.apache.beam.sdk.values.PBegin-">buildIOReader</a>, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html#buildIOWriter-org.apache.beam.sdk.values.PCollection-">buildIOWriter</a>, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html#getFilePattern--">getFilePattern</a>, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html#getTableStatistics-org.apache.beam.sdk.options.PipelineOptions-">getTableStatistics</a>, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html#isBounded--">isBounded</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.SchemaBaseBeamTable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.extensions.sql.meta.<a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/SchemaBaseBeamTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta">SchemaBaseBeamTable</a></h3>
<code><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/SchemaBaseBeamTable.html#getSchema--">getSchema</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.BaseBeamTable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.extensions.sql.meta.<a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BaseBeamTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta">BaseBeamTable</a></h3>
<code><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BaseBeamTable.html#buildIOReader-org.apache.beam.sdk.values.PBegin-org.apache.beam.sdk.extensions.sql.meta.BeamSqlTableFilter-java.util.List-">buildIOReader</a>, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BaseBeamTable.html#constructFilter-java.util.List-">constructFilter</a>, <a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/BaseBeamTable.html#supportsProjects--">supportsProjects</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&nbsp;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="TextJsonTable-org.apache.beam.sdk.schemas.Schema-java.lang.String-org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTableProvider.JsonToRow-org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTableProvider.RowToJson-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TextJsonTable</h4>
<pre>public&nbsp;TextJsonTable(<a href="../../../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;schema,
java.lang.String&nbsp;filePattern,
org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTableProvider.JsonToRow&nbsp;readConverter,
org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTableProvider.RowToJson&nbsp;writerConverter)</pre>
</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>Prev&nbsp;Class</li>
<li><a href="../../../../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/text/TextTable.html" title="class in org.apache.beam.sdk.extensions.sql.meta.provider.text"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/meta/provider/text/TextJsonTable.html" target="_top">Frames</a></li>
<li><a href="TextJsonTable.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.SchemaBaseBeamTable">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.apache.beam.sdk.extensions.sql.meta.provider.text.TextTable">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>