Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.15.0 / . / javadoc / 2.15.0 / org / apache / beam / sdk / transforms / join / CoGbkResult.html
blob: 79aa196b7b8ff2f2e4dc26a165fd27f0fd3eac50 [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 (1.8.0_181-google-v7) on Wed Aug 14 17:37:15 PDT 2019 -->
<title>CoGbkResult (Apache Beam 2.15.0-SNAPSHOT)</title>
<meta name="date" content="2019-08-14">
<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="CoGbkResult (Apache Beam 2.15.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":9,"i11":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/transforms/join/CoGbkResult.CoGbkResultCoder.html" title="class in org.apache.beam.sdk.transforms.join"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/join/CoGbkResult.html" target="_top">Frames</a></li>
<li><a href="CoGbkResult.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.transforms.join</div>
<h2 title="Class CoGbkResult" class="title">Class CoGbkResult</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.transforms.join.CoGbkResult</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">CoGbkResult</span>
extends java.lang.Object</pre>
<div class="block">A row result of a <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGroupByKey.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGroupByKey</code></a>. This is a tuple of <code>Iterable</code>s produced for a given
key, and these can be accessed in different ways.</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/transforms/join/CoGbkResult.CoGbkResultCoder.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResult.CoGbkResultCoder</a></span></code>
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGbkResult</code></a>s.</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/transforms/join/CoGbkResult.html#CoGbkResult-org.apache.beam.sdk.transforms.join.CoGbkResultSchema-java.lang.Iterable-">CoGbkResult</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResultSchema.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResultSchema</a>&nbsp;schema,
java.lang.Iterable&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/join/RawUnionValue.html" title="class in org.apache.beam.sdk.transforms.join">RawUnionValue</a>&gt;&nbsp;taggedValues)</code>
<div class="block">A row in the <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> resulting from a <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGroupByKey.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGroupByKey</code></a> transform.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#CoGbkResult-org.apache.beam.sdk.transforms.join.CoGbkResultSchema-java.lang.Iterable-int-">CoGbkResult</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResultSchema.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResultSchema</a>&nbsp;schema,
java.lang.Iterable&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/join/RawUnionValue.html" title="class in org.apache.beam.sdk.transforms.join">RawUnionValue</a>&gt;&nbsp;taggedValues,
int&nbsp;inMemoryElementCount)</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>&lt;V&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#and-org.apache.beam.sdk.values.TupleTag-java.util.List-">and</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a>&lt;V&gt;&nbsp;tag,
java.util.List&lt;V&gt;&nbsp;data)</code>
<div class="block">Returns a new <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGbkResult</code></a> based on this, with the given tag and given data added to it.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;V&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#empty--">empty</a></span>()</code>
<div class="block">Returns an empty <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGbkResult</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>&lt;V&gt;&nbsp;java.lang.Iterable&lt;V&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getAll-java.lang.String-">getAll</a></span>(java.lang.String&nbsp;tag)</code>
<div class="block">Like <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getAll-org.apache.beam.sdk.values.TupleTag-"><code>getAll(TupleTag)</code></a> but using a String instead of a <a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values"><code>TupleTag</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>&lt;V&gt;&nbsp;java.lang.Iterable&lt;V&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getAll-org.apache.beam.sdk.values.TupleTag-">getAll</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a>&lt;V&gt;&nbsp;tag)</code>
<div class="block">Returns the values from the table represented by the given <code>TupleTag&lt;V&gt;</code> as an <code>Iterable&lt;V&gt;</code> (which may be empty if there are no results).</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>&lt;V&gt;&nbsp;V</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getOnly-java.lang.String-">getOnly</a></span>(java.lang.String&nbsp;tag)</code>
<div class="block">Like <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getOnly-org.apache.beam.sdk.values.TupleTag-"><code>getOnly(TupleTag)</code></a> but using a String instead of a TupleTag.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>&lt;V&gt;&nbsp;V</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getOnly-java.lang.String-V-">getOnly</a></span>(java.lang.String&nbsp;tag,
V&nbsp;defaultValue)</code>
<div class="block">Like <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getOnly-org.apache.beam.sdk.values.TupleTag-V-"><code>getOnly(TupleTag, Object)</code></a> but using a String instead of a TupleTag.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>&lt;V&gt;&nbsp;V</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getOnly-org.apache.beam.sdk.values.TupleTag-">getOnly</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a>&lt;V&gt;&nbsp;tag)</code>
<div class="block">If there is a singleton value for the given tag, returns it.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>&lt;V&gt;&nbsp;V</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getOnly-org.apache.beam.sdk.values.TupleTag-V-">getOnly</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a>&lt;V&gt;&nbsp;tag,
V&nbsp;defaultValue)</code>
<div class="block">If there is a singleton value for the given tag, returns it.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResultSchema.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResultSchema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getSchema--">getSchema</a></span>()</code>
<div class="block">Returns the schema used by this <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGbkResult</code></a>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#isEmpty--">isEmpty</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static &lt;V&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#of-org.apache.beam.sdk.values.TupleTag-java.util.List-">of</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a>&lt;V&gt;&nbsp;tag,
java.util.List&lt;V&gt;&nbsp;data)</code>
<div class="block">Returns a new CoGbkResult that contains just the given tag and given data.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#toString--">toString</a></span>()</code>&nbsp;</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, 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="CoGbkResult-org.apache.beam.sdk.transforms.join.CoGbkResultSchema-java.lang.Iterable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CoGbkResult</h4>
<pre>public&nbsp;CoGbkResult(<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResultSchema.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResultSchema</a>&nbsp;schema,
java.lang.Iterable&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/join/RawUnionValue.html" title="class in org.apache.beam.sdk.transforms.join">RawUnionValue</a>&gt;&nbsp;taggedValues)</pre>
<div class="block">A row in the <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> resulting from a <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGroupByKey.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGroupByKey</code></a> transform. Currently,
this row must fit into memory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - the set of tuple tags used to refer to input tables and result values</dd>
<dd><code>taggedValues</code> - the raw results from a group-by-key</dd>
</dl>
</li>
</ul>
<a name="CoGbkResult-org.apache.beam.sdk.transforms.join.CoGbkResultSchema-java.lang.Iterable-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CoGbkResult</h4>
<pre>public&nbsp;CoGbkResult(<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResultSchema.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResultSchema</a>&nbsp;schema,
java.lang.Iterable&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/join/RawUnionValue.html" title="class in org.apache.beam.sdk.transforms.join">RawUnionValue</a>&gt;&nbsp;taggedValues,
int&nbsp;inMemoryElementCount)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public&nbsp;boolean&nbsp;isEmpty()</pre>
</li>
</ul>
<a name="getSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchema</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResultSchema.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResultSchema</a>&nbsp;getSchema()</pre>
<div class="block">Returns the schema used by this <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGbkResult</code></a>.</div>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="getAll-org.apache.beam.sdk.values.TupleTag-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAll</h4>
<pre>public&nbsp;&lt;V&gt;&nbsp;java.lang.Iterable&lt;V&gt;&nbsp;getAll(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a>&lt;V&gt;&nbsp;tag)</pre>
<div class="block">Returns the values from the table represented by the given <code>TupleTag&lt;V&gt;</code> as an <code>Iterable&lt;V&gt;</code> (which may be empty if there are no results).
<p>If tag was not part of the original <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGroupByKey.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGroupByKey</code></a>, throws an
IllegalArgumentException.</div>
</li>
</ul>
<a name="getAll-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAll</h4>
<pre>public&nbsp;&lt;V&gt;&nbsp;java.lang.Iterable&lt;V&gt;&nbsp;getAll(java.lang.String&nbsp;tag)</pre>
<div class="block">Like <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getAll-org.apache.beam.sdk.values.TupleTag-"><code>getAll(TupleTag)</code></a> but using a String instead of a <a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values"><code>TupleTag</code></a>.</div>
</li>
</ul>
<a name="getOnly-org.apache.beam.sdk.values.TupleTag-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOnly</h4>
<pre>public&nbsp;&lt;V&gt;&nbsp;V&nbsp;getOnly(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a>&lt;V&gt;&nbsp;tag)</pre>
<div class="block">If there is a singleton value for the given tag, returns it. Otherwise, throws an
IllegalArgumentException.
<p>If tag was not part of the original <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGroupByKey.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGroupByKey</code></a>, throws an
IllegalArgumentException.</div>
</li>
</ul>
<a name="getOnly-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOnly</h4>
<pre>public&nbsp;&lt;V&gt;&nbsp;V&nbsp;getOnly(java.lang.String&nbsp;tag)</pre>
<div class="block">Like <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getOnly-org.apache.beam.sdk.values.TupleTag-"><code>getOnly(TupleTag)</code></a> but using a String instead of a TupleTag.</div>
</li>
</ul>
<a name="getOnly-org.apache.beam.sdk.values.TupleTag-java.lang.Object-">
<!-- -->
</a><a name="getOnly-org.apache.beam.sdk.values.TupleTag-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOnly</h4>
<pre>@Nullable
public&nbsp;&lt;V&gt;&nbsp;V&nbsp;getOnly(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a>&lt;V&gt;&nbsp;tag,
@Nullable
V&nbsp;defaultValue)</pre>
<div class="block">If there is a singleton value for the given tag, returns it. If there is no value for the given
tag, returns the defaultValue.
<p>If tag was not part of the original <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGroupByKey.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGroupByKey</code></a>, throws an
IllegalArgumentException.</div>
</li>
</ul>
<a name="getOnly-java.lang.String-java.lang.Object-">
<!-- -->
</a><a name="getOnly-java.lang.String-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOnly</h4>
<pre>@Nullable
public&nbsp;&lt;V&gt;&nbsp;V&nbsp;getOnly(java.lang.String&nbsp;tag,
@Nullable
V&nbsp;defaultValue)</pre>
<div class="block">Like <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html#getOnly-org.apache.beam.sdk.values.TupleTag-V-"><code>getOnly(TupleTag, Object)</code></a> but using a String instead of a TupleTag.</div>
</li>
</ul>
<a name="of-org.apache.beam.sdk.values.TupleTag-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;&lt;V&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResult</a>&nbsp;of(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a>&lt;V&gt;&nbsp;tag,
java.util.List&lt;V&gt;&nbsp;data)</pre>
<div class="block">Returns a new CoGbkResult that contains just the given tag and given data.</div>
</li>
</ul>
<a name="and-org.apache.beam.sdk.values.TupleTag-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>and</h4>
<pre>public&nbsp;&lt;V&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResult</a>&nbsp;and(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a>&lt;V&gt;&nbsp;tag,
java.util.List&lt;V&gt;&nbsp;data)</pre>
<div class="block">Returns a new <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGbkResult</code></a> based on this, with the given tag and given data added to it.</div>
</li>
</ul>
<a name="empty--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>empty</h4>
<pre>public static&nbsp;&lt;V&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResult</a>&nbsp;empty()</pre>
<div class="block">Returns an empty <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGbkResult</code></a>.</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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResult.CoGbkResultCoder.html" title="class in org.apache.beam.sdk.transforms.join"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/join/CoGbkResult.html" target="_top">Frames</a></li>
<li><a href="CoGbkResult.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>