| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ContextualTextIO.Read (Apache Beam 2.47.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ContextualTextIO.Read (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10}; |
| var tabs = {65535:["t0","All 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/io/contextualtextio/ContextualTextIO.html" title="class in org.apache.beam.sdk.io.contextualtextio"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.ReadFiles.html" title="class in org.apache.beam.sdk.io.contextualtextio"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" target="_top">Frames</a></li> |
| <li><a href="ContextualTextIO.Read.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.io.contextualtextio</div> |
| <h2 title="Class ContextualTextIO.Read" class="title">Class ContextualTextIO.Read</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><any></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.contextualtextio.ContextualTextIO.Read</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract static class <span class="typeNameLabel">ContextualTextIO.Read</span> |
| extends <any></pre> |
| <div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.html#read--"><code>ContextualTextIO.read()</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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/io/contextualtextio/ContextualTextIO.Read.html#Read--">Read</a></span>()</code> </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="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/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#expand-org.apache.beam.sdk.values.PBegin-">expand</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> input)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#from-java.lang.String-">from</a></span>(java.lang.String filepattern)</code> |
| <div class="block">Reads text from the file(s) with the given filename or filename pattern.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#from-org.apache.beam.sdk.options.ValueProvider-">from</a></span>(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> filepattern)</code> |
| <div class="block">Same as <code>from(filepattern)</code>, but accepting a <a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options"><code>ValueProvider</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/beam/sdk/io/FileBasedSource.html" title="class in org.apache.beam.sdk.io">FileBasedSource</a><<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#getSource--">getSource</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#withCompression-org.apache.beam.sdk.io.Compression-">withCompression</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io">Compression</a> compression)</code> |
| <div class="block">Reads from input sources using the specified compression type.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#withDelimiter-byte:A-">withDelimiter</a></span>(byte[] delimiter)</code> |
| <div class="block">Set the custom delimiter to be used in place of the default ones ('\r', '\n' or '\r\n').</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#withEmptyMatchTreatment-org.apache.beam.sdk.io.fs.EmptyMatchTreatment-">withEmptyMatchTreatment</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/fs/EmptyMatchTreatment.html" title="enum in org.apache.beam.sdk.io.fs">EmptyMatchTreatment</a> treatment)</code> |
| <div class="block">See <a href="../../../../../../org/apache/beam/sdk/io/FileIO.MatchConfiguration.html#withEmptyMatchTreatment-org.apache.beam.sdk.io.fs.EmptyMatchTreatment-"><code>FileIO.MatchConfiguration.withEmptyMatchTreatment(org.apache.beam.sdk.io.fs.EmptyMatchTreatment)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#withHasMultilineCSVRecords-java.lang.Boolean-">withHasMultilineCSVRecords</a></span>(java.lang.Boolean hasMultilineCSVRecords)</code> |
| <div class="block">When reading RFC4180 CSV files that have values that span multiple lines, set this to true.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#withHintMatchesManyFiles--">withHintMatchesManyFiles</a></span>()</code> |
| <div class="block">Hints that the filepattern specified in <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#from-java.lang.String-"><code>from(String)</code></a> matches a very large number of |
| files.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#withMatchConfiguration-org.apache.beam.sdk.io.FileIO.MatchConfiguration-">withMatchConfiguration</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/FileIO.MatchConfiguration.html" title="class in org.apache.beam.sdk.io">FileIO.MatchConfiguration</a> matchConfiguration)</code> |
| <div class="block">Sets the <a href="../../../../../../org/apache/beam/sdk/io/FileIO.MatchConfiguration.html" title="class in org.apache.beam.sdk.io"><code>FileIO.MatchConfiguration</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#withRecordNumMetadata--">withRecordNumMetadata</a></span>()</code> |
| <div class="block">Allows the user to opt into getting recordNums associated with each record.</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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Read--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Read</h4> |
| <pre>public Read()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="from-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>from</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a> from(java.lang.String filepattern)</pre> |
| <div class="block">Reads text from the file(s) with the given filename or filename pattern. |
| |
| <p>This can be a local path (if running locally), or a Google Cloud Storage filename or |
| filename pattern of the form <code>"gs://<bucket>/<filepath>"</code> (if running locally or using |
| remote execution service). |
| |
| <p>Standard <a href="http://docs.oracle.com/javase/tutorial/essential/io/find.html" >Java |
| Filesystem glob patterns</a> ("*", "?", "[..]") are supported. |
| |
| <p>If it is known that the filepattern will match a very large number of files (at least tens |
| of thousands), use <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#withHintMatchesManyFiles--"><code>withHintMatchesManyFiles()</code></a> for better performance and scalability.</div> |
| </li> |
| </ul> |
| <a name="from-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>from</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a> from(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> filepattern)</pre> |
| <div class="block">Same as <code>from(filepattern)</code>, but accepting a <a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options"><code>ValueProvider</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withMatchConfiguration-org.apache.beam.sdk.io.FileIO.MatchConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMatchConfiguration</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a> withMatchConfiguration(<a href="../../../../../../org/apache/beam/sdk/io/FileIO.MatchConfiguration.html" title="class in org.apache.beam.sdk.io">FileIO.MatchConfiguration</a> matchConfiguration)</pre> |
| <div class="block">Sets the <a href="../../../../../../org/apache/beam/sdk/io/FileIO.MatchConfiguration.html" title="class in org.apache.beam.sdk.io"><code>FileIO.MatchConfiguration</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withHasMultilineCSVRecords-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withHasMultilineCSVRecords</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a> withHasMultilineCSVRecords(java.lang.Boolean hasMultilineCSVRecords)</pre> |
| <div class="block">When reading RFC4180 CSV files that have values that span multiple lines, set this to true. |
| Note: this reduces the read performance (see: <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.html" title="class in org.apache.beam.sdk.io.contextualtextio"><code>ContextualTextIO</code></a>).</div> |
| </li> |
| </ul> |
| <a name="withCompression-org.apache.beam.sdk.io.Compression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withCompression</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a> withCompression(<a href="../../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io">Compression</a> compression)</pre> |
| <div class="block">Reads from input sources using the specified compression type. |
| |
| <p>If no compression type is specified, the default is <a href="../../../../../../org/apache/beam/sdk/io/Compression.html#AUTO"><code>Compression.AUTO</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withHintMatchesManyFiles--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withHintMatchesManyFiles</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a> withHintMatchesManyFiles()</pre> |
| <div class="block">Hints that the filepattern specified in <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html#from-java.lang.String-"><code>from(String)</code></a> matches a very large number of |
| files. |
| |
| <p>This hint may cause a runner to execute the transform differently, in a way that improves |
| performance for this case, but it may worsen performance if the filepattern matches only a |
| small number of files (e.g., in a runner that supports dynamic work rebalancing, it will |
| happen less efficiently within individual files).</div> |
| </li> |
| </ul> |
| <a name="withRecordNumMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withRecordNumMetadata</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a> withRecordNumMetadata()</pre> |
| <div class="block">Allows the user to opt into getting recordNums associated with each record. <b> This option |
| is only supported with default triggers.</b> |
| |
| <p>When set to true, it will introduce a grouping step to assemble the recordNums for each |
| record, which will increase the resources used by the pipeline. |
| |
| <p>Use this when you need metadata like fileNames and you need processed position/order |
| information.</div> |
| </li> |
| </ul> |
| <a name="withEmptyMatchTreatment-org.apache.beam.sdk.io.fs.EmptyMatchTreatment-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withEmptyMatchTreatment</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a> withEmptyMatchTreatment(<a href="../../../../../../org/apache/beam/sdk/io/fs/EmptyMatchTreatment.html" title="enum in org.apache.beam.sdk.io.fs">EmptyMatchTreatment</a> treatment)</pre> |
| <div class="block">See <a href="../../../../../../org/apache/beam/sdk/io/FileIO.MatchConfiguration.html#withEmptyMatchTreatment-org.apache.beam.sdk.io.fs.EmptyMatchTreatment-"><code>FileIO.MatchConfiguration.withEmptyMatchTreatment(org.apache.beam.sdk.io.fs.EmptyMatchTreatment)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withDelimiter-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDelimiter</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" title="class in org.apache.beam.sdk.io.contextualtextio">ContextualTextIO.Read</a> withDelimiter(byte[] delimiter)</pre> |
| <div class="block">Set the custom delimiter to be used in place of the default ones ('\r', '\n' or '\r\n').</div> |
| </li> |
| </ul> |
| <a name="expand-org.apache.beam.sdk.values.PBegin-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>expand</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/Row.html" title="class in org.apache.beam.sdk.values">Row</a>> expand(<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> input)</pre> |
| </li> |
| </ul> |
| <a name="getSource--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSource</h4> |
| <pre>protected <a href="../../../../../../org/apache/beam/sdk/io/FileBasedSource.html" title="class in org.apache.beam.sdk.io">FileBasedSource</a><<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>> getSource()</pre> |
| </li> |
| </ul> |
| <a name="populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>populateDisplayData</h4> |
| <pre>public void populateDisplayData(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.html" title="class in org.apache.beam.sdk.io.contextualtextio"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.ReadFiles.html" title="class in org.apache.beam.sdk.io.contextualtextio"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/contextualtextio/ContextualTextIO.Read.html" target="_top">Frames</a></li> |
| <li><a href="ContextualTextIO.Read.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |