blob: 83fcbf8cf76b2e615fa6e28dcad040bedd9f77d3 [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>RowHelpers (Apache Beam 2.38.0-SNAPSHOT)</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="RowHelpers (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/runners/spark/structuredstreaming/translation/helpers/MultiOutputCoder.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.helpers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/SchemaHelpers.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.helpers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/beam/runners/spark/structuredstreaming/translation/helpers/RowHelpers.html" target="_top">Frames</a></li>
<li><a href="RowHelpers.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">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><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.runners.spark.structuredstreaming.translation.helpers</div>
<h2 title="Class RowHelpers" class="title">Class RowHelpers</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.runners.spark.structuredstreaming.translation.helpers.RowHelpers</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">RowHelpers</span>
extends java.lang.Object</pre>
<div class="block">Helper functions for working with <code>Row</code>.</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">&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/runners/spark/structuredstreaming/translation/helpers/RowHelpers.html#RowHelpers--">RowHelpers</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>static &lt;T&gt;&nbsp;org.apache.spark.api.java.function.MapFunction&lt;org.apache.spark.sql.Row,org.apache.beam.sdk.util.WindowedValue&lt;T&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/RowHelpers.html#extractWindowedValueFromRowMapFunction-org.apache.beam.sdk.util.WindowedValue.WindowedValueCoder-">extractWindowedValueFromRowMapFunction</a></span>(org.apache.beam.sdk.util.WindowedValue.WindowedValueCoder&lt;T&gt;&nbsp;windowedValueCoder)</code>
<div class="block">A Spark <code>MapFunction</code> for extracting a <code>WindowedValue</code> from a Row in which the
<code>WindowedValue</code> was serialized to bytes using its <code>WindowedValue.WindowedValueCoder</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;org.apache.spark.sql.catalyst.InternalRow</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/RowHelpers.html#storeWindowedValueInRow-org.apache.beam.sdk.util.WindowedValue-org.apache.beam.sdk.coders.Coder-">storeWindowedValueInRow</a></span>(org.apache.beam.sdk.util.WindowedValue&lt;T&gt;&nbsp;windowedValue,
<a href="../../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;T&gt;&nbsp;coder)</code>
<div class="block">Serialize a windowedValue to bytes using windowedValueCoder <code>WindowedValue.FullWindowedValueCoder</code> and stores it an InternalRow.</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&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="RowHelpers--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RowHelpers</h4>
<pre>public&nbsp;RowHelpers()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="extractWindowedValueFromRowMapFunction-org.apache.beam.sdk.util.WindowedValue.WindowedValueCoder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractWindowedValueFromRowMapFunction</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;org.apache.spark.api.java.function.MapFunction&lt;org.apache.spark.sql.Row,org.apache.beam.sdk.util.WindowedValue&lt;T&gt;&gt;&nbsp;extractWindowedValueFromRowMapFunction(org.apache.beam.sdk.util.WindowedValue.WindowedValueCoder&lt;T&gt;&nbsp;windowedValueCoder)</pre>
<div class="block">A Spark <code>MapFunction</code> for extracting a <code>WindowedValue</code> from a Row in which the
<code>WindowedValue</code> was serialized to bytes using its <code>WindowedValue.WindowedValueCoder</code>.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The type of the object.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <code>MapFunction</code> that accepts a <code>Row</code> and returns its <code>WindowedValue</code>.</dd>
</dl>
</li>
</ul>
<a name="storeWindowedValueInRow-org.apache.beam.sdk.util.WindowedValue-org.apache.beam.sdk.coders.Coder-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>storeWindowedValueInRow</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;org.apache.spark.sql.catalyst.InternalRow&nbsp;storeWindowedValueInRow(org.apache.beam.sdk.util.WindowedValue&lt;T&gt;&nbsp;windowedValue,
<a href="../../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;T&gt;&nbsp;coder)</pre>
<div class="block">Serialize a windowedValue to bytes using windowedValueCoder <code>WindowedValue.FullWindowedValueCoder</code> and stores it an InternalRow.</div>
</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/runners/spark/structuredstreaming/translation/helpers/MultiOutputCoder.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.helpers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/SchemaHelpers.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.helpers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/beam/runners/spark/structuredstreaming/translation/helpers/RowHelpers.html" target="_top">Frames</a></li>
<li><a href="RowHelpers.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">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><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>