| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_181-google-v7) on Wed Aug 14 17:37:12 PDT 2019 --> |
| <title>HadoopFormatIO.Write.WriteBuilder (Apache Beam 2.15.0-SNAPSHOT)</title> |
| <meta name="date" content="2019-08-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HadoopFormatIO.Write.WriteBuilder (Apache Beam 2.15.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HDFSSynchronization.html" title="class in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" target="_top">Frames</a></li> |
| <li><a href="HadoopFormatIO.Write.WriteBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.io.hadoop.format</div> |
| <h2 title="Interface HadoopFormatIO.Write.WriteBuilder" class="title">Interface HadoopFormatIO.Write.WriteBuilder<KeyT,ValueT></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>KeyT</code> - Key type to write</dd> |
| <dd><code>ValueT</code> - Value type to write</dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.html" title="class in org.apache.beam.sdk.io.hadoop.format">HadoopFormatIO.Write</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.html" title="type parameter in HadoopFormatIO.Write">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.html" title="type parameter in HadoopFormatIO.Write">ValueT</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="typeNameLabel">HadoopFormatIO.Write.WriteBuilder<KeyT,ValueT></span></pre> |
| <div class="block">Main builder of Write transformation.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format">HadoopFormatIO.Write.PartitionedWriterBuilder</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">ValueT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html#withConfiguration-org.apache.hadoop.conf.Configuration-">withConfiguration</a></span>(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> config)</code> |
| <div class="block">Writes to the sink using the options provided by the given hadoop configuration.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.ExternalSynchronizationBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format">HadoopFormatIO.Write.ExternalSynchronizationBuilder</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">ValueT</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html#withConfigurationTransform-org.apache.beam.sdk.transforms.PTransform-">withConfigurationTransform</a></span>(<a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><? extends <a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">ValueT</a>>>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a>>> configTransform)</code> |
| <div class="block">Writes to the sink using configuration created by provided <code>configurationTransformation</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withConfiguration-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withConfiguration</h4> |
| <pre><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format">HadoopFormatIO.Write.PartitionedWriterBuilder</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">ValueT</a>> withConfiguration(<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> config)</pre> |
| <div class="block">Writes to the sink using the options provided by the given hadoop configuration. |
| |
| <p><b>Note:</b> Works only for <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.IsBounded.html#BOUNDED"><code>PCollection.IsBounded.BOUNDED</code></a> <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> with global |
| <a href="../../../../../../../org/apache/beam/sdk/values/WindowingStrategy.html" title="class in org.apache.beam.sdk.values"><code>WindowingStrategy</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - hadoop configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WriteBuilder with set configuration</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.NullPointerException</code> - when the configuration is null</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.html" title="class in org.apache.beam.sdk.io.hadoop.format"><code>for required hadoop {@link Configuration} properties</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withConfigurationTransform-org.apache.beam.sdk.transforms.PTransform-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>withConfigurationTransform</h4> |
| <pre><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.ExternalSynchronizationBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format">HadoopFormatIO.Write.ExternalSynchronizationBuilder</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">ValueT</a>> withConfigurationTransform(<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><? extends <a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="type parameter in HadoopFormatIO.Write.WriteBuilder">ValueT</a>>>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><<a href="https://static.javadoc.io/org.apache.hadoop/hadoop-common/2.7.3/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a>>> configTransform)</pre> |
| <div class="block">Writes to the sink using configuration created by provided <code>configurationTransformation</code>. |
| |
| <p>This type is useful especially for processing unbounded windowed data but can be used |
| also for batch processing. |
| |
| <p>Supports only <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> with <a href="../../../../../../../org/apache/beam/sdk/transforms/windowing/DefaultTrigger.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>DefaultTrigger</code></a>ing and without allowed |
| lateness</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configTransform</code> - configuration transformation interface</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WriteBuilder with set configuration transformation</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.NullPointerException</code> - when <code>configurationTransformation</code> is <code>null</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.html" title="class in org.apache.beam.sdk.io.hadoop.format"><code>for required hadoop {@link Configuration} properties</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/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HDFSSynchronization.html" title="class in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" target="_top">Frames</a></li> |
| <li><a href="HadoopFormatIO.Write.WriteBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
