| <!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 Mon Jan 27 16:42:32 PST 2020 --> |
| <title>KeyedPCollectionTuple (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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="KeyedPCollectionTuple (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":9,"i12":9}; |
| 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><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGroupByKey.html" title="class in org.apache.beam.sdk.transforms.join"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.TaggedKeyedPCollection.html" title="class in org.apache.beam.sdk.transforms.join"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" target="_top">Frames</a></li> |
| <li><a href="KeyedPCollectionTuple.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 KeyedPCollectionTuple" class="title">Class KeyedPCollectionTuple<K></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.transforms.join.KeyedPCollectionTuple<K></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>K</code> - the type of key shared by all constituent PCollections</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">KeyedPCollectionTuple<K></span> |
| extends java.lang.Object |
| implements <a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a></pre> |
| <div class="block">An immutable tuple of keyed <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> with key type K. (<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> containing values of type <code>KV<K, ?></code>)</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"> </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 </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.TaggedKeyedPCollection.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple.TaggedKeyedPCollection</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.TaggedKeyedPCollection.html" title="type parameter in KeyedPCollectionTuple.TaggedKeyedPCollection">K</a>,<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.TaggedKeyedPCollection.html" title="type parameter in KeyedPCollectionTuple.TaggedKeyedPCollection">V</a>></span></code> |
| <div class="block">A utility class to help ensure coherence of tag and input PCollection types.</div> |
| </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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><V> <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#and-java.lang.String-org.apache.beam.sdk.values.PCollection-">and</a></span>(java.lang.String tag, |
| <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>,V>> pc)</code> |
| <div class="block">A version of <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#and-java.lang.String-org.apache.beam.sdk.values.PCollection-"><code>and(String, PCollection)</code></a> that takes in a string instead of a TupleTag.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><V> <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#and-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.values.PCollection-">and</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><V> tag, |
| <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>,V>> pc)</code> |
| <div class="block">Returns a new <code>KeyedPCollectionTuple<K></code> that is the same as this, appended with the |
| given PCollection.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><OutputT extends <a href="../../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>><br>OutputT</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#apply-org.apache.beam.sdk.transforms.PTransform-">apply</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>>,OutputT> transform)</code> |
| <div class="block">Like <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-"><code>apply(String, PTransform)</code></a> but defaulting to the name provided by the <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><OutputT extends <a href="../../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>><br>OutputT</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-">apply</a></span>(java.lang.String name, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>>,OutputT> transform)</code> |
| <div class="block">Applies the given <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to this input <code>KeyedPCollectionTuple</code> and returns |
| its <code>OutputT</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <K> <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><K></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#empty-org.apache.beam.sdk.Pipeline-">empty</a></span>(<a href="../../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> pipeline)</code> |
| <div class="block">Returns an empty <code>KeyedPCollectionTuple<K></code> on the given pipeline.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,<a href="../../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#expand--">expand</a></span>()</code> |
| <div class="block">Expands the component <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a>, stripping off any tag-specific |
| information.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/KeyedPCollectionTuple.html#getCoGbkResultSchema--">getCoGbkResultSchema</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResultSchema.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGbkResultSchema</code></a> associated with this <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join"><code>KeyedPCollectionTuple</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#getKeyCoder--">getKeyCoder</a></span>()</code> |
| <div class="block">Returns the key <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for all <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> in this <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join"><code>KeyedPCollectionTuple</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.TaggedKeyedPCollection.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple.TaggedKeyedPCollection</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>,?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#getKeyedCollections--">getKeyedCollections</a></span>()</code> |
| <div class="block">Returns a list of <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.TaggedKeyedPCollection.html" title="class in org.apache.beam.sdk.transforms.join"><code>TaggedKeyedPCollections</code></a> for the <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> contained in this <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join"><code>KeyedPCollectionTuple</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#getPipeline--">getPipeline</a></span>()</code> |
| <div class="block">Returns the owning <a href="../../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> of this <a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values"><code>PInput</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#isEmpty--">isEmpty</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static <K,InputT> <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><K></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#of-java.lang.String-org.apache.beam.sdk.values.PCollection-">of</a></span>(java.lang.String tag, |
| <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>> pc)</code> |
| <div class="block">A version of <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#of-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.values.PCollection-"><code>of(TupleTag, PCollection)</code></a> that takes in a string instead of a TupleTag.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <K,InputT> <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><K></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#of-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.values.PCollection-">of</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><InputT> tag, |
| <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>> pc)</code> |
| <div class="block">Returns a new <code>KeyedPCollectionTuple<K></code> with the given tag and initial PCollection.</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 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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="empty-org.apache.beam.sdk.Pipeline-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>empty</h4> |
| <pre>public static <K> <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><K> empty(<a href="../../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> pipeline)</pre> |
| <div class="block">Returns an empty <code>KeyedPCollectionTuple<K></code> on the given pipeline.</div> |
| </li> |
| </ul> |
| <a name="of-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <K,InputT> <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><K> of(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><InputT> tag, |
| <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>> pc)</pre> |
| <div class="block">Returns a new <code>KeyedPCollectionTuple<K></code> with the given tag and initial PCollection.</div> |
| </li> |
| </ul> |
| <a name="of-java.lang.String-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <K,InputT> <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><K> of(java.lang.String tag, |
| <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>> pc)</pre> |
| <div class="block">A version of <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#of-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.values.PCollection-"><code>of(TupleTag, PCollection)</code></a> that takes in a string instead of a TupleTag. |
| |
| <p>This method is simpler for cases when a typed tuple-tag is not needed to extract a |
| PCollection, for example when using schema transforms.</div> |
| </li> |
| </ul> |
| <a name="and-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>and</h4> |
| <pre>public <V> <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>> and(<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><V> tag, |
| <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>,V>> pc)</pre> |
| <div class="block">Returns a new <code>KeyedPCollectionTuple<K></code> that is the same as this, appended with the |
| given PCollection.</div> |
| </li> |
| </ul> |
| <a name="and-java.lang.String-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>and</h4> |
| <pre>public <V> <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>> and(java.lang.String tag, |
| <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>,V>> pc)</pre> |
| <div class="block">A version of <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#and-java.lang.String-org.apache.beam.sdk.values.PCollection-"><code>and(String, PCollection)</code></a> that takes in a string instead of a TupleTag. |
| |
| <p>This method is simpler for cases when a typed tuple-tag is not needed to extract a |
| PCollection, for example when using schema transforms.</div> |
| </li> |
| </ul> |
| <a name="isEmpty--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmpty</h4> |
| <pre>public boolean isEmpty()</pre> |
| </li> |
| </ul> |
| <a name="getKeyedCollections--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyedCollections</h4> |
| <pre>public java.util.List<<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.TaggedKeyedPCollection.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple.TaggedKeyedPCollection</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>,?>> getKeyedCollections()</pre> |
| <div class="block">Returns a list of <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.TaggedKeyedPCollection.html" title="class in org.apache.beam.sdk.transforms.join"><code>TaggedKeyedPCollections</code></a> for the <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> contained in this <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join"><code>KeyedPCollectionTuple</code></a>.</div> |
| </li> |
| </ul> |
| <a name="apply-org.apache.beam.sdk.transforms.PTransform-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>apply</h4> |
| <pre>public <OutputT extends <a href="../../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>> OutputT apply(<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>>,OutputT> transform)</pre> |
| <div class="block">Like <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html#apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-"><code>apply(String, PTransform)</code></a> but defaulting to the name provided by the <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>.</div> |
| </li> |
| </ul> |
| <a name="apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>apply</h4> |
| <pre>public <OutputT extends <a href="../../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>> OutputT apply(java.lang.String name, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join">KeyedPCollectionTuple</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>>,OutputT> transform)</pre> |
| <div class="block">Applies the given <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to this input <code>KeyedPCollectionTuple</code> and returns |
| its <code>OutputT</code>. This uses <code>name</code> to identify the specific application of the |
| transform. This name is used in various places, including the monitoring UI, logging, and to |
| stably identify this application node in the job graph.</div> |
| </li> |
| </ul> |
| <a name="expand--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>expand</h4> |
| <pre>public java.util.Map<<a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,<a href="../../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a>> expand()</pre> |
| <div class="block">Expands the component <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a>, stripping off any tag-specific |
| information.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/values/PInput.html#expand--">expand</a></code> in interface <code><a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getKeyCoder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyCoder</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="type parameter in KeyedPCollectionTuple">K</a>> getKeyCoder()</pre> |
| <div class="block">Returns the key <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for all <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> in this <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join"><code>KeyedPCollectionTuple</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getCoGbkResultSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCoGbkResultSchema</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResultSchema.html" title="class in org.apache.beam.sdk.transforms.join">CoGbkResultSchema</a> getCoGbkResultSchema()</pre> |
| <div class="block">Returns the <a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGbkResultSchema.html" title="class in org.apache.beam.sdk.transforms.join"><code>CoGbkResultSchema</code></a> associated with this <a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" title="class in org.apache.beam.sdk.transforms.join"><code>KeyedPCollectionTuple</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getPipeline--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPipeline</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> getPipeline()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/beam/sdk/values/PInput.html#getPipeline--">PInput</a></code></span></div> |
| <div class="block">Returns the owning <a href="../../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> of this <a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values"><code>PInput</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/values/PInput.html#getPipeline--">getPipeline</a></code> in interface <code><a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a></code></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><a href="../../../../../../org/apache/beam/sdk/transforms/join/CoGroupByKey.html" title="class in org.apache.beam.sdk.transforms.join"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.TaggedKeyedPCollection.html" title="class in org.apache.beam.sdk.transforms.join"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/join/KeyedPCollectionTuple.html" target="_top">Frames</a></li> |
| <li><a href="KeyedPCollectionTuple.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
