blob: eb86c71c57f642b58c3ee8cdddeea2ad76e8b939 [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>EncoderHelpers (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="EncoderHelpers (Apache Beam 2.47.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":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/EncoderFactory.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/EncoderHelpers.Utils.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/EncoderHelpers.html" target="_top">Frames</a></li>
<li><a href="EncoderHelpers.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><a href="#nested.class.summary">Nested</a>&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 EncoderHelpers" class="title">Class EncoderHelpers</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.EncoderHelpers</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">EncoderHelpers</span>
extends java.lang.Object</pre>
<div class="block"><code>Encoders</code> utility class.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.Utils.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.helpers">EncoderHelpers.Utils</a></span></code>
<div class="block">Encoder / expression utils that are called from generated code.</div>
</td>
</tr>
</table>
</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/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#EncoderHelpers--">EncoderHelpers</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.sql.Encoder&lt;java.util.Collection&lt;T&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#collectionEncoder-org.apache.spark.sql.Encoder-">collectionEncoder</a></span>(org.apache.spark.sql.Encoder&lt;T&gt;&nbsp;enc)</code>
<div class="block">Creates a Spark <code>Encoder</code> of <code>ArrayType</code> for Java <code>Collection</code>s with nullable
elements.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;org.apache.spark.sql.Encoder&lt;java.util.Collection&lt;T&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#collectionEncoder-org.apache.spark.sql.Encoder-boolean-">collectionEncoder</a></span>(org.apache.spark.sql.Encoder&lt;T&gt;&nbsp;enc,
boolean&nbsp;nullable)</code>
<div class="block">Creates a Spark <code>Encoder</code> of <code>ArrayType</code> for Java <code>Collection</code>s.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;org.apache.spark.sql.catalyst.expressions.Expression</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#deserializeOneOf-org.apache.spark.sql.catalyst.expressions.Expression-java.util.List-">deserializeOneOf</a></span>(org.apache.spark.sql.catalyst.expressions.Expression&nbsp;in,
java.util.List&lt;org.apache.spark.sql.Encoder&lt;T&gt;&gt;&nbsp;encoders)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;org.apache.spark.sql.Encoder&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#encoderFor-org.apache.beam.sdk.coders.Coder-">encoderFor</a></span>(<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">Creates a Spark <code>Encoder</code> for <code>T</code> of <code>BinaryType</code>
delegating to a Beam <a href="../../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> underneath.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;org.apache.spark.sql.Encoder&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#encoderOf-java.lang.Class-">encoderOf</a></span>(java.lang.Class&lt;? super T&gt;&nbsp;cls)</code>
<div class="block">Gets or creates a default <code>Encoder</code> for <code>T</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static &lt;K,V&gt;&nbsp;org.apache.spark.sql.Encoder&lt;<a href="../../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#kvEncoder-org.apache.spark.sql.Encoder-org.apache.spark.sql.Encoder-">kvEncoder</a></span>(org.apache.spark.sql.Encoder&lt;K&gt;&nbsp;key,
org.apache.spark.sql.Encoder&lt;V&gt;&nbsp;value)</code>
<div class="block">Creates a Spark <code>Encoder</code> for <a href="../../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a> of <code>StructType</code> with fields <code>key</code>
and <code>value</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static &lt;MapT extends java.util.Map&lt;K,V&gt;,K,V&gt;<br>org.apache.spark.sql.Encoder&lt;MapT&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#mapEncoder-org.apache.spark.sql.Encoder-org.apache.spark.sql.Encoder-java.lang.Class-">mapEncoder</a></span>(org.apache.spark.sql.Encoder&lt;K&gt;&nbsp;key,
org.apache.spark.sql.Encoder&lt;V&gt;&nbsp;value,
java.lang.Class&lt;MapT&gt;&nbsp;cls)</code>
<div class="block">Creates a Spark <code>Encoder</code> of <code>MapType</code> that deserializes to <code>MapT</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static &lt;T1,T2&gt;&nbsp;org.apache.spark.sql.Encoder&lt;org.apache.spark.util.MutablePair&lt;T1,T2&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#mutablePairEncoder-org.apache.spark.sql.Encoder-org.apache.spark.sql.Encoder-">mutablePairEncoder</a></span>(org.apache.spark.sql.Encoder&lt;T1&gt;&nbsp;enc1,
org.apache.spark.sql.Encoder&lt;T2&gt;&nbsp;enc2)</code>
<div class="block">Creates a Spark <code>Encoder</code> for Spark's <code>MutablePair</code> of <code>StructType</code> with
fields `<code>_1</code>` and `<code>_2</code>`.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;org.apache.spark.sql.Encoder&lt;scala.Tuple2&lt;java.lang.Integer,T&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#oneOfEncoder-java.util.List-">oneOfEncoder</a></span>(java.util.List&lt;org.apache.spark.sql.Encoder&lt;T&gt;&gt;&nbsp;encoders)</code>
<div class="block">Creates a one-of Spark <code>Encoder</code> of <code>StructType</code> where each alternative is
represented as colum / field named by its index with a separate <code>Encoder</code> each.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;org.apache.spark.sql.catalyst.expressions.Expression</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderHelpers.html#serializeOneOf-org.apache.spark.sql.catalyst.expressions.Expression-java.util.List-">serializeOneOf</a></span>(org.apache.spark.sql.catalyst.expressions.Expression&nbsp;in,
java.util.List&lt;org.apache.spark.sql.Encoder&lt;T&gt;&gt;&nbsp;encoders)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static &lt;T,W extends <a href="../../../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&gt;<br>org.apache.spark.sql.Encoder&lt;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/EncoderHelpers.html#windowedValueEncoder-org.apache.spark.sql.Encoder-org.apache.spark.sql.Encoder-">windowedValueEncoder</a></span>(org.apache.spark.sql.Encoder&lt;T&gt;&nbsp;value,
org.apache.spark.sql.Encoder&lt;W&gt;&nbsp;window)</code>
<div class="block">Creates a Spark <code>Encoder</code> for <code>T</code> of <code>StructType</code> with fields <code>value</code>,
<code>timestamp</code>, <code>windows</code> and <code>pane</code>.</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="EncoderHelpers--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EncoderHelpers</h4>
<pre>public&nbsp;EncoderHelpers()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="encoderOf-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encoderOf</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;org.apache.spark.sql.Encoder&lt;T&gt;&nbsp;encoderOf(java.lang.Class&lt;? super T&gt;&nbsp;cls)</pre>
<div class="block">Gets or creates a default <code>Encoder</code> for <code>T</code>.</div>
</li>
</ul>
<a name="encoderFor-org.apache.beam.sdk.coders.Coder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encoderFor</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;org.apache.spark.sql.Encoder&lt;T&gt;&nbsp;encoderFor(<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">Creates a Spark <code>Encoder</code> for <code>T</code> of <code>BinaryType</code>
delegating to a Beam <a href="../../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> underneath.
<p>Note: For common types, if available, default Spark <code>Encoder</code>s are used instead.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>coder</code> - Beam <a href="../../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a></dd>
</dl>
</li>
</ul>
<a name="windowedValueEncoder-org.apache.spark.sql.Encoder-org.apache.spark.sql.Encoder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>windowedValueEncoder</h4>
<pre>public static&nbsp;&lt;T,W extends <a href="../../../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&gt;&nbsp;org.apache.spark.sql.Encoder&lt;org.apache.beam.sdk.util.WindowedValue&lt;T&gt;&gt;&nbsp;windowedValueEncoder(org.apache.spark.sql.Encoder&lt;T&gt;&nbsp;value,
org.apache.spark.sql.Encoder&lt;W&gt;&nbsp;window)</pre>
<div class="block">Creates a Spark <code>Encoder</code> for <code>T</code> of <code>StructType</code> with fields <code>value</code>,
<code>timestamp</code>, <code>windows</code> and <code>pane</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - <code>Encoder</code> to encode field `<code>value</code>`.</dd>
<dd><code>window</code> - <code>Encoder</code> to encode individual windows in field `<code>windows</code>`</dd>
</dl>
</li>
</ul>
<a name="oneOfEncoder-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>oneOfEncoder</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;org.apache.spark.sql.Encoder&lt;scala.Tuple2&lt;java.lang.Integer,T&gt;&gt;&nbsp;oneOfEncoder(java.util.List&lt;org.apache.spark.sql.Encoder&lt;T&gt;&gt;&nbsp;encoders)</pre>
<div class="block">Creates a one-of Spark <code>Encoder</code> of <code>StructType</code> where each alternative is
represented as colum / field named by its index with a separate <code>Encoder</code> each.
<p>Externally this is represented as tuple <code>(index, data)</code> where an index corresponds to
an <code>Encoder</code> in the provided list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>encoders</code> - <code>Encoder</code>s for each alternative.</dd>
</dl>
</li>
</ul>
<a name="kvEncoder-org.apache.spark.sql.Encoder-org.apache.spark.sql.Encoder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>kvEncoder</h4>
<pre>public static&nbsp;&lt;K,V&gt;&nbsp;org.apache.spark.sql.Encoder&lt;<a href="../../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V&gt;&gt;&nbsp;kvEncoder(org.apache.spark.sql.Encoder&lt;K&gt;&nbsp;key,
org.apache.spark.sql.Encoder&lt;V&gt;&nbsp;value)</pre>
<div class="block">Creates a Spark <code>Encoder</code> for <a href="../../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a> of <code>StructType</code> with fields <code>key</code>
and <code>value</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - <code>Encoder</code> to encode field `<code>key</code>`.</dd>
<dd><code>value</code> - <code>Encoder</code> to encode field `<code>value</code>`</dd>
</dl>
</li>
</ul>
<a name="collectionEncoder-org.apache.spark.sql.Encoder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectionEncoder</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;org.apache.spark.sql.Encoder&lt;java.util.Collection&lt;T&gt;&gt;&nbsp;collectionEncoder(org.apache.spark.sql.Encoder&lt;T&gt;&nbsp;enc)</pre>
<div class="block">Creates a Spark <code>Encoder</code> of <code>ArrayType</code> for Java <code>Collection</code>s with nullable
elements.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enc</code> - <code>Encoder</code> to encode collection elements</dd>
</dl>
</li>
</ul>
<a name="collectionEncoder-org.apache.spark.sql.Encoder-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectionEncoder</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;org.apache.spark.sql.Encoder&lt;java.util.Collection&lt;T&gt;&gt;&nbsp;collectionEncoder(org.apache.spark.sql.Encoder&lt;T&gt;&nbsp;enc,
boolean&nbsp;nullable)</pre>
<div class="block">Creates a Spark <code>Encoder</code> of <code>ArrayType</code> for Java <code>Collection</code>s.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enc</code> - <code>Encoder</code> to encode collection elements</dd>
<dd><code>nullable</code> - Allow nullable collection elements</dd>
</dl>
</li>
</ul>
<a name="mapEncoder-org.apache.spark.sql.Encoder-org.apache.spark.sql.Encoder-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mapEncoder</h4>
<pre>public static&nbsp;&lt;MapT extends java.util.Map&lt;K,V&gt;,K,V&gt;&nbsp;org.apache.spark.sql.Encoder&lt;MapT&gt;&nbsp;mapEncoder(org.apache.spark.sql.Encoder&lt;K&gt;&nbsp;key,
org.apache.spark.sql.Encoder&lt;V&gt;&nbsp;value,
java.lang.Class&lt;MapT&gt;&nbsp;cls)</pre>
<div class="block">Creates a Spark <code>Encoder</code> of <code>MapType</code> that deserializes to <code>MapT</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - <code>Encoder</code> to encode keys</dd>
<dd><code>value</code> - <code>Encoder</code> to encode values</dd>
<dd><code>cls</code> - Specific class to use, supported are <code>HashMap</code> and <code>TreeMap</code></dd>
</dl>
</li>
</ul>
<a name="mutablePairEncoder-org.apache.spark.sql.Encoder-org.apache.spark.sql.Encoder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mutablePairEncoder</h4>
<pre>public static&nbsp;&lt;T1,T2&gt;&nbsp;org.apache.spark.sql.Encoder&lt;org.apache.spark.util.MutablePair&lt;T1,T2&gt;&gt;&nbsp;mutablePairEncoder(org.apache.spark.sql.Encoder&lt;T1&gt;&nbsp;enc1,
org.apache.spark.sql.Encoder&lt;T2&gt;&nbsp;enc2)</pre>
<div class="block">Creates a Spark <code>Encoder</code> for Spark's <code>MutablePair</code> of <code>StructType</code> with
fields `<code>_1</code>` and `<code>_2</code>`.
<p>This is intended to be used in places such as aggregators.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enc1</code> - <code>Encoder</code> to encode `<code>_1</code>`</dd>
<dd><code>enc2</code> - <code>Encoder</code> to encode `<code>_2</code>`</dd>
</dl>
</li>
</ul>
<a name="serializeOneOf-org.apache.spark.sql.catalyst.expressions.Expression-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeOneOf</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;org.apache.spark.sql.catalyst.expressions.Expression&nbsp;serializeOneOf(org.apache.spark.sql.catalyst.expressions.Expression&nbsp;in,
java.util.List&lt;org.apache.spark.sql.Encoder&lt;T&gt;&gt;&nbsp;encoders)</pre>
</li>
</ul>
<a name="deserializeOneOf-org.apache.spark.sql.catalyst.expressions.Expression-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>deserializeOneOf</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;org.apache.spark.sql.catalyst.expressions.Expression&nbsp;deserializeOneOf(org.apache.spark.sql.catalyst.expressions.Expression&nbsp;in,
java.util.List&lt;org.apache.spark.sql.Encoder&lt;T&gt;&gt;&nbsp;encoders)</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><a href="../../../../../../../../org/apache/beam/runners/spark/structuredstreaming/translation/helpers/EncoderFactory.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/EncoderHelpers.Utils.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/EncoderHelpers.html" target="_top">Frames</a></li>
<li><a href="EncoderHelpers.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><a href="#nested.class.summary">Nested</a>&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>