| <!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>TextIO.TypedWrite (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="TextIO.TypedWrite (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":10,"i5":10,"i6":42,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":42,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/TextIO.Sink.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/io/TextIO.Write.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/io/TextIO.TypedWrite.html" target="_top">Frames</a></li> |
| <li><a href="TextIO.TypedWrite.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><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </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</div> |
| <h2 title="Class TextIO.TypedWrite" class="title">Class TextIO.TypedWrite<UserT,DestinationT></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><UserT>,<a href="../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a><DestinationT>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.TextIO.TypedWrite<UserT,DestinationT></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/io/TextIO.html" title="class in org.apache.beam.sdk.io">TextIO</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract static class <span class="typeNameLabel">TextIO.TypedWrite<UserT,DestinationT></span> |
| extends <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/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><UserT>,<a href="../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a><DestinationT>></pre> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#write--"><code>TextIO.write()</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.io.TextIO.TypedWrite">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> |
| <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#resourceHints">resourceHints</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </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/TextIO.TypedWrite.html#TypedWrite--">TypedWrite</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#expand-org.apache.beam.sdk.values.PCollection-">expand</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/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>> input)</code> |
| <div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given |
| <code>InputT</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.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> |
| <div class="block">Register display data for the given transform or component.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#skipIfEmpty--">skipIfEmpty</a></span>()</code> |
| <div class="block">Don't write any output files if the PCollection is empty.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><NewDestinationT><br><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,NewDestinationT></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-org.apache.beam.sdk.io.FileBasedSink.DynamicDestinations-">to</a></span>(<a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html" title="class in org.apache.beam.sdk.io">FileBasedSink.DynamicDestinations</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,NewDestinationT,java.lang.String> dynamicDestinations)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#write--"><code>FileIO.write()</code></a> or <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#writeDynamic--"><code>FileIO.writeDynamic()</code></a> with <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#sink--"><code>TextIO.sink()</code></a> |
| instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-org.apache.beam.sdk.io.FileBasedSink.FilenamePolicy-">to</a></span>(<a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io">FileBasedSink.FilenamePolicy</a> filenamePolicy)</code> |
| <div class="block">Writes to files named according to the given <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.FilenamePolicy</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-org.apache.beam.sdk.io.fs.ResourceId-">to</a></span>(<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a> filenamePrefix)</code> |
| <div class="block">Like <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-java.lang.String-"><code>to(String)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.Params</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-org.apache.beam.sdk.transforms.SerializableFunction-org.apache.beam.sdk.io.DefaultFilenamePolicy.Params-">to</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.Params</a>> destinationFunction, |
| <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.Params</a> emptyDestination)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#write--"><code>FileIO.write()</code></a> or <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#writeDynamic--"><code>FileIO.writeDynamic()</code></a> with <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#sink--"><code>TextIO.sink()</code></a> |
| instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-java.lang.String-">to</a></span>(java.lang.String filenamePrefix)</code> |
| <div class="block">Writes to text files with the given prefix.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-org.apache.beam.sdk.options.ValueProvider-">to</a></span>(<a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> outputPrefix)</code> |
| <div class="block">Like <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-java.lang.String-"><code>to(String)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#toResource-org.apache.beam.sdk.options.ValueProvider-">toResource</a></span>(<a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>> filenamePrefix)</code> |
| <div class="block">Like <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-org.apache.beam.sdk.io.fs.ResourceId-"><code>to(ResourceId)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.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">Returns a transform for writing to text files like this one but that compresses output using |
| the given <a href="../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io"><code>Compression</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withDelimiter-char:A-">withDelimiter</a></span>(char[] delimiter)</code> |
| <div class="block">Specifies the delimiter after each string written.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withFooter-java.lang.String-">withFooter</a></span>(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.String footer)</code> |
| <div class="block">Adds a footer string to each file.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withFormatFunction-org.apache.beam.sdk.transforms.SerializableFunction-">withFormatFunction</a></span>(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,java.lang.String> formatFunction)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#write--"><code>FileIO.write()</code></a> or <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#writeDynamic--"><code>FileIO.writeDynamic()</code></a> with <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#sink--"><code>TextIO.sink()</code></a> |
| instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withHeader-java.lang.String-">withHeader</a></span>(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.String header)</code> |
| <div class="block">Adds a header string to each file.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withNoSpilling--">withNoSpilling</a></span>()</code> |
| <div class="block">See <a href="../../../../../org/apache/beam/sdk/io/WriteFiles.html#withNoSpilling--"><code>WriteFiles.withNoSpilling()</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withNumShards-int-">withNumShards</a></span>(int numShards)</code> |
| <div class="block">Configures the number of output shards produced overall (when using unwindowed writes) or |
| per-window (when using windowed writes).</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withNumShards-org.apache.beam.sdk.options.ValueProvider-">withNumShards</a></span>(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.Integer> numShards)</code> |
| <div class="block">Like <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withNumShards-int-"><code>withNumShards(int)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withoutSharding--">withoutSharding</a></span>()</code> |
| <div class="block">Forces a single file as output and empty shard name template.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withShardNameTemplate-java.lang.String-">withShardNameTemplate</a></span>(java.lang.String shardTemplate)</code> |
| <div class="block">Uses the given <a href="../../../../../org/apache/beam/sdk/io/ShardNameTemplate.html" title="class in org.apache.beam.sdk.io"><code>ShardNameTemplate</code></a> for naming output files.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withSuffix-java.lang.String-">withSuffix</a></span>(java.lang.String filenameSuffix)</code> |
| <div class="block">Configures the filename suffix for written files.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withTempDirectory-org.apache.beam.sdk.io.fs.ResourceId-">withTempDirectory</a></span>(<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a> tempDirectory)</code> |
| <div class="block">Set the base directory used to generate temporary files.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withTempDirectory-org.apache.beam.sdk.options.ValueProvider-">withTempDirectory</a></span>(<a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>> tempDirectory)</code> |
| <div class="block">Set the base directory used to generate temporary files.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withWindowedWrites--">withWindowedWrites</a></span>()</code> |
| <div class="block">Preserves windowing of input elements and writes them to files based on the element's window.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withWritableByteChannelFactory-org.apache.beam.sdk.io.FileBasedSink.WritableByteChannelFactory-">withWritableByteChannelFactory</a></span>(<a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.WritableByteChannelFactory.html" title="interface in org.apache.beam.sdk.io">FileBasedSink.WritableByteChannelFactory</a> writableByteChannelFactory)</code> |
| <div class="block">Returns a transform for writing to text files like this one but that has the given <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.WritableByteChannelFactory.html" title="interface in org.apache.beam.sdk.io"><code>FileBasedSink.WritableByteChannelFactory</code></a> to be used by the <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink</code></a> during output.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> |
| <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getAdditionalInputs--">getAdditionalInputs</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.PCollection-">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getResourceHints--">getResourceHints</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#setResourceHints-org.apache.beam.sdk.transforms.resourcehints.ResourceHints-">setResourceHints</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-">validate</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-java.util.Map-java.util.Map-">validate</a></code></li> |
| </ul> |
| <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, 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="TypedWrite--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TypedWrite</h4> |
| <pre>public TypedWrite()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="to-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> to(java.lang.String filenamePrefix)</pre> |
| <div class="block">Writes to text files with the given prefix. The given <code>prefix</code> can reference any <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="class in org.apache.beam.sdk.io"><code>FileSystem</code></a> on the classpath. This prefix is used by the <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a> to |
| generate filenames. |
| |
| <p>By default, a <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a> will be used built using the specified prefix |
| to define the base output directory and file prefix, a shard identifier (see <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withNumShards-int-"><code>withNumShards(int)</code></a>), and a common suffix (if supplied using <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withSuffix-java.lang.String-"><code>withSuffix(String)</code></a>). |
| |
| <p>This default policy can be overridden using <code>#to(FilenamePolicy)</code>, in which case |
| <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withShardNameTemplate-java.lang.String-"><code>withShardNameTemplate(String)</code></a> and <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withSuffix-java.lang.String-"><code>withSuffix(String)</code></a> should not be set. |
| Custom filename policies do not automatically see this prefix - you should explicitly pass |
| the prefix into your <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.FilenamePolicy</code></a> object if you need this. |
| |
| <p>If <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withTempDirectory-org.apache.beam.sdk.options.ValueProvider-"><code>withTempDirectory(org.apache.beam.sdk.options.ValueProvider<org.apache.beam.sdk.io.fs.ResourceId>)</code></a> has not been called, this filename prefix will be used to |
| infer a directory for temporary files.</div> |
| </li> |
| </ul> |
| <a name="to-org.apache.beam.sdk.io.fs.ResourceId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#FILESYSTEM">FILESYSTEM</a>) |
| public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> to(<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a> filenamePrefix)</pre> |
| <div class="block">Like <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-java.lang.String-"><code>to(String)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="to-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> to(<a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> outputPrefix)</pre> |
| <div class="block">Like <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-java.lang.String-"><code>to(String)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="to-org.apache.beam.sdk.io.FileBasedSink.FilenamePolicy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> to(<a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io">FileBasedSink.FilenamePolicy</a> filenamePolicy)</pre> |
| <div class="block">Writes to files named according to the given <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.FilenamePolicy</code></a>. A |
| directory for temporary files must be specified using <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withTempDirectory-org.apache.beam.sdk.options.ValueProvider-"><code>withTempDirectory(org.apache.beam.sdk.options.ValueProvider<org.apache.beam.sdk.io.fs.ResourceId>)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="to-org.apache.beam.sdk.io.FileBasedSink.DynamicDestinations-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre>@Deprecated |
| public <NewDestinationT> <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,NewDestinationT> to(<a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html" title="class in org.apache.beam.sdk.io">FileBasedSink.DynamicDestinations</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,NewDestinationT,java.lang.String> dynamicDestinations)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#write--"><code>FileIO.write()</code></a> or <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#writeDynamic--"><code>FileIO.writeDynamic()</code></a> with <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#sink--"><code>TextIO.sink()</code></a> |
| instead.</span></div> |
| <div class="block">Use a <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.DynamicDestinations</code></a> object to vend <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.FilenamePolicy</code></a> objects. These |
| objects can examine the input record when creating a <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.FilenamePolicy</code></a>. A directory for |
| temporary files must be specified using <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withTempDirectory-org.apache.beam.sdk.options.ValueProvider-"><code>withTempDirectory(org.apache.beam.sdk.options.ValueProvider<org.apache.beam.sdk.io.fs.ResourceId>)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="to-org.apache.beam.sdk.transforms.SerializableFunction-org.apache.beam.sdk.io.DefaultFilenamePolicy.Params-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre>@Deprecated |
| public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.Params</a>> to(<a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.Params</a>> destinationFunction, |
| <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.Params</a> emptyDestination)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#write--"><code>FileIO.write()</code></a> or <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#writeDynamic--"><code>FileIO.writeDynamic()</code></a> with <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#sink--"><code>TextIO.sink()</code></a> |
| instead.</span></div> |
| <div class="block">Write to dynamic destinations using the default filename policy. The destinationFunction maps |
| the input record to a <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy.Params</code></a> object that specifies where the |
| records should be written (base filename, file suffix, and shard template). The |
| emptyDestination parameter specified where empty files should be written for when the written |
| <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> is empty.</div> |
| </li> |
| </ul> |
| <a name="toResource-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toResource</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#FILESYSTEM">FILESYSTEM</a>) |
| public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> toResource(<a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>> filenamePrefix)</pre> |
| <div class="block">Like <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-org.apache.beam.sdk.io.fs.ResourceId-"><code>to(ResourceId)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withFormatFunction-org.apache.beam.sdk.transforms.SerializableFunction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFormatFunction</h4> |
| <pre>@Deprecated |
| public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withFormatFunction(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,java.lang.String> formatFunction)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#write--"><code>FileIO.write()</code></a> or <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#writeDynamic--"><code>FileIO.writeDynamic()</code></a> with <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#sink--"><code>TextIO.sink()</code></a> |
| instead.</span></div> |
| <div class="block">Specifies a format function to convert <code>UserT</code> to the output type. If <code>#to(DynamicDestinations)</code> is used, <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html#formatRecord-UserT-"><code>FileBasedSink.DynamicDestinations.formatRecord(Object)</code></a> must be |
| used instead.</div> |
| </li> |
| </ul> |
| <a name="withTempDirectory-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTempDirectory</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#FILESYSTEM">FILESYSTEM</a>) |
| public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withTempDirectory(<a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>> tempDirectory)</pre> |
| <div class="block">Set the base directory used to generate temporary files.</div> |
| </li> |
| </ul> |
| <a name="withTempDirectory-org.apache.beam.sdk.io.fs.ResourceId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTempDirectory</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#FILESYSTEM">FILESYSTEM</a>) |
| public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withTempDirectory(<a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a> tempDirectory)</pre> |
| <div class="block">Set the base directory used to generate temporary files.</div> |
| </li> |
| </ul> |
| <a name="withShardNameTemplate-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withShardNameTemplate</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withShardNameTemplate(java.lang.String shardTemplate)</pre> |
| <div class="block">Uses the given <a href="../../../../../org/apache/beam/sdk/io/ShardNameTemplate.html" title="class in org.apache.beam.sdk.io"><code>ShardNameTemplate</code></a> for naming output files. This option may only be |
| used when using one of the default filename-prefix to() overrides - i.e. not when using |
| either <code>#to(FilenamePolicy)</code> or <code>#to(DynamicDestinations)</code>. |
| |
| <p>See <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a> for how the prefix, shard name template, and suffix are |
| used.</div> |
| </li> |
| </ul> |
| <a name="withSuffix-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSuffix</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withSuffix(java.lang.String filenameSuffix)</pre> |
| <div class="block">Configures the filename suffix for written files. This option may only be used when using one |
| of the default filename-prefix to() overrides - i.e. not when using either <code>#to(FilenamePolicy)</code> or <code>#to(DynamicDestinations)</code>. |
| |
| <p>See <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a> for how the prefix, shard name template, and suffix are |
| used.</div> |
| </li> |
| </ul> |
| <a name="withNumShards-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withNumShards</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withNumShards(int numShards)</pre> |
| <div class="block">Configures the number of output shards produced overall (when using unwindowed writes) or |
| per-window (when using windowed writes). |
| |
| <p>For unwindowed writes, constraining the number of shards is likely to reduce the |
| performance of a pipeline. Setting this value is not recommended unless you require a |
| specific number of output files.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numShards</code> - the number of shards to use, or 0 to let the system decide.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withNumShards-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withNumShards</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withNumShards(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.Integer> numShards)</pre> |
| <div class="block">Like <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#withNumShards-int-"><code>withNumShards(int)</code></a>. Specifying <code>null</code> means runner-determined sharding.</div> |
| </li> |
| </ul> |
| <a name="withoutSharding--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withoutSharding</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withoutSharding()</pre> |
| <div class="block">Forces a single file as output and empty shard name template. |
| |
| <p>For unwindowed writes, constraining the number of shards is likely to reduce the |
| performance of a pipeline. Setting this value is not recommended unless you require a |
| specific number of output files. |
| |
| <p>This is equivalent to <code>.withNumShards(1).withShardNameTemplate("")</code></div> |
| </li> |
| </ul> |
| <a name="withDelimiter-char:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDelimiter</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withDelimiter(char[] delimiter)</pre> |
| <div class="block">Specifies the delimiter after each string written. |
| |
| <p>Defaults to '\n'.</div> |
| </li> |
| </ul> |
| <a name="withHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withHeader</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withHeader(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.String header)</pre> |
| <div class="block">Adds a header string to each file. A newline after the header is added automatically. |
| |
| <p>A <code>null</code> value will clear any previously configured header.</div> |
| </li> |
| </ul> |
| <a name="withFooter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFooter</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withFooter(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.String footer)</pre> |
| <div class="block">Adds a footer string to each file. A newline after the footer is added automatically. |
| |
| <p>A <code>null</code> value will clear any previously configured footer.</div> |
| </li> |
| </ul> |
| <a name="withWritableByteChannelFactory-org.apache.beam.sdk.io.FileBasedSink.WritableByteChannelFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWritableByteChannelFactory</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withWritableByteChannelFactory(<a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.WritableByteChannelFactory.html" title="interface in org.apache.beam.sdk.io">FileBasedSink.WritableByteChannelFactory</a> writableByteChannelFactory)</pre> |
| <div class="block">Returns a transform for writing to text files like this one but that has the given <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.WritableByteChannelFactory.html" title="interface in org.apache.beam.sdk.io"><code>FileBasedSink.WritableByteChannelFactory</code></a> to be used by the <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink</code></a> during output. The |
| default is value is <a href="../../../../../org/apache/beam/sdk/io/Compression.html#UNCOMPRESSED"><code>Compression.UNCOMPRESSED</code></a>. |
| |
| <p>A <code>null</code> value will reset the value to the default value mentioned above.</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/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</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">Returns a transform for writing to text files like this one but that compresses output using |
| the given <a href="../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io"><code>Compression</code></a>. The default value is <a href="../../../../../org/apache/beam/sdk/io/Compression.html#UNCOMPRESSED"><code>Compression.UNCOMPRESSED</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withWindowedWrites--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindowedWrites</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withWindowedWrites()</pre> |
| <div class="block">Preserves windowing of input elements and writes them to files based on the element's window. |
| |
| <p>If using <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html#to-org.apache.beam.sdk.io.FileBasedSink.FilenamePolicy-"><code>to(FileBasedSink.FilenamePolicy)</code></a>. Filenames will be generated using |
| <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html#windowedFilename-int-int-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.apache.beam.sdk.transforms.windowing.PaneInfo-org.apache.beam.sdk.io.FileBasedSink.OutputFileHints-"><code>FileBasedSink.FilenamePolicy.windowedFilename(int, int, org.apache.beam.sdk.transforms.windowing.BoundedWindow, org.apache.beam.sdk.transforms.windowing.PaneInfo, org.apache.beam.sdk.io.FileBasedSink.OutputFileHints)</code></a>. See also <a href="../../../../../org/apache/beam/sdk/io/WriteFiles.html#withWindowedWrites--"><code>WriteFiles.withWindowedWrites()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withNoSpilling--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withNoSpilling</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> withNoSpilling()</pre> |
| <div class="block">See <a href="../../../../../org/apache/beam/sdk/io/WriteFiles.html#withNoSpilling--"><code>WriteFiles.withNoSpilling()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="skipIfEmpty--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>skipIfEmpty</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>,<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> skipIfEmpty()</pre> |
| <div class="block">Don't write any output files if the PCollection is empty.</div> |
| </li> |
| </ul> |
| <a name="expand-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>expand</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>> expand(<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/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>> input)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div> |
| <div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given |
| <code>InputT</code>. |
| |
| <p>NOTE: This method should not be called directly. Instead apply the <code>PTransform</code> should |
| be applied to the <code>InputT</code> using the <code>apply</code> method. |
| |
| <p>Composite transforms, which are defined in terms of other transforms, should return the |
| output of one of the composed transforms. Non-composite transforms, which do not apply any |
| transforms internally, should return a new unbound output and register evaluators (via |
| backend-specific registration methods).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code> in class <code><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/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>>,<a href="../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>>></code></dd> |
| </dl> |
| </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> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">PTransform</a></code></span></div> |
| <div class="block">Register display data for the given transform or component. |
| |
| <p><code>populateDisplayData(DisplayData.Builder)</code> is invoked by Pipeline runners to collect |
| display data via <a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html#from-org.apache.beam.sdk.transforms.display.HasDisplayData-"><code>DisplayData.from(HasDisplayData)</code></a>. Implementations may call <code>super.populateDisplayData(builder)</code> in order to register display data in the current namespace, |
| but should otherwise use <code>subcomponent.populateDisplayData(builder)</code> to use the namespace |
| of the subcomponent. |
| |
| <p>By default, does not register any display data. Implementors may override this method to |
| provide their own display data.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code> in class <code><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/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">UserT</a>>,<a href="../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a><<a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="type parameter in TextIO.TypedWrite">DestinationT</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>builder</code> - The builder to populate with display data.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display"><code>HasDisplayData</code></a></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/io/TextIO.Sink.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/io/TextIO.Write.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/io/TextIO.TypedWrite.html" target="_top">Frames</a></li> |
| <li><a href="TextIO.TypedWrite.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><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </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> |