| <!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_151-google-v7) on Tue Oct 02 14:37:27 PDT 2018 --> |
| <title>PCollectionList (Apache Beam 2.7.0-SNAPSHOT)</title> |
| <meta name="date" content="2018-10-02"> |
| <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="PCollectionList (Apache Beam 2.7.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":10,"i12":9,"i13":9,"i14":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><a href="../../../../../org/apache/beam/sdk/values/PCollection.IsBounded.html" title="enum in org.apache.beam.sdk.values"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/values/PCollectionList.html" target="_top">Frames</a></li> |
| <li><a href="PCollectionList.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>Nested | </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.values</div> |
| <h2 title="Class PCollectionList" class="title">Class PCollectionList<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.values.PCollectionList<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the elements of all the <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> in this list</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>, <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">PCollectionList<T></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>, <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a></pre> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList<T></code></a> is an immutable list of homogeneously typed |
| <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection<T>s</code></a>. A <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> is used, for instance, as |
| the input to <a href="../../../../../org/apache/beam/sdk/transforms/Flatten.html" title="class in org.apache.beam.sdk.transforms"><code>Flatten</code></a> or the output of <a href="../../../../../org/apache/beam/sdk/transforms/Partition.html" title="class in org.apache.beam.sdk.transforms"><code>Partition</code></a>. |
| |
| <p>PCollectionLists can be created and accessed like follows: |
| |
| <pre><code> |
| PCollection<String> pc1 = ...; |
| PCollection<String> pc2 = ...; |
| PCollection<String> pc3 = ...; |
| |
| // Create a PCollectionList with three PCollections: |
| PCollectionList<String> pcs = PCollectionList.of(pc1).and(pc2).and(pc3); |
| |
| // Create an empty PCollectionList: |
| Pipeline p = ...; |
| PCollectionList<String> pcs2 = PCollectionList.<String>empty(p); |
| |
| // Get PCollections out of a PCollectionList, by index (origin 0): |
| PCollection<String> pcX = pcs.get(1); |
| PCollection<String> pcY = pcs.get(0); |
| PCollection<String> pcZ = pcs.get(2); |
| |
| // Get a list of all PCollections in a PCollectionList: |
| List<PCollection<String>> allPcs = pcs.getAll(); |
| </code></pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><<a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="type parameter in PCollectionList">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#and-java.lang.Iterable-">and</a></span>(java.lang.Iterable<<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/PCollectionList.html" title="type parameter in PCollectionList">T</a>>> pcs)</code> |
| <div class="block">Returns a new <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> that has all the <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> of this |
| <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> plus the given <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> appended to the end, in |
| order.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><<a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="type parameter in PCollectionList">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#and-org.apache.beam.sdk.values.PCollection-">and</a></span>(<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/PCollectionList.html" title="type parameter in PCollectionList">T</a>> pc)</code> |
| <div class="block">Returns a new <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> that has all the <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> of this |
| <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> plus the given <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> appended to the end.</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/values/PCollectionList.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/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><<a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="type parameter in PCollectionList">T</a>>,OutputT> t)</code> |
| <div class="block">Like <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-"><code>apply(String, PTransform)</code></a> but defaulting to the name of the <code>PTransform</code>.</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/values/PCollectionList.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/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><<a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="type parameter in PCollectionList">T</a>>,OutputT> t)</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 <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a>, using <code>name</code> |
| to identify this specific application of the transform.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.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 <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> that is part of the given <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object other)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <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/values/PCollectionList.html#expand--">expand</a></span>()</code> |
| <div class="block">Expands this <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values"><code>PInput</code></a> into a list of its component output <a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values"><code>PValues</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#finishSpecifyingOutput-java.lang.String-org.apache.beam.sdk.values.PInput-org.apache.beam.sdk.transforms.PTransform-">finishSpecifyingOutput</a></span>(java.lang.String transformName, |
| <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a> input, |
| <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><?,?> transform)</code> |
| <div class="block">As part of applying the producing <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>, finalizes this output to make it ready |
| for being used as an input and for running.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><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/PCollectionList.html" title="type parameter in PCollectionList">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#get-int-">get</a></span>(int index)</code> |
| <div class="block">Returns the <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> at the given index (origin zero).</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<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/PCollectionList.html" title="type parameter in PCollectionList">T</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#getAll--">getAll</a></span>()</code> |
| <div class="block">Returns an immutable List of all the <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/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <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/values/PCollectionList.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="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#of-java.lang.Iterable-">of</a></span>(java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><T>> pcs)</code> |
| <div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> containing the given <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a>, in |
| order.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#of-org.apache.beam.sdk.values.PCollection-">of</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><T> pc)</code> |
| <div class="block">Returns a singleton <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> containing the given <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#size--">size</a></span>()</code> |
| <div class="block">Returns the number of <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/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a>.</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, finalize, getClass, 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 <T> <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><T> 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 <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> that is part of the given <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>. |
| |
| <p>Longer <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionLists</code></a> can be created by calling <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#and-org.apache.beam.sdk.values.PCollection-"><code>and(org.apache.beam.sdk.values.PCollection<T>)</code></a> on |
| the result.</div> |
| </li> |
| </ul> |
| <a name="of-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <T> <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><T> of(<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><T> pc)</pre> |
| <div class="block">Returns a singleton <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> containing the given <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>. |
| |
| <p>Longer <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionLists</code></a> can be created by calling <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#and-org.apache.beam.sdk.values.PCollection-"><code>and(org.apache.beam.sdk.values.PCollection<T>)</code></a> on |
| the result.</div> |
| </li> |
| </ul> |
| <a name="of-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <T> <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><T> of(java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><T>> pcs)</pre> |
| <div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> containing the given <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a>, in |
| order. |
| |
| <p>The argument list cannot be empty. |
| |
| <p>All the <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> in the resulting <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> must be |
| part of the same <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>. |
| |
| <p>Longer PCollectionLists can be created by calling <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#and-org.apache.beam.sdk.values.PCollection-"><code>and(org.apache.beam.sdk.values.PCollection<T>)</code></a> on the result.</div> |
| </li> |
| </ul> |
| <a name="and-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>and</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><<a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="type parameter in PCollectionList">T</a>> and(<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/PCollectionList.html" title="type parameter in PCollectionList">T</a>> pc)</pre> |
| <div class="block">Returns a new <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> that has all the <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> of this |
| <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> plus the given <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> appended to the end. |
| |
| <p>All the <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> in the resulting <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> must be |
| part of the same <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>.</div> |
| </li> |
| </ul> |
| <a name="and-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>and</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><<a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="type parameter in PCollectionList">T</a>> and(java.lang.Iterable<<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/PCollectionList.html" title="type parameter in PCollectionList">T</a>>> pcs)</pre> |
| <div class="block">Returns a new <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> that has all the <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> of this |
| <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> plus the given <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> appended to the end, in |
| order. |
| |
| <p>All the <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> in the resulting <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a> must be |
| part of the same <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>.</div> |
| </li> |
| </ul> |
| <a name="size--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>size</h4> |
| <pre>public int size()</pre> |
| <div class="block">Returns the number of <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/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a>.</div> |
| </li> |
| </ul> |
| <a name="get-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <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/PCollectionList.html" title="type parameter in PCollectionList">T</a>> get(int index)</pre> |
| <div class="block">Returns the <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> at the given index (origin zero).</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IndexOutOfBoundsException</code> - if the index is out of the range <code>[0..size()-1]</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAll</h4> |
| <pre>public java.util.List<<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/PCollectionList.html" title="type parameter in PCollectionList">T</a>>> getAll()</pre> |
| <div class="block">Returns an immutable List of all the <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/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</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/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><<a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="type parameter in PCollectionList">T</a>>,OutputT> t)</pre> |
| <div class="block">Like <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html#apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-"><code>apply(String, PTransform)</code></a> but defaulting to the name of the <code>PTransform</code>.</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/values/PCollectionList.html" title="class in org.apache.beam.sdk.values">PCollectionList</a><<a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="type parameter in PCollectionList">T</a>>,OutputT> t)</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 <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a>, using <code>name</code> |
| to identify this 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> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the output of the applied <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPipeline--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/values/POutput.html#getPipeline--">getPipeline</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a></code></dd> |
| </dl> |
| </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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/values/PInput.html#expand--">PInput</a></code></span></div> |
| <div class="block">Expands this <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values"><code>PInput</code></a> into a list of its component output <a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values"><code>PValues</code></a>. |
| |
| <ul> |
| <li>A <a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values"><code>PValue</code></a> expands to itself. |
| <li>A tuple or list of <a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values"><code>PValues</code></a> (such as <a href="../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values"><code>PCollectionTuple</code></a> or <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a>) expands to its component <code>PValue PValues</code>. |
| </ul> |
| |
| <p>Not intended to be invoked directly by user code.</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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/values/POutput.html#expand--">expand</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="finishSpecifyingOutput-java.lang.String-org.apache.beam.sdk.values.PInput-org.apache.beam.sdk.transforms.PTransform-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finishSpecifyingOutput</h4> |
| <pre>public void finishSpecifyingOutput(java.lang.String transformName, |
| <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a> input, |
| <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><?,?> transform)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/values/POutput.html#finishSpecifyingOutput-java.lang.String-org.apache.beam.sdk.values.PInput-org.apache.beam.sdk.transforms.PTransform-">POutput</a></code></span></div> |
| <div class="block">As part of applying the producing <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>, finalizes this output to make it ready |
| for being used as an input and for running. |
| |
| <p>This includes ensuring that all <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> have <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coders</code></a> specified or defaulted. |
| |
| <p>Automatically invoked whenever this <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values"><code>POutput</code></a> is output, after <a href="../../../../../org/apache/beam/sdk/values/POutput.html#finishSpecifyingOutput-java.lang.String-org.apache.beam.sdk.values.PInput-org.apache.beam.sdk.transforms.PTransform-"><code>POutput.finishSpecifyingOutput(String, PInput, PTransform)</code></a> has been called on each component |
| <a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values"><code>PValue</code></a> returned by <a href="../../../../../org/apache/beam/sdk/values/POutput.html#expand--"><code>POutput.expand()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/values/POutput.html#finishSpecifyingOutput-java.lang.String-org.apache.beam.sdk.values.PInput-org.apache.beam.sdk.transforms.PTransform-">finishSpecifyingOutput</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(java.lang.Object other)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <code>java.lang.Object</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/values/PCollection.IsBounded.html" title="enum in org.apache.beam.sdk.values"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/values/PCollectionList.html" target="_top">Frames</a></li> |
| <li><a href="PCollectionList.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>Nested | </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> |