blob: 7e763c6fc509ce5273fc97f8460843043f2f5bbb [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>Join (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="Join (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.FullOuterJoin.html" title="class in org.apache.beam.sdk.extensions.joinlibrary"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/joinlibrary/Join.html" target="_top">Frames</a></li>
<li><a href="Join.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.sdk.extensions.joinlibrary</div>
<h2 title="Class Join" class="title">Class Join</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.joinlibrary.Join</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Join</span>
extends java.lang.Object</pre>
<div class="block">Utility class with different versions of joins. All methods join two collections of key/value
pairs (KV).</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/sdk/extensions/joinlibrary/Join.FullOuterJoin.html" title="class in org.apache.beam.sdk.extensions.joinlibrary">Join.FullOuterJoin</a>&lt;<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.FullOuterJoin.html" title="type parameter in Join.FullOuterJoin">K</a>,<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.FullOuterJoin.html" title="type parameter in Join.FullOuterJoin">V1</a>,<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.FullOuterJoin.html" title="type parameter in Join.FullOuterJoin">V2</a>&gt;</span></code>
<div class="block">PTransform representing a full outer join of two collections of KV elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.InnerJoin.html" title="class in org.apache.beam.sdk.extensions.joinlibrary">Join.InnerJoin</a>&lt;<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.InnerJoin.html" title="type parameter in Join.InnerJoin">K</a>,<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.InnerJoin.html" title="type parameter in Join.InnerJoin">V1</a>,<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.InnerJoin.html" title="type parameter in Join.InnerJoin">V2</a>&gt;</span></code>
<div class="block">PTransform representing an inner join of two collections of KV elements.</div>
</td>
</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/sdk/extensions/joinlibrary/Join.LeftOuterJoin.html" title="class in org.apache.beam.sdk.extensions.joinlibrary">Join.LeftOuterJoin</a>&lt;<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.LeftOuterJoin.html" title="type parameter in Join.LeftOuterJoin">K</a>,<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.LeftOuterJoin.html" title="type parameter in Join.LeftOuterJoin">V1</a>,<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.LeftOuterJoin.html" title="type parameter in Join.LeftOuterJoin">V2</a>&gt;</span></code>
<div class="block">PTransform representing a left outer join of two collections of KV elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.RightOuterJoin.html" title="class in org.apache.beam.sdk.extensions.joinlibrary">Join.RightOuterJoin</a>&lt;<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.RightOuterJoin.html" title="type parameter in Join.RightOuterJoin">K</a>,<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.RightOuterJoin.html" title="type parameter in Join.RightOuterJoin">V1</a>,<a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.RightOuterJoin.html" title="type parameter in Join.RightOuterJoin">V2</a>&gt;</span></code>
<div class="block">PTransform representing a right outer join of two collections of KV elements.</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/sdk/extensions/joinlibrary/Join.html#Join--">Join</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;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.html#fullOuterJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V1-V2-">fullOuterJoin</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V1&nbsp;leftNullValue,
V2&nbsp;rightNullValue)</code>
<div class="block">Full Outer Join of two collections of KV elements.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.html#fullOuterJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V1-V2-">fullOuterJoin</a></span>(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V1&nbsp;leftNullValue,
V2&nbsp;rightNullValue)</code>
<div class="block">Full Outer Join of two collections of KV elements.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static &lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.html#innerJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-">innerJoin</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection)</code>
<div class="block">Inner join of two collections of KV elements.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static &lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.html#innerJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-">innerJoin</a></span>(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection)</code>
<div class="block">Inner join of two collections of KV elements.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static &lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.html#leftOuterJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V2-">leftOuterJoin</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V2&nbsp;nullValue)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static &lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.html#leftOuterJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V2-">leftOuterJoin</a></span>(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V2&nbsp;nullValue)</code>
<div class="block">Left Outer Join of two collections of KV elements.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static &lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.html#rightOuterJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V1-">rightOuterJoin</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V1&nbsp;nullValue)</code>
<div class="block">Right Outer Join of two collections of KV elements.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static &lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/joinlibrary/Join.html#rightOuterJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V1-">rightOuterJoin</a></span>(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V1&nbsp;nullValue)</code>
<div class="block">Right Outer Join of two collections of KV elements.</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="Join--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Join</h4>
<pre>public&nbsp;Join()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="innerJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>innerJoin</h4>
<pre>public static&nbsp;&lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;&nbsp;innerJoin(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection)</pre>
<div class="block">Inner join of two collections of KV elements.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Type of the key for both collections</dd>
<dd><code>V1</code> - Type of the values for the left collection.</dd>
<dd><code>V2</code> - Type of the values for the right collection.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>leftCollection</code> - Left side collection to join.</dd>
<dd><code>rightCollection</code> - Right side collection to join.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A joined collection of KV where Key is the key and value is a KV where Key is of type
V1 and Value is type V2.</dd>
</dl>
</li>
</ul>
<a name="innerJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>innerJoin</h4>
<pre>public static&nbsp;&lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;&nbsp;innerJoin(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection)</pre>
<div class="block">Inner join of two collections of KV elements.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Type of the key for both collections</dd>
<dd><code>V1</code> - Type of the values for the left collection.</dd>
<dd><code>V2</code> - Type of the values for the right collection.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the PTransform.</dd>
<dd><code>leftCollection</code> - Left side collection to join.</dd>
<dd><code>rightCollection</code> - Right side collection to join.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A joined collection of KV where Key is the key and value is a KV where Key is of type
V1 and Value is type V2.</dd>
</dl>
</li>
</ul>
<a name="leftOuterJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-java.lang.Object-">
<!-- -->
</a><a name="leftOuterJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V2-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>leftOuterJoin</h4>
<pre>public static&nbsp;&lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;&nbsp;leftOuterJoin(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V2&nbsp;nullValue)</pre>
<div class="block">Left Outer Join of two collections of KV elements.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Type of the key for both collections</dd>
<dd><code>V1</code> - Type of the values for the left collection.</dd>
<dd><code>V2</code> - Type of the values for the right collection.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the PTransform.</dd>
<dd><code>leftCollection</code> - Left side collection to join.</dd>
<dd><code>rightCollection</code> - Right side collection to join.</dd>
<dd><code>nullValue</code> - Value to use as null value when right side do not match left side.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A joined collection of KV where Key is the key and value is a KV where Key is of type
V1 and Value is type V2. Values that should be null or empty is replaced with nullValue.</dd>
</dl>
</li>
</ul>
<a name="leftOuterJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-java.lang.Object-">
<!-- -->
</a><a name="leftOuterJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V2-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>leftOuterJoin</h4>
<pre>public static&nbsp;&lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;&nbsp;leftOuterJoin(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V2&nbsp;nullValue)</pre>
</li>
</ul>
<a name="rightOuterJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-java.lang.Object-">
<!-- -->
</a><a name="rightOuterJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V1-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rightOuterJoin</h4>
<pre>public static&nbsp;&lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;&nbsp;rightOuterJoin(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V1&nbsp;nullValue)</pre>
<div class="block">Right Outer Join of two collections of KV elements.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Type of the key for both collections</dd>
<dd><code>V1</code> - Type of the values for the left collection.</dd>
<dd><code>V2</code> - Type of the values for the right collection.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the PTransform.</dd>
<dd><code>leftCollection</code> - Left side collection to join.</dd>
<dd><code>rightCollection</code> - Right side collection to join.</dd>
<dd><code>nullValue</code> - Value to use as null value when left side do not match right side.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A joined collection of KV where Key is the key and value is a KV where Key is of type
V1 and Value is type V2. Values that should be null or empty is replaced with nullValue.</dd>
</dl>
</li>
</ul>
<a name="rightOuterJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-java.lang.Object-">
<!-- -->
</a><a name="rightOuterJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V1-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rightOuterJoin</h4>
<pre>public static&nbsp;&lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;&nbsp;rightOuterJoin(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V1&nbsp;nullValue)</pre>
<div class="block">Right Outer Join of two collections of KV elements.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Type of the key for both collections</dd>
<dd><code>V1</code> - Type of the values for the left collection.</dd>
<dd><code>V2</code> - Type of the values for the right collection.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>leftCollection</code> - Left side collection to join.</dd>
<dd><code>rightCollection</code> - Right side collection to join.</dd>
<dd><code>nullValue</code> - Value to use as null value when left side do not match right side.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A joined collection of KV where Key is the key and value is a KV where Key is of type
V1 and Value is type V2. Values that should be null or empty is replaced with nullValue.</dd>
</dl>
</li>
</ul>
<a name="fullOuterJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="fullOuterJoin-java.lang.String-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V1-V2-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fullOuterJoin</h4>
<pre>public static&nbsp;&lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;&nbsp;fullOuterJoin(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V1&nbsp;leftNullValue,
V2&nbsp;rightNullValue)</pre>
<div class="block">Full Outer Join of two collections of KV elements.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Type of the key for both collections</dd>
<dd><code>V1</code> - Type of the values for the left collection.</dd>
<dd><code>V2</code> - Type of the values for the right collection.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the PTransform.</dd>
<dd><code>leftCollection</code> - Left side collection to join.</dd>
<dd><code>rightCollection</code> - Right side collection to join.</dd>
<dd><code>leftNullValue</code> - Value to use as null value when left side do not match right side.</dd>
<dd><code>rightNullValue</code> - Value to use as null value when right side do not match right side.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A joined collection of KV where Key is the key and value is a KV where Key is of type
V1 and Value is type V2. Values that should be null or empty is replaced with
leftNullValue/rightNullValue.</dd>
</dl>
</li>
</ul>
<a name="fullOuterJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="fullOuterJoin-org.apache.beam.sdk.values.PCollection-org.apache.beam.sdk.values.PCollection-V1-V2-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fullOuterJoin</h4>
<pre>public static&nbsp;&lt;K,V1,V2&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;V1,V2&gt;&gt;&gt;&nbsp;fullOuterJoin(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V1&gt;&gt;&nbsp;leftCollection,
<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a>&lt;K,V2&gt;&gt;&nbsp;rightCollection,
V1&nbsp;leftNullValue,
V2&nbsp;rightNullValue)</pre>
<div class="block">Full Outer Join of two collections of KV elements.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - Type of the key for both collections</dd>
<dd><code>V1</code> - Type of the values for the left collection.</dd>
<dd><code>V2</code> - Type of the values for the right collection.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>leftCollection</code> - Left side collection to join.</dd>
<dd><code>rightCollection</code> - Right side collection to join.</dd>
<dd><code>leftNullValue</code> - Value to use as null value when left side do not match right side.</dd>
<dd><code>rightNullValue</code> - Value to use as null value when right side do not match right side.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A joined collection of KV where Key is the key and value is a KV where Key is of type
V1 and Value is type V2. Values that should be null or empty is replaced with
leftNullValue/rightNullValue.</dd>
</dl>
</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/joinlibrary/Join.FullOuterJoin.html" title="class in org.apache.beam.sdk.extensions.joinlibrary"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/joinlibrary/Join.html" target="_top">Frames</a></li>
<li><a href="Join.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>