blob: 2190874ba9beaf186106b9f57995b9f2b3032bf7 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_181-google-v7) on Mon Jan 27 16:42:29 PST 2020 -->
<title>HadoopFormatIO.Write.PartitionedWriterBuilder (Apache Beam 2.20.0-SNAPSHOT)</title>
<meta name="date" content="2020-01-27">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HadoopFormatIO.Write.PartitionedWriterBuilder (Apache Beam 2.20.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.ExternalSynchronizationBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" target="_top">Frames</a></li>
<li><a href="HadoopFormatIO.Write.PartitionedWriterBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.PartitionedWriterBuilder" class="title">Interface HadoopFormatIO.Write.PartitionedWriterBuilder&lt;KeyT,ValueT&gt;</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>&lt;<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>&gt;</dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">HadoopFormatIO.Write.PartitionedWriterBuilder&lt;KeyT,ValueT&gt;</span></pre>
<div class="block">Builder for partitioning determining.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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.ExternalSynchronizationBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format">HadoopFormatIO.Write.ExternalSynchronizationBuilder</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="type parameter in HadoopFormatIO.Write.PartitionedWriterBuilder">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="type parameter in HadoopFormatIO.Write.PartitionedWriterBuilder">ValueT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html#withoutPartitioning--">withoutPartitioning</a></span>()</code>
<div class="block">Writes to the sink without need to partition output into specified number of partitions.</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>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="type parameter in HadoopFormatIO.Write.PartitionedWriterBuilder">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="type parameter in HadoopFormatIO.Write.PartitionedWriterBuilder">ValueT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html#withPartitioning--">withPartitioning</a></span>()</code>
<div class="block">Writes to the sink with partitioning by Task Id.</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="withPartitioning--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPartitioning</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>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="type parameter in HadoopFormatIO.Write.PartitionedWriterBuilder">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="type parameter in HadoopFormatIO.Write.PartitionedWriterBuilder">ValueT</a>&gt;&nbsp;withPartitioning()</pre>
<div class="block">Writes to the sink with partitioning by Task Id.
<p>Following Hadoop configuration properties are required with this option:
<ul>
<li><code>mapreduce.job.reduces</code>: Number of reduce tasks. Value is equal to number of
write tasks which will be generated.
<li><code>mapreduce.job.partitioner.class</code>: Hadoop partitioner class which will be used
for distributing of records among partitions.
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>WriteBuilder for write transformation</dd>
</dl>
</li>
</ul>
<a name="withoutPartitioning--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>withoutPartitioning</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>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="type parameter in HadoopFormatIO.Write.PartitionedWriterBuilder">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" title="type parameter in HadoopFormatIO.Write.PartitionedWriterBuilder">ValueT</a>&gt;&nbsp;withoutPartitioning()</pre>
<div class="block">Writes to the sink without need to partition output into specified number of partitions.
<p>This write operation doesn't do shuffle by the partition so it saves transfer time
before write operation itself. As a consequence it generates random number of partitions.
<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="returnLabel">Returns:</span></dt>
<dd>WriteBuilder for write transformation</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.ExternalSynchronizationBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.WriteBuilder.html" title="interface in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Write.PartitionedWriterBuilder.html" target="_top">Frames</a></li>
<li><a href="HadoopFormatIO.Write.PartitionedWriterBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>